/**
 * Copyright 2005-2016 The Kuali Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.opensource.org/licenses/ecl2.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kuali.rice.kew.impl.type;

import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
import org.kuali.rice.kew.api.repository.type.KewTypeAttribute;
import org.kuali.rice.kew.api.repository.type.KewTypeAttributeContract;
import org.kuali.rice.krad.data.jpa.PortableSequenceGenerator;
import org.kuali.rice.krad.data.jpa.converters.BooleanYNConverter;

import javax.persistence.Column;
import javax.persistence.Convert;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.Table;
import javax.persistence.Version;

/**
 *  Kuali workflow type attribute business object.
 *
 * @author Kuali Rice Team (rice.collab@kuali.org)
 */
@Entity
@Table(name = "KREW_TYP_ATTR_T")
public class KewTypeAttributeBo implements KewTypeAttributeContract, MutableInactivatable {

    @Id
    @GeneratedValue(generator = "KREW_TYP_ATTR_S")
    @PortableSequenceGenerator(name = "KREW_TYP_ATTR_S")
    @Column(name = "TYP_ATTR_ID", nullable = false)
    private String id;

    @Column(name = "SEQ_NO", nullable = false)
    private Integer sequenceNumber;

    @Column(name = "ACTV", nullable = false)
    @Convert(converter = BooleanYNConverter.class)
    private boolean active;

    @Version
    @Column(name = "VER_NBR", nullable = false)
    private Long versionNumber;

    @ManyToOne
    @JoinColumn(name = "TYP_ID", nullable = false)
    private KewTypeBo type;

    @ManyToOne
    @JoinColumn(name = "ATTR_DEFN_ID", nullable = false)
    private KewAttributeDefinitionBo attributeDefinition;

    /**
     * Converts a mutable bo to it's immutable counterpart
     * @param bo the mutable business object
     * @return the immutable object
     */
    public static KewTypeAttribute to(KewTypeAttributeBo bo) {
        if (null == bo) {
            return null;
        } else {
            return org.kuali.rice.kew.api.repository.type.KewTypeAttribute.Builder.create(bo).build();
        }
    }

    /**
     * Converts a immutable object to it's mutable bo counterpart
     * @param im immutable object
     * @return the mutable bo
     */
    public static KewTypeAttributeBo from(KewTypeAttribute im, KewTypeBo kewType) {
        if (null == im) {
            return null;
        } else {
            KewTypeAttributeBo bo = new KewTypeAttributeBo();
            bo.setId(im.getId());
            bo.setType(kewType);
            bo.setSequenceNumber(im.getSequenceNumber());
            bo.setActive(im.isActive());
            bo.setAttributeDefinition(KewAttributeDefinitionBo.from(im.getAttributeDefinition()));
            return bo;
        }
    }

    /**
     * Default constructor
     */
    public KewTypeAttributeBo() { }

    /**
     * Returns the type attribute id.
     * @return the type attribute id
     */
    public String getId() {
        return id;
    }

    /**
     * @see #getId()
     */
    public void setId(String id) {
        this.id = id;
    }

    /**
     * Returns the sequence number.
     * @return the sequence number
     */
    public Integer getSequenceNumber() {
        return sequenceNumber;
    }

    /**
     * @see #getSequenceNumber()
     */
    public void setSequenceNumber(Integer sequenceNumber) {
        this.sequenceNumber = sequenceNumber;
    }

    /**
     * Returns the status of the KEW type attribute.
     * @return TRUE if the KEW type attribute is active, FALSE otherwise
     */
    public boolean isActive() {
        return active;
    }

    /**
     * @see #isActive()
     */
    public void setActive(boolean active) {
        this.active = active;
    }

    /**
     * Returns the version number.
     * @return the version number
     */
    public Long getVersionNumber() {
        return versionNumber;
    }

    /**
     * @see #getVersionNumber()
     */
    public void setVersionNumber(Long versionNumber) {
        this.versionNumber = versionNumber;
    }

    /**
     * Returns the {@link KewAttributeDefinitionBo}.
     * @return a {@link KewAttributeDefinitionBo}
     */
    public KewAttributeDefinitionBo getAttributeDefinition() {
        return attributeDefinition;
    }

    /**
     * @see #getAttributeDefinition()
     */
    public void setAttributeDefinition(KewAttributeDefinitionBo attributeDefinition) {
        this.attributeDefinition = attributeDefinition;
    }

    /**
     * Returns the attribute definition id from the internal attribute definition parameter.
     * @return the attribute definition id, or null if the attribute definition is not set.
     */
    public String getAttributeDefinitionId() {

        if (null != this.attributeDefinition) {
            return this.attributeDefinition.getId();
        } else {
            return null;
        }
    }

    public KewTypeBo getType() {
        return type;
    }

    public void setType(KewTypeBo type) {
        this.type = type;
    }

    public String getTypeId() {
        if (getType() == null) {
            return null;
        }
        return getType().getId();
    }
}