/**
    * Copyright 2005-2013 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.ken.api.notification;
  
  import java.io.Serializable;
  import java.util.Collection;
  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 org.kuali.rice.core.api.CoreConstants;
  import org.kuali.rice.core.api.mo.AbstractDataTransferObject;
  import org.kuali.rice.core.api.mo.ModelBuilder;
  import org.w3c.dom.Element;
  
  @XmlRootElement(name = NotificationPriority.Constants.ROOT_ELEMENT_NAME)
  @XmlAccessorType(XmlAccessType.NONE)
  @XmlType(name = NotificationPriority.Constants.TYPE_NAME, propOrder = {
          NotificationPriority.Elements.NAME,
          NotificationPriority.Elements.DESCRIPTION,
          NotificationPriority.Elements.ORDER,
          NotificationPriority.Elements.ID,
          CoreConstants.CommonElements.VERSION_NUMBER,
          CoreConstants.CommonElements.OBJECT_ID,
          CoreConstants.CommonElements.FUTURE_ELEMENTS
  })
  public final class NotificationPriority
          extends AbstractDataTransferObject
          implements NotificationPriorityContract
  {
  
      @XmlElement(name = Elements.NAME, required = false)
      private final String name;
      @XmlElement(name = Elements.DESCRIPTION, required = false)
      private final String description;
      @XmlElement(name = Elements.ORDER, required = false)
      private final Integer order;
      @XmlElement(name = Elements.ID, required = false)
      private final Long id;
      @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;
  
      /**
       * Private constructor used only by JAXB.
       *
       */
      private NotificationPriority() {
          this.name = null;
          this.description = null;
          this.order = null;
          this.id = null;
          this.versionNumber = null;
          this.objectId = null;
      }
  
      private NotificationPriority(Builder builder) {
          this.name = builder.getName();
          this.description = builder.getDescription();
          this.order = builder.getOrder();
          this.id = builder.getId();
          this.versionNumber = builder.getVersionNumber();
          this.objectId = builder.getObjectId();
      }
  
      @Override
      public String getName() {
          return this.name;
      }
  
      @Override
      public String getDescription() {
          return this.description;
      }
  
      @Override
      public Integer getOrder() {
          return this.order;
      }
  
     @Override
     public Long getId() {
         return this.id;
     }
 
     @Override
     public Long getVersionNumber() {
         return this.versionNumber;
     }
 
     @Override
     public String getObjectId() {
         return this.objectId;
     }
 
 
     /**
      * A builder which can be used to construct {@link NotificationPriority} instances.  Enforces the constraints of the {@link NotificationPriorityContract}.
      *
      */
     public final static class Builder
             implements Serializable, ModelBuilder, NotificationPriorityContract
     {
 
         private String name;
         private String description;
         private Integer order;
         private Long id;
         private Long versionNumber;
         private String objectId;
 
         private Builder() {
             // TODO modify this constructor as needed to pass any required values and invoke the appropriate 'setter' methods
         }
 
         public static Builder create() {
             // TODO modify as needed to pass any required values and add them to the signature of the 'create' method
             return new Builder();
         }
 
         public static Builder create(NotificationPriorityContract contract) {
             if (contract == null) {
                 throw new IllegalArgumentException("contract was null");
             }
             // TODO if create() is modified to accept required parameters, this will need to be modified
             Builder builder = create();
             builder.setName(contract.getName());
             builder.setDescription(contract.getDescription());
             builder.setOrder(contract.getOrder());
             builder.setId(contract.getId());
             builder.setVersionNumber(contract.getVersionNumber());
             builder.setObjectId(contract.getObjectId());
             return builder;
         }
 
         public NotificationPriority build() {
             return new NotificationPriority(this);
         }
 
         @Override
         public String getName() {
             return this.name;
         }
 
         @Override
         public String getDescription() {
             return this.description;
         }
 
         @Override
         public Integer getOrder() {
             return this.order;
         }
 
         @Override
         public Long getId() {
             return this.id;
         }
 
         @Override
         public Long getVersionNumber() {
             return this.versionNumber;
         }
 
         @Override
         public String getObjectId() {
             return this.objectId;
         }
 
         public void setName(String name) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.name = name;
         }
 
         public void setDescription(String description) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.description = description;
         }
 
         public void setOrder(Integer order) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.order = order;
         }
 
         public void setId(Long id) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.id = id;
         }
 
         public void setVersionNumber(Long versionNumber) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.versionNumber = versionNumber;
         }
 
         public void setObjectId(String objectId) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.objectId = objectId;
         }
 
     }
 
 
     /**
      * Defines some internal constants used on this class.
      *
      */
     static class Constants {
 
         final static String ROOT_ELEMENT_NAME = "notificationPriority";
         final static String TYPE_NAME = "NotificationPriorityType";
 
     }
 
 
     /**
      * 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 NAME = "name";
         final static String DESCRIPTION = "description";
         final static String ORDER = "order";
         final static String ID = "id";
 
     }
 
 }