주석 추가

src/main/java/cokr/xit/interfaces/saeol/SOHNN00004.java

@@ -11,6 +11,9 @@ import cokr.xit.interfaces.saeol.service.bean.XmlSupport;
 import lombok.Getter;
 import lombok.Setter;
 
+/**민원목록 조회 메시지
+ * @author xit
+ */
 public class SOHNN00004 extends SaeolMessage {
 	@Override
 	protected Req00004 newRequest() {
@@ -38,6 +41,25 @@ public class SOHNN00004 extends SaeolMessage {
 		setResponse(resp);
 	}
 
+	/**민원목록 요청
+	 * <ul><li>sid - 사용자시스템ID</li>
+	 *     <li>bbs_se - 게시판번호</li>
+	 *     <li>dep_code - 부서 코드</li>
+	 *     <li>mw_char_dep_se - 민원담당부서구분</li>
+	 *     <li>deal_state - 상태값</li>
+	 *     <li>class_sys_code - 연계시스템코드</li>
+	 *     <li>order_by_regdt - 정렬방법</li>
+	 *     <li>start_reg_ymd - 조회시작연월일</li>
+	 *     <li>end_reg_ymd - 조회종료연월일</li>
+	 *     <li>page_yn - 페이징처리여부</li>
+	 *     <li>from - 페이징시 시작페이지</li>
+	 *     <li>to - 페이징시 종료페이지</li>
+	 *     <li>link_yn - 연계민원조회유무</li>
+	 *     <li>mw_appl_cn_yn - 연계부하최소화여부</li>
+	 *     <li>mod_dt - 담당자변경일시</li>
+	 * </ul>
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Req00004 extends SaeolMessage.Request {
@@ -76,6 +98,9 @@ public class SOHNN00004 extends SaeolMessage {
 		public void validate() {}
 	}
 
+	/**민원목록 응답
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Resp00004 extends SaeolMessage.Response {
@@ -84,11 +109,40 @@ public class SOHNN00004 extends SaeolMessage {
 		/** 상태코드 */
 		private String status_code;
 
+		/**민원목록을 반환한다.
+		 * @return 민원목록
+		 */
 		public List<Item> getResult() {
 			return ifEmpty(result, Collections::emptyList);
 		}
 	}
 
+	/**민원정보
+	 * <ul><li>row_no - 순번</li>
+	 *     <li>cnsl_qna_no - 민원접수번호</li>
+	 *     <li>mw_cnsl_sj - 글제목</li>
+	 *     <li>reg_dt - 접수일자</li>
+	 *     <li>inq_num - 조회수</li>
+	 *     <li>deal_state_nm - 처리상태</li>
+	 *     <li>tot_cnt - 총건수</li>
+	 *     <li>bbs_sno - 게시물번호</li>
+	 *     <li>in_cnsl_qna_no - 내부접수번호</li>
+	 *     <li>process_state - 진행상태</li>
+	 *     <li>mw_char_dep_se - 부서구분</li>
+	 *     <li>usr_nm - 사용자명</li>
+	 *     <li>ans_answ_lmt - 민원답변기한</li>
+	 *     <li>dep_code - 부서코드</li>
+	 *     <li>cnsl_dep_nm - 부서명</li>
+	 *     <li>ans_usr_nm - 담당자명</li>
+	 *     <li>bbs_se_nm - 게시판종류</li>
+	 *     <li>take_se_nm - 접수경로</li>
+	 *     <li>file_id - 파일id</li>
+	 *     <li>file_yn - 첨부파일유무</li>
+	 *     <li>sid - 사용자시스템id</li>
+	 *     <li>qna_open_nm - 공개여부</li>
+	 * </ul>
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Item {
@@ -110,7 +164,7 @@ public class SOHNN00004 extends SaeolMessage {
 		/** 처리상태 */
 		private String deal_state_nm;
 		/** 총건수 */
-		private String tot_cnt;
+		private int tot_cnt;
 		/** 게시물번호 */
 		private String bbs_sno;
 		/** 내부접수번호 */
@@ -143,5 +197,12 @@ public class SOHNN00004 extends SaeolMessage {
 		private String qna_open_nm;
 		@JsonIgnore
 		private String detail;
+
+		/**더 가져올 민원정보가 있는지 반환한다.
+		 * @return 더 가져올 민원정보가 있는지 여부
+		 */
+		public boolean more() {
+			return row_no < tot_cnt;
+		}
 	}
 }

