/*

  * Copyright 2001,2004 The Apache Software Foundation.

  * 

  * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0

  * 

  * 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.apache.commons.scaffold.util;

 import java.io.Serializable;

 import org.apache.commons.scaffold.lang.Tokens;

 /**

  * Concrete implementation of a business response 

  * [<code>org,apache.commons.util.BizResponse</code>] 

  * that can be used "as-is" to manage a response from the business tier.

  *

  * @author Ted Husted

  * @author Synthis Corporation

  * @version $Revision: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $

  */

 public class BizResponseImpl implements Serializable,BizResponse {

 // ----------------------------------------------------------- Properties

     /**

      * The attribute name for the result [null].

      */

     private String name = null;

         // See interface for JavaDoc

     public String getName() {

         return this.name;

     }

         // See interface for JavaDoc

     public void setName(String name) {

         this.name = name;

     }

     /**

      * Field to store the scope property [request].

      */

     private String scope = Tokens.REQUEST;

         // See interface for JavaDoc

     public String getScope() {

         return this.scope;

     }

         // See interface for JavaDoc

     public void setScope(String scope) {

         this.scope = scope;

     }

     /**

      * Field to store single-form state [false].

      */

     private boolean singleForm = false;

         // See interface for JavaDoc

     public boolean isSingleForm() {

         return this.singleForm;

     }

         // See interface for JavaDoc

     public void setSingleForm(boolean singleForm) {

         this.singleForm = singleForm;

     }

     /**

      * Field to store exposed property [true].

      */

     private boolean exposed = true;

         // See interface for JavaDoc

     public boolean isExposed() {

         return this.exposed;

     }

         // See interface for JavaDoc

     public void setExposed(boolean exposed) {

         this.exposed = exposed;

     }

     /**

      * Field to store the data property [null].

      */

     private Object data = null;

         // See interface for JavaDoc

     public Object getData() {

         return this.data;

     }

         // See interface for JavaDoc

     public void setData(Object data) {

         this.data = data;

     }

         // See interface for JavaDoc

     public boolean isData() {

         return (getData()!=null);

     }

     /**

      * Field to store the aggregate state  [false].

      */

     protected boolean aggregate = false;

         // See interface for JavaDoc

     public boolean isAggregate() {

         return aggregate;

     }

         // See interface for JavaDoc

     public void setAggregate(boolean aggregate) {

         this.aggregate = aggregate;

     }

     /**

      * Field to store the message property [ArrayList].

      */

     private Messages messages = new MessagesImpl();

         // See interface for JavaDoc

     public boolean isMessages() {

         Messages messages = getMessages();

         if (null==messages) return false;

         return !(messages.isEmpty());

     } // end isMessages()

         // See interface for JavaDoc

     public void addMessage(Message message, String property) {

        Messages messages = getMessages();

        messages.add(property,message);

     }

         // See interface for JavaDoc

     public void addMessage(Message message) {

        addMessage(message, Messages.GLOBAL_MESSAGE_KEY);

     }

         // See interface for JavaDoc

     public Messages getMessages() {

         return this.messages;

     }

         // See interface for JavaDoc

     public void setMessages(Messages messages) {

         this.messages = messages;

     }

     /**

      * Field to store dispatch property [null].

      */

     private String dispatch = null;

         // See interface for JavaDoc

     public String getDispatch() {

         return (this.dispatch);

     }

         // See interface for JavaDoc

     public void setDispatch(String dispatch) {

         this.dispatch = dispatch;

     }

         // See interface for JavaDoc

     public boolean isDispatch() {

         return (getDispatch()!=null);

     }

     /**

      * Field to store dispatchPath property [false].

      */

     private boolean dispatchPath = false;

         // See interface for JavaDoc

     public boolean isDispatchPath() {

         return this.dispatchPath;

     }

         // See interface for JavaDoc

     public void setDispatchPath(boolean dispatchPath) {

         this.dispatchPath = dispatchPath;

     }

     /**

      * Our scroller object for paging through lists.

      */

     protected Scroller scroller = null;

         // See interface for JavaDoc

     public void setScroller(Scroller scroller){

         this.scroller = scroller;

     }

         // See interface for JavaDoc

     public Scroller getScroller() {

         return this.scroller;

     }

 // ----------------------------------------------------------- Constructors

     /**

      * Default constructor.

      */

     public BizResponseImpl() {

         super();

     }

     /**

      * Convenience constructor to set result object.

      *

      * @param data The default data object

      */

     public BizResponseImpl(Object data) {

         super();

         setData(data);

     } // end BizResponseImpl

     /**

      * Convenience constructor to set result object

      * and singleForm status.

      *

      * @param data The default data object

      */

     public BizResponseImpl(Object data, boolean singleForm) {

         super();

         setData(data);

         setSingleForm(singleForm);

     } // end BizResponseImpl

     /**

      * Convenience constructor to set forwarding advice.

      *

      * @param dispatch  The default dispatch advice

      */

     public BizResponseImpl(String dispatch) {

         super();

         setDispatch(dispatch);

     } // end BizResponseImpl

 } // end BizResponseImpl