package cokr.xit.base.code;

import java.util.Date;

import cokr.xit.foundation.Assert;

/**공통코드 정보
 * @author mjkhan
 */
public class CommonCode {
	private String
		groupID,
		code,
		value,
		description,
		etc1,
		etc2,
		etc3,
		createdBy,
		inUse;
	private int sortOrder;
	private Date createdAt;

	/**코드그룹 id를 반환한다.
	 * @return 코드그룹 id
	 */
	public String getGroupID() {
		return groupID;
	}

	/**코드그룹 id를 설정한다.
	 * @param groupID 코드그룹 id
	 */
	public void setGroupID(String groupID) {
		this.groupID = groupID;
	}
	/**코드를 반환한다.
	 * @return 코드
	 */
	public String getCode() {
		return code;
	}

	/**코드를 설정한다.
	 * @param id 코드
	 */
	public void setCode(String id) {
		this.code = id;
	}

	/**코드이름을 반환한다.
	 * @return 코드이름
	 */
	public String getValue() {
		return value;
	}

	/**코드이름을 설정한다.
	 * @param name 코드이름
	 */
	public void setValue(String name) {
		this.value = name;
	}

	/**설명을 반환한다.
	 * @return 설명
	 */
	public String getDescription() {
		return description;
	}

	/**설명을 설정한다.
	 * @param description 설명
	 */
	public void setDescription(String description) {
		this.description = description;
	}

	/**기타값 1을 반환한다.
	 * @return 기타값 1
	 */
	public String getEtc1() {
		return etc1;
	}

	/**기타값 1을 설정한다.
	 * @param etc1 기타값 1
	 */
	public void setEtc1(String etc1) {
		this.etc1 = etc1;
	}

	/**기타값 2를 반환한다.
	 * @return 기타값 2
	 */
	public String getEtc2() {
		return etc2;
	}

	/**기타값 2를 설정한다.
	 * @param etc2 기타값 2
	 */
	public void setEtc2(String etc2) {
		this.etc2 = etc2;
	}

	/**기타값 3을 반환한다.
	 * @return 기타값 3
	 */
	public String getEtc3() {
		return etc3;
	}

	/**기타값 3을 설정한다.
	 * @param etc3 기타값 3
	 */
	public void setEtc3(String etc3) {
		this.etc3 = etc3;
	}

	/**등록자 id를 반환한다.
	 * @return 등록자 id
	 */
	public String getCreatedBy() {
		return createdBy;
	}

	/**등록자 id를 설정한다.
	 * @param createdBy 등록자 id
	 */
	public void setCreatedBy(String createdBy) {
		this.createdBy = createdBy;
	}

	/**사용여부를 반환한다.
	 * @return 사용여부
	 * <ul><li>Y - 사용</li>
	 * 	   <li>N - 사용하지 않음</li>
	 * </ul>
	 */
	public String getInUse() {
		return Assert.ifEmpty(inUse, "Y");
	}

	/**사용여부를 반환한다.
	 * @return 사용여부
	 * <ul><li>true - 사용</li>
	 * 	   <li>false - 사용하지 않음</li>
	 * </ul>
	 */
	public boolean inUse() {
		return "Y".equals(getInUse());
	}

	/**사용여부를 설정한다.
	 * @param inUse 사용여부
	 * <ul><li>Y - 사용</li>
	 * 	   <li>N - 사용하지 않음</li>
	 * </ul>
	 */
	public void setInUse(String inUse) {
		this.inUse = inUse;
	}

	/**정렬순서를 반환한다.
	 * @return 정렬순서
	 */
	public int getSortOrder() {
		return sortOrder;
	}

	/**정렬순서를 설정한다.
	 * @param sortOrder 정렬순서
	 */
	public void setSortOrder(int sortOrder) {
		this.sortOrder = sortOrder;
	}

	/**등록일시를 반환한다.
	 * @return 등록일시
	 */
	public Date getCreatedAt() {
		return createdAt;
	}

	/**등록일시를 설정한다.
	 * @param createdAt 등록일시
	 */
	public void setCreatedAt(Date createdAt) {
		this.createdAt = createdAt;
	}

	@Override
	public String toString() {
		return String.format("%s('%s', '%s', '%s')", getClass().getSimpleName(), getGroupID(), getCode(), getValue());
	}
}