/*

  * Copyright 2009 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.student.r2.core.classI.atp.dto;

 import java.io.Serializable;

 import java.util.List;

 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.XmlType;

 import org.kuali.student.r2.common.dto.RelationshipInfo;

 import org.kuali.student.r2.common.infc.ModelBuilder;

 import org.kuali.student.r2.core.classI.atp.infc.AtpAtpRelation;

 @XmlAccessorType(XmlAccessType.FIELD)

 @XmlType(name = "AtpAtpRelationInfo", propOrder = {"id", "typeKey", "stateKey", "atpKey", "relatedAtpKey", "effectiveDate", "expirationDate", "metaInfo", "attributes", "_futureElements"})

 public class AtpAtpRelationInfo extends RelationshipInfo implements AtpAtpRelation, Serializable {

     private static final long serialVersionUID = 1L;

     @XmlElement

     private final String atpKey;

     @XmlElement

     private final String relatedAtpKey;

     @XmlAnyElement

     private final List<Element> _futureElements;

     private AtpAtpRelationInfo() {

         atpKey = null;

         relatedAtpKey = null;

         _futureElements = null;

     }

     /**

      * Constructs a new AtpAtpRelationInfo from another

      * AtpAtpRelation.

      *

      * @param atpr the AtpAtpRelation to copy

      */

     public AtpAtpRelationInfo(AtpAtpRelation atpr) {

         super(atpr);

         this.atpKey = atpr.getAtpKey();

         this.relatedAtpKey = atpr.getRelatedAtpKey();

         _futureElements = null;

     }

     @Override

     public String getAtpKey() {

         return atpKey;

     }

     @Override

     public String getRelatedAtpKey() {

         return relatedAtpKey;

     }

     /**

      * The builder class for this AtpAtpRelationInfo.

      */

     public static class Builder extends RelationshipInfo.Builder implements ModelBuilder<AtpAtpRelationInfo>, AtpAtpRelation {

         private String atpKey;

         private String relatedAtpKey;

         /**

          * Constructs a new builder.

          */

         public Builder() {

         }

         /**

          *  Constructs a new builder initialized from another

          *  AtpAtpRelation.

          */

         public Builder(AtpAtpRelation atprInfo) {

             super(atprInfo);

             this.atpKey = atprInfo.getAtpKey();

             this.relatedAtpKey = atprInfo.getRelatedAtpKey();

         }

         @Override

         public AtpAtpRelationInfo build() {

             return new AtpAtpRelationInfo(this);

         }

         @Override

         public String getAtpKey() {

             return atpKey;

         }

         public void setAtpKey(String atpKey) {

             this.atpKey = atpKey;

         }

         @Override

         public String getRelatedAtpKey() {

             return relatedAtpKey;

         }

         public void setRelatedAtpKey(String relatedAtpKey) {

             this.relatedAtpKey = relatedAtpKey;

         }

     }

 }