001: /*--
002:
003: Copyright (C) 2002-2005 Adrian Price.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The names "OBE" and "Open Business Engine" must not be used to
019: endorse or promote products derived from this software without prior
020: written permission. For written permission, please contact
021: adrianprice@sourceforge.net.
022:
023: 4. Products derived from this software may not be called "OBE" or
024: "Open Business Engine", nor may "OBE" or "Open Business Engine"
025: appear in their name, without prior written permission from
026: Adrian Price (adrianprice@users.sourceforge.net).
027:
028: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038: POSSIBILITY OF SUCH DAMAGE.
039:
040: For more information on OBE, please see
041: <http://obe.sourceforge.net/>.
042:
043: */
044:
045: package org.obe.client.api.tool;
046:
047: import org.obe.xpdl.model.data.DataType;
048: import org.obe.xpdl.model.data.FormalParameter;
049: import org.obe.xpdl.model.data.ParameterMode;
050:
051: import java.io.Serializable;
052:
053: /**
054: * Holds the runtime _value of a parameter being passed to a tool or subflow.
055: *
056: * @author Adrian Price
057: * @author Anthony Eden
058: */
059: public final class Parameter implements Serializable {
060: private static final long serialVersionUID = -6542575491523924744L;
061: private final FormalParameter _formalParm;
062: private final Class _formalClass;
063: private final DataType _dataType;
064: private final String _id;
065: private final String _name;
066: private final String _description;
067: private final ParameterMode _mode;
068: private Object _value;
069:
070: public Parameter(FormalParameter formalParm, Class formalClass,
071: String id, String name, String description,
072: DataType actualDataType, ParameterMode mode, Object value) {
073:
074: if (formalParm == null) {
075: throw new IllegalArgumentException(
076: "Formal parameter cannot be null");
077: }
078: _formalParm = formalParm;
079: _formalClass = formalClass;
080: _id = id;
081: _name = name;
082: _description = description;
083: _dataType = actualDataType;
084: _mode = mode == null ? ParameterMode.IN : mode;
085: _value = value;
086: }
087:
088: public String toString() {
089: return "Parameter[_formalParm=" + _formalParm
090: + ", _formalClass=" + _formalClass + ", _id=" + _id
091: + ", _dataType=" + _dataType + ", _mode=" + _mode
092: + ", _value=" + _value + ']';
093: }
094:
095: public FormalParameter getFormalParm() {
096: return _formalParm;
097: }
098:
099: public Class getFormalClass() {
100: return _formalClass;
101: }
102:
103: public DataType getDataType() {
104: return _dataType;
105: }
106:
107: public String getId() {
108: return _id;
109: }
110:
111: public String getName() {
112: return _name;
113: }
114:
115: public String getDescription() {
116: return _description;
117: }
118:
119: public ParameterMode getMode() {
120: return _mode;
121: }
122:
123: public Object getValue() {
124: return _value;
125: }
126:
127: public void setValue(Object value) {
128: _value = value;
129: }
130: }
|