View Javadoc

1   /* (c) Copyright 2003 Caleigo AB, All rights reserved. 
2    * 
3    * This library is free software; you can redistribute it and/or
4    * modify it under the terms of the GNU Lesser General Public
5    * License as published by the Free Software Foundation; either
6    * version 2.1 of the License, or (at your option) any later version.
7    * 
8    * This library is distributed in the hope that it will be useful,
9    * but WITHOUT ANY WARRANTY; without even the implied warranty of
10   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11   * Lesser General Public License for more details.
12   * 
13   * You should have received a copy of the GNU Lesser General Public
14   * License along with this library; if not, write to the Free Software
15   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16   *  
17   */
18  
19  package org.caleigo.core;
20  
21  
22  /*** <Description of IActionData>
23   *
24   * @author  Dennis Zikovic
25   * @version 1.00
26   *
27   *//*
28   *
29   * WHEN        WHO               WHY & WHAT
30   * -----------------------------------------------------------------------------
31   * 2002-09-09  Dennis Zikovic    Creation
32   */
33  public interface IDataBundle extends IDataConsumer, IDataProvider
34  {
35      // Constants ---------------------------------------------------------------
36      
37      // Methods -----------------------------------------------------------------
38      
39      /*** Access method that returns the indexed data object.
40       */
41      public Object getData(int index);
42      
43      /*** Mutation method that replaces the indexed data object with the provided
44       * object.
45       */
46      public void setData(int index, Object data);
47      
48      /*** Access method that returns the IActionDataDescriptor object that defines
49       * the called IActionDatas structure.
50       */
51      public IDataBundleDescriptor getDataBundleDescriptor();
52      
53      /*** Help method that validates the data contained in the called data
54       * object and returns a ValidationResult object. Call isValid on the 
55       * returned object to verify data validity. May never return null.
56       */
57      public ValidationResult validateData();
58      
59      // Nested classes ----------------------------------------------------------
60  }