KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > service > cmr > action > ParameterDefinition


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 org.alfresco.service.namespace.QName;
20
21 /**
22  * Parameter definition interface.
23  *
24  * @author Roy Wetherall
25  */
26 public interface ParameterDefinition
27 {
28     /**
29      * Get the name of the parameter.
30      * <p>
31      * This is unique and is used to identify the parameter.
32      *
33      * @return the parameter name
34      */
35     public String JavaDoc getName();
36     
37     /**
38      * Get the type of parameter
39      *
40      * @return the parameter type qname
41      */
42     public QName getType();
43     
44     /**
45      * Indicates whether the parameter is mandatory or not.
46      * <p>
47      * If a parameter is mandatory it means that the value can not be null.
48      *
49      * @return true if the parameter is mandatory, false otherwise
50      */
51     public boolean isMandatory();
52     
53     /**
54      * Get the display label of the parameter.
55      *
56      * @return the parameter display label
57      */
58     public String JavaDoc getDisplayLabel();
59     
60 }
61
Popular Tags