/**
 * 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.location.api.campus;

import org.apache.commons.lang.StringUtils;
import org.kuali.rice.core.api.CoreConstants;
import org.kuali.rice.core.api.mo.AbstractDataTransferObject;
import org.kuali.rice.core.api.mo.ModelBuilder;
import org.kuali.rice.location.api.LocationConstants;
import org.w3c.dom.Element;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAnyElement;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.io.Serializable;
import java.util.Collection;

/**
 * An immutable representation of a {@link CampusTypeContract}.
 *
 * <p>To construct an instance of a CampusType, use the {@link CampusType.Builder} class.
 *
 * @see CampusTypeContract
 * @author Kuali Rice Team (rice.collab@kuali.org)
 */
@XmlRootElement(name = CampusType.Constants.ROOT_ELEMENT_NAME)
@XmlAccessorType(XmlAccessType.NONE)
@XmlType(name = CampusType.Constants.TYPE_NAME, propOrder = {
                CampusType.Elements.CODE,
                CampusType.Elements.NAME,
                CampusType.Elements.ACTIVE,
        CoreConstants.CommonElements.VERSION_NUMBER,
        CoreConstants.CommonElements.OBJECT_ID,
                CoreConstants.CommonElements.FUTURE_ELEMENTS
})
public final class CampusType extends AbstractDataTransferObject implements CampusTypeContract {
        private static final long serialVersionUID = -6325716665728047946L;

        @XmlElement(name = Elements.CODE, required=true)
        private final String code;

    @XmlElement(name = Elements.NAME, required=false)
        private final String name;

        @XmlElement(name = Elements.ACTIVE, required=false)
        private final boolean active;

    @XmlElement(name = CoreConstants.CommonElements.VERSION_NUMBER, required = false)
    private final Long versionNumber;

    @XmlElement(name = CoreConstants.CommonElements.OBJECT_ID, required = false)
        private final String objectId;
    
        @SuppressWarnings("unused")
    @XmlAnyElement
    private final Collection<Element> _futureElements = null;
        
         /** 
     * This constructor should never be called.  It is only present for use during JAXB unmarshalling. 
     */
    private CampusType() {
        this.code = null;
        this.name = null;
        this.active = false;
        this.versionNumber = null;
        this.objectId = null;
    }
    
    /**
         * Constructs a CampusType from the given builder.  This constructor is private and should only
         * ever be invoked from the builder.
         * 
         * @param builder the Builder from which to construct the campus type
         */
    private CampusType(Builder builder) {
        this.code = builder.getCode();
        this.name = builder.getName();
        this.active = builder.isActive();
        this.versionNumber = builder.getVersionNumber();
        this.objectId = builder.getObjectId();
    }
    
        /** {@inheritDoc} */
        @Override
        public String getCode() {
                return this.code;
        }

        /** {@inheritDoc} */
        @Override
        public String getName() {
                return this.name;
        }

        /** {@inheritDoc} */
        @Override
        public boolean isActive() {
                return this.active; 
        }

    /** {@inheritDoc} */
    @Override
    public Long getVersionNumber() {
        return this.versionNumber;
    }
    
    /** {@inheritDoc} */
    @Override
        public String getObjectId() {
                return objectId;
        }

        /**
     * This builder is used to construct instances of CampusType.  It enforces the constraints of the {@link CampusTypeContract}.
     */
    public static class Builder implements CampusTypeContract, ModelBuilder, Serializable {
                private static final long serialVersionUID = 1807428861457935238L;
                
                private String code;
        private String name;
        private boolean active;
        private Long versionNumber;
        private String objectId;

                /**
                 * Private constructor for creating a builder with all of it's required attributes.
                 */
        private Builder(String code) {
            setCode(code);
                        setActive(true);
        }

        /**
         * Creates a builder from the given campus type code.
         * 
         * @param code the campus type code
         * @return an instance of the builder with the code already populated
         * @throws IllegalArgumentException if the code is null or blank
         */
        public static Builder create(String code) {
            return new Builder(code);
        }

        /**
         * Creates a builder by populating it with data from the given {@link CampusTypeContract}.
         * 
         * @param contract the contract from which to populate this builder
         * @return an instance of the builder populated with data from the contract
         */
        public static Builder create(CampusTypeContract contract) {
                if (contract == null) {
                throw new IllegalArgumentException("contract is null");
            }
            Builder builder =  new Builder(contract.getCode());
            builder.setName(contract.getName());
            builder.setActive(contract.isActive());
            builder.setVersionNumber(contract.getVersionNumber());
            builder.setObjectId(contract.getObjectId());
            return builder;
        }

                /**
                 * Sets the value of the code on this builder to the given value.
                 * 
                 * @param code the code value to set, must not be null or blank
                 * @throws IllegalArgumentException if the code is null or blank
                 */
        public void setCode(String code) {
            if (StringUtils.isBlank(code)) {
                throw new IllegalArgumentException("code is blank");
            }
            this.code = code;
        }

                public void setName(String name) {
                        this.name = name;
                }

                public void setActive(boolean active) {
                        this.active = active;
                }

        public void setVersionNumber(Long versionNumber) {
            this.versionNumber = versionNumber;
        }
        
        public void setObjectId(String objectId) {
                this.objectId = objectId;
        }

                @Override
                public String getCode() {
                        return code;
                }

                @Override
                public String getName() {
                        return name;
                }

                @Override
                public boolean isActive() {
                        return active;
                }

        @Override
        public Long getVersionNumber() {
            return versionNumber;
        }
        
        @Override
        public String getObjectId() {
                return objectId;
        }

                /**
                 * Builds an instance of a CampusType based on the current state of the builder.
                 * 
                 * @return the fully-constructed CampusType
                 */
        @Override
        public CampusType build() {
            return new CampusType(this);
        }
                
    }

        /**
         * Defines some internal constants used on this class.
         */
        static class Constants {
                final static String ROOT_ELEMENT_NAME = "campusType";
                final static String TYPE_NAME = "CampusTypeType";
        }
        
        /**
         * A private class which exposes constants which define the XML element names to use
         * when this object is marshalled to XML.
         */
        static class Elements {
                final static String CODE = "code";
                final static String NAME = "name";
                final static String ACTIVE = "active";
        }

    public static class Cache {
        public static final String NAME = LocationConstants.Namespaces.LOCATION_NAMESPACE_2_0 + "/" + CampusType.Constants.TYPE_NAME;
    }
}