/**
    * Copyright 2005-2011 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.api.rule;
  
  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 = RuleExpression.Constants.ROOT_ELEMENT_NAME)
  @XmlAccessorType(XmlAccessType.NONE)
  @XmlType(name = RuleExpression.Constants.TYPE_NAME, propOrder = {
      RuleExpression.Elements.TYPE,
      RuleExpression.Elements.EXPRESSION,
      RuleExpression.Elements.ID,
      CoreConstants.CommonElements.VERSION_NUMBER,
      CoreConstants.CommonElements.OBJECT_ID,
      CoreConstants.CommonElements.FUTURE_ELEMENTS
  })
  public final class RuleExpression
      extends AbstractDataTransferObject
      implements RuleExpressionContract
  {
  
      @XmlElement(name = Elements.TYPE, required = false)
      private final String type;
      @XmlElement(name = Elements.EXPRESSION, required = false)
      private final String expression;
      @XmlElement(name = Elements.ID, required = false)
      private final String 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 RuleExpression() {
          this.type = null;
          this.expression = null;
          this.id = null;
          this.versionNumber = null;
          this.objectId = null;
      }
  
      private RuleExpression(Builder builder) {
          this.type = builder.getType();
          this.expression = builder.getExpression();
          this.id = builder.getId();
          this.versionNumber = builder.getVersionNumber();
          this.objectId = builder.getObjectId();
      }
  
      @Override
      public String getType() {
          return this.type;
      }
  
      @Override
      public String getExpression() {
          return this.expression;
      }
  
      @Override
      public String 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 RuleExpression} instances.  Enforces the constraints of the {@link RuleExpressionContract}.
      * 
      */
     public final static class Builder
         implements Serializable, ModelBuilder, RuleExpressionContract
     {
 
         private String type;
         private String expression;
         private String 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(RuleExpressionContract 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.setType(contract.getType());
             builder.setExpression(contract.getExpression());
             builder.setId(contract.getId());
             builder.setVersionNumber(contract.getVersionNumber());
             builder.setObjectId(contract.getObjectId());
             return builder;
         }
 
         public RuleExpression build() {
             return new RuleExpression(this);
         }
 
         @Override
         public String getType() {
             return this.type;
         }
 
         @Override
         public String getExpression() {
             return this.expression;
         }
 
         @Override
         public String getId() {
             return this.id;
         }
 
         @Override
         public Long getVersionNumber() {
             return this.versionNumber;
         }
 
         @Override
         public String getObjectId() {
             return this.objectId;
         }
 
         public void setType(String type) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.type = type;
         }
 
         public void setExpression(String expression) {
             // TODO add validation of input value if required and throw IllegalArgumentException if needed
             this.expression = expression;
         }
 
         public void setId(String 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 = "ruleExpression";
         final static String TYPE_NAME = "RuleExpressionType";
 
     }
 
 
     /**
      * 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 TYPE = "type";
         final static String EXPRESSION = "expression";
         final static String ID = "id";
 
     }
 
 }