org.obe.spi.model
Interface AttributedEntity

All Known Subinterfaces:

ActivityInstance, ProcessInstance, WorkItem

public interface AttributedEntity

Base interface for entities with attributes that are accessible via WAPI.

Author:

Adrian Price

Field Summary

static int	ACTIVITY_INSTANCE_TYPE The entity is of type ActivityInstance
static int	PROCESS_INSTANCE_TYPE The entity is of type ProcessInstance
static int	WORKITEM_TYPE The entity is of type WorkItem

Method Summary

AttributeInstance	getAttributeInstance(java.lang.String attributeName) Returns the named attribute for the entity, if one exists.
java.util.Map	getAttributeInstances() Returns a map of attributes for this entity, keyed on attribute name.
java.lang.String	getEntityId() Returns the primary key for the entity.
java.lang.String	getProcessDefinitionId() Returns the ID of the associated process definition.
java.lang.String	getProcessInstanceId() Returns the ID of the associated process instance.

Field Detail

PROCESS_INSTANCE_TYPE

public static final int PROCESS_INSTANCE_TYPE

The entity is of type ProcessInstance

See Also:

Constant Field Values

ACTIVITY_INSTANCE_TYPE

public static final int ACTIVITY_INSTANCE_TYPE

The entity is of type ActivityInstance

See Also:

Constant Field Values

WORKITEM_TYPE

public static final int WORKITEM_TYPE

The entity is of type WorkItem

See Also:

Constant Field Values

Method Detail

getProcessDefinitionId

public java.lang.String getProcessDefinitionId()

Returns the ID of the associated process definition.

Returns:

The process definition ID.

getProcessInstanceId

public java.lang.String getProcessInstanceId()

Returns the ID of the associated process instance.

Returns:

The process instance ID.

getEntityId

public java.lang.String getEntityId()

Returns the primary key for the entity.

Returns:

The entity's primary key.

getAttributeInstance

public AttributeInstance getAttributeInstance(java.lang.String attributeName)
                                       throws RepositoryException

Returns the named attribute for the entity, if one exists.

Parameters:

attributeName - The name of the attribute.

Returns:

The requested attribute.

Throws:

ObjectNotFoundException - if the attribute could not be found.

RepositoryException - if some other exception occurred.

getAttributeInstances

public java.util.Map getAttributeInstances()
                                    throws RepositoryException

Returns a map of attributes for this entity, keyed on attribute name.

Returns:

An immutable map of attribute instances.

Throws:

RepositoryException