src/main/java/cokr/xit/interfaces/saeol/SOHNN00011.java

@@ -13,26 +13,41 @@ import cokr.xit.interfaces.saeol.service.bean.XmlSupport;
 import lombok.Getter;
 import lombok.Setter;
 
+/**민원상세 조회 메시지
+ * @author xit
+ */
 public class SOHNN00011 extends SaeolMessage {
 	public static final String INF_TYPE = "011";
 
 	private ArrayList<FileInfo> fileInfos;
 	private ArrayList<File> converted;
 
+	/**첨부파일 정보를 반환한다.
+	 * @return 첨부파일들의 FileInfo
+	 */
 	public List<FileInfo> getFileInfos() {
 		return ifEmpty(fileInfos, Collections::emptyList);
 	}
 
+	/**첨부파일 정보를 추가한다.
+	 * @param fileInfos 첨부파일 정보
+	 */
 	public void addFileInfos(List<FileInfo> fileInfos) {
 		if (this.fileInfos == null)
 			this.fileInfos = new ArrayList<>();
 		this.fileInfos.addAll(fileInfos);
 	}
 
+	/**png에서 jpg로 변환한 파일들을 반환한다.
+	 * @return jpg로 변환한 파일들
+	 */
 	public List<File> getConverted() {
 		return ifEmpty(converted, Collections::emptyList);
 	}
 
+	/**png에서 jpg로 변환한 파일들을 추가한다.
+	 * @param converted jpg로 변환한 파일들
+	 */
 	public void addConverted(List<File> converted) {
 		if (this.converted == null)
 			this.converted = new ArrayList<>();
@@ -82,6 +97,11 @@ public class SOHNN00011 extends SaeolMessage {
 		setResponse(resp);
 	}
 
+	/**민원상세 요청
+	 * <ul><li>cnsl_qna_no - 민원접수번호</li>
+	 * </ul>
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Req00011 extends SaeolMessage.Request {
@@ -92,6 +112,9 @@ public class SOHNN00011 extends SaeolMessage {
 		public void validate() {}
 	}
 
+	/**민원상세 응답
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Resp00011 extends SaeolMessage.Response {
@@ -104,14 +127,23 @@ public class SOHNN00011 extends SaeolMessage {
 		/** 상태코드 */
 		private String status_code;
 
+		/**민원인 첨부파일 목록을 반환한다.
+		 * @return 민원인 첨부파일 목록
+		 */
 		public List<FileItem> getFileinfo_m() {
 			return ifEmpty(fileinfo_m, Collections::emptyList);
 		}
 
+		/**답변자 첨부파일 목록을 반환한다.
+		 * @return 답변자 첨부파일 목록
+		 */
 		public List<FileItem> getFileinfo_p() {
 			return ifEmpty(fileinfo_p, Collections::emptyList);
 		}
 
+		/**모든 첨부파일 목록을 반환한다.
+		 * @return 모든 첨부파일 목록
+		 */
 		public List<FileItem> getAllFileinfo() {
 			ArrayList<FileItem> fileinfo = new ArrayList<>();
 			fileinfo.addAll(getFileinfo_m());
@@ -120,6 +152,79 @@ public class SOHNN00011 extends SaeolMessage {
 		}
 	}
 
+	/**민원상세 정보
+	 * <ul><li>cnsl_qna_no - 답변접수번호</li>
+	 *     <li>class_sys_code  - 시스템연계구분코드</li>
+	 *     <li>mw_cnsl_sj - 답변제목</li>
+	 *     <li>mw_appl_cn - 답변내용</li>
+	 *     <li>answ_chasu - 추가답변차수</li>
+	 *     <li>spec_item - 특기사항</li>
+	 *     <li>el_bas - 관련근거</li>
+	 *     <li>qna_open_nm - 공개여부</li>
+	 *     <li>usr_id - 답변자id</li>
+	 *     <li>usr_nm - 답변자명</li>
+	 *     <li>mwin_detail_addr - 답변자주소</li>
+	 *     <li>telno  - 답변자전화번호</li>
+	 *     <li>hpno  - 답변자핸드폰</li>
+	 *     <li>post_no - 우편번호</li>
+	 *     <li>email - 이메일</li>
+	 *     <li>ans_answ_lmt - 답변처리기한</li>
+	 *     <li>dep_code  - 답변자부서코드</li>
+	 *     <li>cnsl_dep_nm  - 답변자부서명</li>
+	 *     <li>mw_cnsl_se_code  - 민원상담구분코드</li>
+	 *     <li>remw_why  - 이송사유</li>
+	 *     <li>mw_deal_org_code - 민원처리기관코드</li>
+	 *     <li>take_se  - 접수구분코드</li>
+	 *     <li>regr_id  - 답변자id</li>
+	 *     <li>reg_dt - 답변일자</li>
+	 *     <li>mw_answ_cnt  - 추가답변카운트</li>
+	 *     <li>deal_state_nm - 처리상태</li>
+	 *     <li>mw_char_dep_se - 부서구분</li>
+	 *     <li>cnsl_qna_no_m - 민원접수번호</li>
+	 *     <li>class_sys_code_m - 시스템연계구분코드(민원)</li>
+	 *     <li>mw_cnsl_sj_m - 민원제목</li>
+	 *     <li>mw_appl_cn_m - 민원내용</li>
+	 *     <li>usr_nm_m - 민원인명</li>
+	 *     <li>mwin_detail_addr_m - 민원인주소</li>
+	 *     <li>telno_m - 민원인전화번호</li>
+	 *     <li>hpno_m - 민원인핸드폰</li>
+	 *     <li>post_no_m - 우편번호(민원)</li>
+	 *     <li>email_m - 이메일(민원)</li>
+	 *     <li>reg_dt_m - 민원등록일시</li>
+	 *     <li>take_se_nm - 접수경로</li>
+	 *     <li>file_id_m - 민원인 첨부파일 고유id</li>
+	 *     <li>file_id_p - 답변자 첨부파일 고유id</li>
+	 *     <li>mw_org_code - 최초등록기관 코드</li>
+	 *     <li>inet_qna_no - 최초등록기관 접수번호</li>
+	 *     <li>sid - 시스템사용자id</li>
+	 *     <li>private int inq_num - 민원조회수</li>
+	 *     <li>take_nm - 방문접수 담당자명</li>
+	 *     <li>cntct_telno - 방문접수 담당자 전화번호</li>
+	 *     <li>rmnt_org_code - 이송된 기관코드</li>
+	 *     <li>take_no - 신문고 접수번호</li>
+	 *     <li>appl_no - 신문고 신청번호</li>
+	 *     <li>cl_his_sno - 분류이력일련번호</li>
+	 *     <li>private int re_cl_rqst_cnt - 재분류요청건수</li>
+	 *     <li>mw_lttr_notify_yn - 서신통지여부</li>
+	 *     <li>email_rprt_yn - 이메일통지여부</li>
+	 *     <li>sms_rprt_yn - sms통지여부</li>
+	 *     <li>mw_drp_yn - 취하여부</li>
+	 *     <li>mw_drp_why - 취하사유</li>
+	 *     <li>mw_drp_dt - 취하일시</li>
+	 *     <li>delete_yn - 삭제여부</li>
+	 *     <li>bbs_se - 게시판번호</li>
+	 *     <li>bbs_sno - 게시물번호</li>
+	 *     <li>satf_ratng_cn - 만족도평가내용</li>
+	 *     <li>satf_ratng_pnt - 만족도점수</li>
+	 *     <li>civil_gist - 민원요지</li>
+	 *     <li>civil_abstract - 민원처리결과요약</li>
+	 *     <li>peti_path_gubun - 신문고민원구분</li>
+	 *     <li>pcd_gubun - 안전신고답변유형 또는 처리구분</li>
+	 *     <li>pre_cnsl_qna_no - 선행상담qna번호</li>
+	 *     <li>pre_minwon_yn - 선행민원등록여부</li>
+	 * </ul>
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Item {
@@ -263,11 +368,25 @@ public class SOHNN00011 extends SaeolMessage {
 		/** 선행민원등록여부 */
 		private String pre_minwon_yn;
 
+		/**관련정보 키(민원접수번호)를 반환한다. 파일정보 연계에 사용
+		 * @return
+		 */
 		public String infoKey() {
-			return getCnsl_qna_no(); // + "-" + getMsg_key();
+			return getCnsl_qna_no();
 		}
 	}
 
+	/**첨부파일 정보
+	 * <ul><li>cnsl_qna_no - 답변접수번호</li>
+	 *     <li>file_id_m - 민원인 첨부파일 고유id</li>
+	 *     <li>file_id_p - 답변자 첨부파일 고유id</li>
+	 *     <li>file_seq - 파일순번</li>
+	 *     <li>file_path - 파일시스템파일경로</li>
+	 *     <li>sys_file_nm - 파일시스템실제저장파일명</li>
+	 *     <li>usr_file_nm - 사용자파일명</li>
+	 * </ul>
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class FileItem {
@@ -289,6 +408,9 @@ public class SOHNN00011 extends SaeolMessage {
 
 		/**첨부파일 유형을 반환한다.
 		 * @return 첨부파일 유형
+		 * <ul><li>M - 민원인 첨부파일</li>
+		 *     <li>P - 답변자 첨부파일</li>
+		 * </ul>
 		 */
 		public String getFile_type() {
 			if (!isEmpty(file_id_m))

src/main/java/cokr/xit/interfaces/saeol/SOINN00050.java

@@ -4,6 +4,9 @@ import cokr.xit.foundation.data.XML;
 import lombok.Getter;
 import lombok.Setter;
 
+/**답변등록/추가답변 메시지
+ * @author xit
+ */
 public class SOINN00050 extends SaeolMessage {
 	private String msgId;
 
@@ -39,6 +42,29 @@ public class SOINN00050 extends SaeolMessage {
 		return xmlRequest;
 	}
 
+	/**답변등록/추가답변 요청
+	 * <ul><li>cnsl_qna_no - 답변접수번호</li>
+	 *     <li>parent_qna_no - 상위qna번호</li>
+	 *     <li>psal_vat_yn - 국민제안신청여부</li>
+	 *     <li>if_yn - 국민신문고연계여부</li>
+	 *     <li>s_userid - 담당자 id</li>
+	 *     <li>s_username - 담당자명</li>
+	 *     <li>mw_cnsl_sj - 처리구분</li>
+	 *     <li>mw_appl_cn - 답변내용</li>
+	 *     <li>telno - 전화번호</li>
+	 *     <li>email - 이메일</li>
+	 *     <li>cnsl_dep_nm - 부서명</li>
+	 *     <li>dep_code - 부서코드</li>
+	 *     <li>mw_answ_cnt - 추가답변카운터</li>
+	 *     <li>mw_char_dep_se - 민원담당부서구분</li>
+	 *     <li>mw_cnsl_se_code - 민원구분코드</li>
+	 *     <li>mw_org_code - 민원기관코드</li>
+	 *     <li>civil_gist - 민원요지</li>
+	 *     <li>civil_abstract - 민원처리결과요약</li>
+	 *     <li>pcd_gubun - 안전신고답변유형</li>
+	 * </ul>
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Req00050 extends SaeolMessage.Request {
@@ -85,6 +111,13 @@ public class SOINN00050 extends SaeolMessage {
 		public void validate() {}
 	}
 
+	/**답변등록/추가답변 응답
+	 * <ul><li>state_code - 상태코드</li>
+	 *     <li>state_msg - 상태메시지</li>
+	 *     <li>state_dtl - 처리일시</li>
+	 * </ul>
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Resp00050 extends SaeolMessage.Response {

src/main/java/cokr/xit/interfaces/saeol/SaeolMessage.java

@@ -13,6 +13,9 @@ import cokr.xit.interfaces.saeol.service.bean.Configuration;
 import lombok.Getter;
 import lombok.Setter;
 
+/**새올 연계 메시지 베이스 클래스
+ * @author xit
+ */
 public abstract class SaeolMessage extends AbstractComponent {
 	private Header header;
 	private Request request;
@@ -20,10 +23,16 @@ public abstract class SaeolMessage extends AbstractComponent {
 	protected String xmlRequest = "";
 	protected String xmlResponse = "";
 
+	/**연계 ID를 반환한다.
+	 * @return 연계 ID
+	 */
 	public String interfaceID() {
 		return getClass().getSimpleName();
 	}
 
+	/**메시지 헤더를 반환한다. 설정된 헤더가 없으면 초기화한 헤더를 생성한다.
+	 * @return 메시지 헤더
+	 */
 	public Header getHeader() {
 		if (header == null) {
 			header = new Header().setIfID(interfaceID())
@@ -34,10 +43,17 @@ public abstract class SaeolMessage extends AbstractComponent {
 		return header;
 	}
 
+	/**메시지 헤더를 설정한다.
+	 * @param header 메시지 헤더
+	 */
 	public void setHeader(Header header) {
 		this.header = header;
 	}
 
+	/**메시지 요청을 반환한다. 설정된 요청이 없으면 생성한다.
+	 * @param <T> 메시지 요청 유형
+	 * @return 메시지 요청
+	 */
 	public <T extends Request> T getRequest() {
 		if (request == null)
 			request = newRequest();
@@ -46,13 +62,24 @@ public abstract class SaeolMessage extends AbstractComponent {
 		return (T)request;
 	}
 
+	/**메시지 요청을 생성한다.
+	 * @return 메시지 요청
+	 */
 	protected abstract Request newRequest();
 
+	/**메시지 요청을 설정한다.
+	 * @param request 메시지 요청
+	 * @return 현재 SaeolMessage
+	 */
 	public SaeolMessage setRequest(Request request) {
 		this.request = request;
 		return this;
 	}
 
+	/**메시지 응답을 반환한다. 설정된 응답이 없으면 생성한다.
+	 * @param <T> 메시지 응답 유형
+	 * @return 메시지 응답
+	 */
 	public <T extends Response> T getResponse() {
 		if (response == null) {
 			try {
@@ -64,10 +91,17 @@ public abstract class SaeolMessage extends AbstractComponent {
 		return (T)response;
 	}
 
+	/**메시지 응답을 설정한다.
+	 * @param response 메시지 응답
+	 */
 	public void setResponse(Response response) {
 		this.response = response;
 	}
 
+	/**주어진 xml 문자열을 파싱하여 메시지 응답을 설정한다.
+	 * @param xml XML 파서
+	 * @param str XML 문자열
+	 */
 	public void parseResponse(XML xml, String str) {
 		Class<? extends Response> klass = responseType();
 		String className = klass.getSimpleName();
@@ -76,29 +110,35 @@ public abstract class SaeolMessage extends AbstractComponent {
 		setResponse(response);
 	}
 
-	/**xml 요청을 설정한다.
-	 * @param xmlRequest xml 요청
+	/**요청의 xml 문자열을 설정한다.
+	 * @param xmlRequest 요청의 xml 문자열
 	 */
 	public void setXmlRequest(String xmlRequest) {
 		this.xmlRequest = xmlRequest;
 	}
 
-	/**xml 응답을 설정한다.
-	 * @param xmlResponse xml 응답
+	/**응답의 xml 문자열을 설정한다.
+	 * @param xmlResponse 응답의 xml 문자열
 	 */
 	public void setXmlResponse(String xmlResponse) {
 		this.xmlResponse = xmlResponse;
 	}
 
-	/**xml 응답을 반환한다.
-	 * @return xml 응답
+	/**로그로 남길 요청 또는 응답의 xml 문자열을 반환한다.
+	 * @return xml 문자열
 	 */
 	public String getXmlLog() {
 		return xmlResponse;
 	}
 
+	/**메시지 응답 클래스를 반환한다.
+	 * @return 메시지 응답 클래스
+	 */
 	protected abstract Class<? extends Response> responseType();
 
+	/**새올 메시지 헤더
+	 * @author xit
+	 */
 	@Getter
 	public static class Header {
 		private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMddHHmmssSSS");
@@ -118,91 +158,138 @@ public abstract class SaeolMessage extends AbstractComponent {
 		/** 메시지 식별키 */
 		@JacksonXmlProperty(localName = "MSGKEY")
 		private String msgKey;
-/*
-		public boolean empty() {
-			return isEmpty(ifID)
-				|| isEmpty(srcOrgCd)
-				|| isEmpty(tgtOrgCd);
-		}
-*/
+
+		/**연계 ID를 설정한다.
+		 * @param interfaceID 연게 ID
+		 * @return 현재 Header
+		 */
 		public Header setIfID(String interfaceID) {
 			ifID = interfaceID;
 			return this;
 		}
 
+		/**요청기관 코드를 설정한다.
+		 * @param srcOrgCd 요청기관 코드
+		 * @return 요청기관 코드
+		 */
 		public Header setSrcOrgCd(String srcOrgCd) {
 			this.srcOrgCd = srcOrgCd;
 			return this;
 		}
 
+		/**응답기관 코드를 설정한다.
+		 * @param tgtOrgCd 응답기관 코드
+		 * @return 현재 Header
+		 */
 		public Header setTgtOrgCd(String tgtOrgCd) {
 			this.tgtOrgCd = tgtOrgCd;
 			return this;
 		}
 
+		/**결과 코드를 설정한다.
+		 * @param resultCode 결과 코드
+		 * @return 결과 코드
+		 */
 		public Header setResultCode(String resultCode) {
 			this.resultCode = resultCode;
 			return this;
 		}
 
+		/**메시지 식별키를 반환한다.
+		 * @return 메시지 식별키
+		 */
 		public String getMsgKey() {
 			return ifEmpty(msgKey, () -> (msgKey = dateFormat.format(new Date()) + Random.number(8)));
 		}
 
+		/**메시지 식별키를 설정한다.
+		 * @param msgKey 메시지 식별키
+		 * @return 메시지 식별키
+		 */
 		public Header setMsgKey(String msgKey) {
 			this.msgKey = msgKey;
 			return this;
 		}
 	}
 
+	/**메시지 요청 베이스 클래스
+	 * @author xit
+	 */
 	public static class Request {
 		private Header header;
 
+		/**메시지 헤더를 반환한다.
+		 * @return 메시지 헤더
+		 */
 		public Header header() {
 			return header;
 		}
 
+		/**메시지 헤더를 설정한다.
+		 * @param header 메시지 헤더
+		 */
 		public void setHeader(Header header) {
 			this.header = header;
 		}
 
+		/**유효성을 체크한다.
+		 */
 		public void validate() {}
 	}
 
+	/**메시지 응답 베이스 클래스
+	 * @author xit
+	 */
 	public static class Response {
 		private Header header;
 		private Fault fault;
 
+		/**메시지 헤더를 반환한다.
+		 * @return 메시지 헤더
+		 */
 		public Header header() {
 			return header;
 		}
 
+		/**메시지 헤더를 설정한다.
+		 * @param header 메시지 헤더
+		 */
 		public void setHeader(Header header) {
 			this.header = header;
 		}
 
+		/**오류 응답인지 반환한다.
+		 * @return 오류 응답 여부
+		 */
 		public boolean error() {
 			return fault != null;
 		}
 
-		/**fault을(를) 반환한다.
-		 * @return fault
+		/**오류 정보를 반환한다.
+		 * @return 오류 정보
 		 */
 		public Fault getFault() {
 			return fault;
 		}
 
-		/**fault을(를) 설정한다.
-		 * @param fault fault
+		/**오류 정보를 설정한다.
+		 * @param fault 오류 정보
 		 */
 		public void setFault(Fault fault) {
 			this.fault = fault;
 		}
 	}
 
+	/**오류 정보
+	 * @author xit
+	 */
 	@Getter
 	@Setter
 	public static class Fault {
+		/**주어진 xml 문자열에서 오류 정보를 찾아 반환한다.
+		 * @param str xml 문자열
+		 * @return 오류 정보
+		 */
 		public static String find(String str) {
 			int pos = str.indexOf("<env:Fault>");
 			if (pos < 0)
@@ -219,6 +306,13 @@ public abstract class SaeolMessage extends AbstractComponent {
 		private String faultcode;
 		private String faultstring;
 
+		/**오류 정보를 Map으로 반환한다. 키와 값은 다음과 같다.
+		 * @return Map으로 변환된 오류 정보
+		 * <ul><li>success: 성공 여부</li>
+		 *     <li>faultCode: 오류 코드</li>
+		 *     <li>faultstring: 오류 문자열</li>
+		 * </ul>
+		 */
 		public Map<String, Object> toMap() {
 			return Map.of(
 				"success", false,

src/main/java/cokr/xit/interfaces/saeol/service/SaeolService.java

@@ -5,9 +5,26 @@ import java.util.Map;
 
 import cokr.xit.interfaces.saeol.SOINN00050;
 
+/**새올 연계 서비스
+ * @author xit
+ */
 public interface SaeolService {
+	/**지정하는 조건의 민원목록과 민원상세를 조회하여 데이터베이스의 다음 테이블에 저장한다.
+	 * <ul><li>민원목록 - TB_SOHNN00004</li>
+	 *     <li>민원상세 - TB_SOHNN00011</li>
+	 *     <li>민원상세 첨부파일 정보 - TB_SOHNN00011_FILE</li>
+	 *     <li>민원상세 첨부파일 저장 정보- TB_FILE</li>
+	 * </ul>
+	 * @param deptCode 부서코드
+	 * @param fromDate 시작일자(yyyyMMdd)
+	 * @param toDate 종료일자(yyyyMMdd)
+	 * @return 민원접수번호별 성공 여부
+	 */
 	Map<String, Object> searchMinwons(String deptCode, String fromDate, String toDate);
 
+	/**민원목록과 민원상세 조회를 배치실행한다.
+	 * 배치실행의 조건은 설정파일(intf-conf/xit-saeol.conf)에 정의된 정보를 사용한다.
+	 */
 	void searchMinwons();
 
 	int updateSOHNN00004(String[] cnsl_qna_nos, String[] msg_keys);

src/main/sql/xit-saeol-mariadb.sql

@@ -125,10 +125,10 @@ CREATE OR REPLACE TABLE TB_SOHNN00011_FILE (
 
 CREATE OR REPLACE TABLE TB_FILE (
 	FILE_ID   VARCHAR(13)  NOT NULL COMMENT '파일 ID',
-	INF_TYPE  VARCHAR(3)   NOT NULL COMMENT '관련정보 유형',
-	INF_KEY   VARCHAR(64)  NOT NULL COMMENT '관련정보 Key',
-	SUB_TYPE  VARCHAR(3)   COMMENT '관련정보 하위 분류(애플리케이션에서 정의)',
-	SUB_CODE  VARCHAR(64)  COMMENT '관련정보 하위 코드(애플리케이션에서 정의)',
+	INF_TYPE  VARCHAR(3)   NOT NULL COMMENT '관련정보 유형(011)',
+	INF_KEY   VARCHAR(64)  NOT NULL COMMENT '관련정보 Key(민원접수번호)',
+	SUB_TYPE  VARCHAR(3)   COMMENT '관련정보 하위 분류(파일 구분: M-민원인, P-답변자)',
+	SUB_CODE  VARCHAR(64)  COMMENT '관련정보 하위 코드(첨부파일 고유 ID)',
 	FILE_NM   VARCHAR(128) NOT NULL COMMENT '파일 이름',
 	FILE_PATH VARCHAR(256) NOT NULL COMMENT '파일 경로',
 	MIME_TYPE VARCHAR(80)  COMMENT '파일 유형',