01: /*
02: * Copyright 2007 Outerthought bvba and Schaubroeck nv
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.outerj.daisy.workflow;
17:
18: import org.outerx.daisy.x10Workflow.VariableDefinitionDocument;
19: import org.outerj.daisy.i18n.I18nMessage;
20: import org.apache.xmlbeans.XmlObject;
21:
22: import java.util.List;
23:
24: public interface WfVariableDefinition {
25: String getName();
26:
27: WfValueType getType();
28:
29: /**
30: * Returns true if the variable is only meant for consultation/information,
31: * but cannot be updated.
32: */
33: boolean isReadOnly();
34:
35: I18nMessage getLabel();
36:
37: I18nMessage getDescription();
38:
39: boolean isRequired();
40:
41: /**
42: * A hidden variable should not be shown to the user during task interaction,
43: * but is meant to be updated programmatically.
44: */
45: boolean isHidden();
46:
47: VariableScope getScope();
48:
49: /**
50: * Returns null if no selection list.
51: */
52: List<WfListItem> getSelectionList();
53:
54: /**
55: * Gets the styling information. This can be any sort of XML, and is therefore
56: * returned as a generic XmlObject tag.
57: *
58: * Returns null if there is no styling information.
59: */
60: XmlObject getStyling();
61:
62: VariableDefinitionDocument getXml();
63: }
|