/*

  * 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.core.api.parameter;

 import java.util.ArrayList;

 import java.util.Collection;

 import java.util.List;

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

 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.criteria.CountAwareQueryResults;

 import org.w3c.dom.Element;

 /**

  * TODO 

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  *

  */

 @XmlRootElement(name = ParameterQueryResults.Constants.ROOT_ELEMENT_NAME)

 @XmlAccessorType(XmlAccessType.NONE)

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

                 ParameterQueryResults.Elements.RESULTS,

                 ParameterQueryResults.Elements.TOTAL_ROW_COUNT,

                 ParameterQueryResults.Elements.MORE_RESULTS_AVAILALBE,

                 CoreConstants.CommonElements.FUTURE_ELEMENTS })

 public class ParameterQueryResults implements CountAwareQueryResults<Parameter> {

         @XmlElementWrapper(name = Elements.RESULTS, required = false)

         @XmlElement(name = Elements.PARAMETER, required = false)

         private final List<Parameter> results;

         @XmlElement(name = Elements.TOTAL_ROW_COUNT, required = false)

         private final Integer totalRowCount;

         @XmlElement(name = Elements.MORE_RESULTS_AVAILALBE, required = true)

         private final boolean moreResultsAvailable;

         @SuppressWarnings("unused")

     @XmlAnyElement

     private final Collection<Element> _futureElements = null;

         private ParameterQueryResults() {

                 this.results = null;

                 this.totalRowCount = null;

                 this.moreResultsAvailable = false;

         }

         private ParameterQueryResults(Builder builder) {

                 this.results = builder.getResults();

                 this.totalRowCount = builder.getTotalRowCount();

                 this.moreResultsAvailable = builder.isMoreResultsAvailable();

         }

         @Override

         public List<Parameter> getResults() {

                 return results;

         }

         @Override

         public Integer getTotalRowCount() {

                 return totalRowCount;

         }

         @Override

         public boolean isMoreResultsAvailable() {

                 return moreResultsAvailable;

         }

         public static class Builder {

                 private List<Parameter> results;

                 private Integer totalRowCount;

                 private boolean moreResultsAvailable;

                 private Builder() {

                         this.results = new ArrayList<Parameter>();

                         this.moreResultsAvailable = false;

                 }

                 public ParameterQueryResults build() {

                         return new ParameterQueryResults(this);

                 }

                 public List<Parameter> getResults() {

                         return this.results;

                 }

                 public void setResults(List<Parameter> results) {

                         this.results = results;

                 }

                 public Integer getTotalRowCount() {

                         return this.totalRowCount;

                 }

                 public void setTotalRowCount(Integer totalRowCount) {

                         this.totalRowCount = totalRowCount;

                 }

                 public boolean isMoreResultsAvailable() {

                         return this.moreResultsAvailable;

                 }

                 public void setMoreResultsAvailable(boolean moreResultsAvailable) {

                         this.moreResultsAvailable = moreResultsAvailable;

                 }

         }

         /**

          * Defines some internal constants used on this class.

          */

         public static class Constants {

                 public final static String ROOT_ELEMENT_NAME = "parameterQueryResults";

                 public final static String TYPE_NAME = "ParameterQueryResultsType";

                 public final static 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 marshaled to XML.

          */

         public static class Elements {

                 public final static String RESULTS = "results";

                 public final static String PARAMETER = "parameter";

                 public final static String TOTAL_ROW_COUNT = "totalRowCount";

                 public final static String MORE_RESULTS_AVAILALBE = "moreResultsAvailable";

         }

 }