/*

  * Copyright 2011 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 1.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/ecl1.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.kim.api.common.template;

 import org.apache.commons.lang.StringUtils;

 import org.apache.commons.lang.builder.EqualsBuilder;

 import org.apache.commons.lang.builder.HashCodeBuilder;

 import org.apache.commons.lang.builder.ToStringBuilder;

 import org.kuali.rice.core.api.CoreConstants;

 import org.kuali.rice.core.api.mo.ModelBuilder;

 import org.kuali.rice.core.api.mo.ModelObjectComplete;

 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 TemplateContract}.

  *

  * <p>To construct an instance of a Template, use the {@link Template.Builder} class.<p/>

  */

 @XmlRootElement(name = Template.Constants.ROOT_ELEMENT_NAME)

 @XmlAccessorType(XmlAccessType.NONE)

 @XmlType(name = Template.Constants.TYPE_NAME, propOrder = {

                 Template.Elements.ID,

                 Template.Elements.NAMESPACE_CODE,

                 Template.Elements.NAME,

                 Template.Elements.DESCRIPTION,

                 Template.Elements.KIM_TYPE_ID,

         Template.Elements.ACTIVE,

         CoreConstants.CommonElements.VERSION_NUMBER,

         CoreConstants.CommonElements.OBJECT_ID,

         CoreConstants.CommonElements.FUTURE_ELEMENTS

 })

 public final class Template implements TemplateContract, ModelObjectComplete{

         private static final long serialVersionUID = 1L;

     @XmlElement(name = Template.Elements.ID, required = true)

     private final String id;

     @XmlElement(name = Template.Elements.NAMESPACE_CODE, required = true)

     private final String namespaceCode;

     @XmlElement(name = Template.Elements.NAME, required = true)

     private final String name;

     @XmlElement(name = Template.Elements.DESCRIPTION, required = false)

     private final String description;

     @XmlElement(name = Template.Elements.KIM_TYPE_ID, required = true)

     private final String kimTypeId;

     @XmlElement(name = Template.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;

     /**

          *  A constructor to be used only by JAXB unmarshalling.

          * 

          */

         private Template() {

                 this.id = null;

         this.namespaceCode = null;

         this.name = null;

         this.description = null;

         this.kimTypeId = null;

         this.active = false;

         this.versionNumber = Long.valueOf(1L);

         this.objectId = null;

         }

     /**

          * A constructor using the Builder.

          * 

          * @param builder

          */

         private Template(Builder builder) {

                 this.id = builder.getId();

         this.namespaceCode = builder.getNamespaceCode();

         this.name = builder.getName();

         this.description = builder.getDescription();

         this.kimTypeId = builder.getKimTypeId();

         this.active = builder.isActive();

         this.versionNumber = builder.getVersionNumber();

         this.objectId = builder.getObjectId();

         }

         /**

          * @see TemplateContract#getId()

          */

         @Override

         public String getId() {

                 return id;

         }

         /**

          * @see TemplateContract#getNamespaceCode()

          */

         @Override

         public String getNamespaceCode() {

                 return namespaceCode;

         }

         /**

          * @see TemplateContract#getName()

          */

         @Override

         public String getName() {

                 return name;

         }

         /**

          * @see TemplateContract#getDescription()

          */

         @Override

         public String getDescription() {

                 return description;

         }

         /**

          * @see TemplateContract#getKimTypeId()

          */

         @Override

         public String getKimTypeId() {

                 return kimTypeId;

         }

         /**

          * @see TemplateContract#isActive()

          */

         @Override

         public boolean isActive() {

                 return active;

         }

         /**

          * @see org.kuali.rice.core.api.mo.common.Versioned#getVersionNumber()

          */

         @Override

         public Long getVersionNumber() {

                 return versionNumber;

         }

         /**

          * @see org.kuali.rice.core.api.mo.common.GloballyUnique#getObjectId()

          */

         @Override

         public String getObjectId() {

                 return objectId;

         }

     @Override

     public int hashCode() {

         return HashCodeBuilder.reflectionHashCode(this, Constants.HASH_CODE_EQUALS_EXCLUDE);

     }

     @Override

     public boolean equals(Object obj) {

         return EqualsBuilder.reflectionEquals(obj, this, Constants.HASH_CODE_EQUALS_EXCLUDE);

     }

     @Override

     public String toString() {

         return ToStringBuilder.reflectionToString(this);

     }

     /**

      * This builder constructs a Template enforcing the constraints of the {@link TemplateContract}.

      */

     public static final class Builder implements TemplateContract, ModelBuilder, Serializable {

         private String id;

         private String namespaceCode;

         private String name;

         private String description;

         private String kimTypeId;

         private Long versionNumber = 1L;

         private String objectId;

         private boolean active;

         private Builder(String id, String namespaceCode, String name, String kimTypeId) {

             setId(id);

             setNamespaceCode(namespaceCode);

             setName(name);

             setKimTypeId(kimTypeId);

         }

         /**

          * creates a KimPermission with the required fields.

          */

         public static Builder create(String id, String namespaceCode, String name, String kimTypeId) {

             return new Builder(id, namespaceCode, name, kimTypeId);

         }

         /**

          * creates a KimPermission from an existing {@link TemplateContract}.

          */

         public static Builder create(TemplateContract contract) {

             Builder builder = new Builder(contract.getId(), contract.getNamespaceCode(), contract.getName(), contract.getKimTypeId());

             builder.setDescription(contract.getDescription());

             builder.setActive(contract.isActive());

             builder.setVersionNumber(contract.getVersionNumber());

             builder.setObjectId(contract.getObjectId());

             return builder;

         }

         @Override

         public String getId() {

             return id;

         }

         public void setId(final String id) {

                 if (StringUtils.isEmpty(id)) {

                 throw new IllegalArgumentException("id is blank");

             }

                 this.id = id;

         }

         @Override

         public String getNamespaceCode() {

             return namespaceCode;

         }

         public void setNamespaceCode(final String namespaceCode) {

                 if (StringUtils.isEmpty(namespaceCode)) {

                 throw new IllegalArgumentException("namespaceCode is blank");

             }

                 this.namespaceCode = namespaceCode;

         }

         @Override

         public String getName() {

             return name;

         }

         public void setName(final String name) {

                 if (StringUtils.isEmpty(name)) {

                 throw new IllegalArgumentException("name is blank");

             }

                 this.name = name;

         }

                 @Override

                 public String getDescription() {

                         return description;

                 }

                 public void setDescription(final String description) {

                         this.description = description;

                 }

                 @Override

                 public String getKimTypeId() {

                         if (StringUtils.isEmpty(kimTypeId)) {

                 throw new IllegalArgumentException("kimTypeId is blank");

             }

                         return kimTypeId;

                 }

                 public void setKimTypeId(final String kimTypeId) {

                         this.kimTypeId = kimTypeId;

                 }

                 @Override

                 public boolean isActive() {

                         return active;

                 }

                 public void setActive(final boolean active) {

             this.active = active;

         }

                 @Override

                 public Long getVersionNumber() {

                         return versionNumber;

                 }

                 public void setVersionNumber(final Long versionNumber) {

                         if (versionNumber == null || versionNumber <= 0) {

                     throw new IllegalArgumentException("versionNumber is invalid");

                 }

                         this.versionNumber = versionNumber;

             }

                 @Override

                 public String getObjectId() {

                         return objectId;

                 }

         public void setObjectId(final String objectId) {

             this.objectId = objectId;

         }

         @Override

         public Template build() {

             return new Template(this);

         }

     }

     /**

      * Defines some internal constants used on this class.

      */

     static class Constants {

         static final String ROOT_ELEMENT_NAME = "template";

         static final String TYPE_NAME = "TemplateType";

         static final String[] HASH_CODE_EQUALS_EXCLUDE = {CoreConstants.CommonElements.FUTURE_ELEMENTS};

     }

     /**

      * A private class which exposes constants which define the XML element names to use

      * when this object is marshalled to XML.

      */

     static class Elements {

         static final String ID = "id";

         static final String NAMESPACE_CODE = "namespaceCode";

         static final String NAME = "name";

         static final String DESCRIPTION = "description";

         static final String KIM_TYPE_ID = "kimTypeId";        

         static final String ACTIVE = "active";

     }

 }