01: /*--
02:
03: Copyright (C) 2002-2005 Adrian Price.
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09:
10: 1. Redistributions of source code must retain the above copyright
11: notice, this list of conditions, and the following disclaimer.
12:
13: 2. Redistributions in binary form must reproduce the above copyright
14: notice, this list of conditions, and the disclaimer that follows
15: these conditions in the documentation and/or other materials
16: provided with the distribution.
17:
18: 3. The names "OBE" and "Open Business Engine" must not be used to
19: endorse or promote products derived from this software without prior
20: written permission. For written permission, please contact
21: adrianprice@sourceforge.net.
22:
23: 4. Products derived from this software may not be called "OBE" or
24: "Open Business Engine", nor may "OBE" or "Open Business Engine"
25: appear in their name, without prior written permission from
26: Adrian Price (adrianprice@users.sourceforge.net).
27:
28: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
29: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
32: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
33: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
34: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
37: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38: POSSIBILITY OF SUCH DAMAGE.
39:
40: For more information on OBE, please see
41: <http://obe.sourceforge.net/>.
42:
43: */
44:
45: package org.obe.spi.model;
46:
47: import org.obe.OBERuntimeException;
48: import org.obe.xpdl.model.data.DataTypes;
49: import org.obe.xpdl.model.data.Type;
50:
51: /**
52: * Holds the persistent state of workflow relevant data. This interface
53: * uses only standard Java data types; it does not need to know about
54: * WAPI data types - conversions are handled externally to the persistence
55: * service. No parameter validation need be performed by implementations.
56: *
57: * @author Adrian Price
58: */
59: public interface AttributeInstance {
60: AttributedEntity getOwner();
61:
62: String getName();
63:
64: int getType();
65:
66: /**
67: * Retrieves the attribute value. Implementations are responsible for
68: * returning an instance of the correct class for the data type.
69: *
70: * @return The attribute value.
71: * @throws OBERuntimeException if the value cannot be converted to the
72: * correct class.
73: * @see DataTypes#classForType(int)
74: * @see DataTypes#classForDataType
75: */
76: Object getValue();
77:
78: /**
79: * Sets the attribute value. Implementations are responsible for converting
80: * the value to the correct class for the data type.
81: *
82: * @param type The data type (typically {@link Type#DEFAULT_TYPE}).
83: * @param value The value to set.
84: * @throws OBERuntimeException If the value cannot be converted to the
85: * correct class.
86: * @throws AttributeReadOnlyException if the attribute in question cannot be
87: * updated because it is read-only (applies to system attributes only).
88: * @see DataTypes#classForType
89: * @see DataTypes#classForDataType
90: */
91: void setValue(int type, Object value)
92: throws AttributeReadOnlyException;
93: }
|