ParameterizedItemDefinition


1   /*
2    * Copyright (C) 2005 Alfresco, Inc.
3    *
4    * Licensed under the Mozilla Public License version 1.1 
5    * with a permitted attribution clause. You may obtain a
6    * copy of the License at
7    *
8    *   http://www.alfresco.org/legal/license.txt
9    *
10   * Unless required by applicable law or agreed to in writing,
11   * software distributed under the License is distributed on an
12   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific
14   * language governing permissions and limitations under the
15   * License.
16   */
17  package org.alfresco.service.cmr.action;
18  
19  import java.util.List  ;
20  
21  public interface ParameterizedItemDefinition 
22  {
23      /**
24       * Get the name of the rule item.
25       * <p>
26       * The name is unique and is used to identify the rule item.
27       * 
28       * @return  the name of the rule action
29       */
30      public String   getName();
31      
32      /**
33       * The title of the parameterized item definition
34       * 
35       * @return  the title
36       */
37      public String   getTitle();
38      
39      /**
40       * The description of the parameterized item definition
41       * 
42       * @return  the description
43       */
44      public String   getDescription();
45      
46      /**
47       * Indicates whether the parameterized item allows adhoc properties to be set
48       * 
49       * @return  true if ashoc properties are allowed, false otherwise
50       */
51      public boolean getAdhocPropertiesAllowed();
52      
53      /**
54       * A list containing the parmameter defintions for this rule item.
55       * 
56       * @return  a list of parameter definitions
57       */
58      public List  <ParameterDefinition> getParameterDefinitions();
59      
60      /**
61       * Get the parameter definition by name
62       * 
63       * @param name  the name of the parameter
64       * @return      the parameter definition, null if none found
65       */
66      public ParameterDefinition getParameterDefintion(String   name);
67  }
68
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags