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.spi.model;
046:
047: import org.obe.client.api.repository.ObjectNotFoundException;
048: import org.obe.client.api.repository.RepositoryException;
049:
050: import java.util.Map;
051:
052: /**
053: * Base interface for entities with attributes that are accessible via WAPI.
054: *
055: * @author Adrian Price
056: */
057: public interface AttributedEntity {
058: /**
059: * The entity is of type {@link ProcessInstance}
060: */
061: int PROCESS_INSTANCE_TYPE = 0;
062: /**
063: * The entity is of type {@link ActivityInstance}
064: */
065: int ACTIVITY_INSTANCE_TYPE = 1;
066: /**
067: * The entity is of type {@link WorkItem}
068: */
069: int WORKITEM_TYPE = 2;
070:
071: /**
072: * Returns the ID of the associated process definition.
073: *
074: * @return The process definition ID.
075: */
076: String getProcessDefinitionId();
077:
078: /**
079: * Returns the ID of the associated process instance.
080: *
081: * @return The process instance ID.
082: */
083: String getProcessInstanceId();
084:
085: /**
086: * Returns the primary key for the entity.
087: *
088: * @return The entity's primary key.
089: */
090: String getEntityId();
091:
092: /**
093: * Returns the named attribute for the entity, if one exists.
094: *
095: * @param attributeName The name of the attribute.
096: * @return The requested attribute.
097: * @throws ObjectNotFoundException if the attribute could not be found.
098: * @throws RepositoryException if some other exception occurred.
099: */
100: AttributeInstance getAttributeInstance(String attributeName)
101: throws RepositoryException;
102:
103: /**
104: * Returns a map of attributes for this entity, keyed on attribute name.
105: *
106: * @return An immutable map of attribute instances.
107: */
108: Map getAttributeInstances() throws RepositoryException;
109: }
|