com.sssw.wf.client
Interface EbiWorkitemDelegate

All Superinterfaces:

EbiDelegate, EbiDocumentManager

public interface EbiWorkitemDelegate

extends EbiDocumentManager, EbiDelegate

Delegate interface used by clients to interact with workitems.

To get an instance of the workitem delegate use one of the versions of getWorkitem() or getNextWorkitem() on EbiQueueDelegate.

See Also:

EbiDocumentManager, EbiDelegate

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

void	addDocument(String name, Document wfDoc, EbiContext context) Adds a document to the workitem.
void	addDocument(String name, String identifier, EbiContext context) Adds a document to the workitem.
void	addDocument(String name, URL url, EbiContext context) Adds a document to the workitem.
EbiProperty	createProperty(String propertyName, String propertyValue, String propertyType, boolean immutable) Helper method for creating property objects.
EbiProperty	createProperty(String documentName, String propertyName, String propertyValue, String propertyType, boolean immutable) Helper method for creating property objects.
String	getActivityName() Gets the name of the activity the workitem is currently at in the process.
List	getAllProperties() Gets all properties assigned to workitem and all properties for each document.
List	getAllPropertyNames() Gets all property names assigned to the workitem and all property names for each document.
String	getClientDescription(String type) Return the description of the client type.
String[]	getClientTypes() Return the set of client type names set for the workitem's activity.
String	getClientURI(String type) Return the URI of the client type.
EbiContext	getContext() Gets the context for the workitem delegate.
String	getDefaultDescription() Return the default client description.
String	getDefaultURI() Return the default client URI.
String	getPolicyDefaultDescription() Return the default policy client description.
String	getPolicyDefaultURI() Return the default policy client URI.
EbiProperty	getProperty(String propName) Gets a property from the workitem.
EbiWorkitem	getWorkitem() Gets the workitem that this delegate is working on.
List	getWorkitemProperties() Gets all workitem (non-document) properties.
List	getWorkitemPropertyNames() Gets all workitem (non-document) property names.
Boolean	hasClientDefault() Answer whether the workitem has a default client type
Boolean	hasClientType(String type) Answer whether the workitem has the client type
Boolean	hasPolicyDefault() Answer whether the workitem has a default policy client type
boolean	hasProperty(String propName) Tests whether a workitem contains a property
boolean	isLocked() Tests if the workitem is locked
boolean	isLockedBy(String user) Tests to see if the workitem is locked by the given user.
void	lock(EbiContext context) Locks the workitem for a context.
void	lock(String user) Locks the workitem.
void	lockDocument(String docName, EbiContext context) Locks a document in the workitem.
void	reAssign(EbiAddressee addressee, EbiContext context) Set the addressee to a different recepient.
void	removeDocument(String name, boolean removeFromDb, EbiContext context) Removes a document from the workitem.
void	setContext(EbiContext context) Sets the context for the workitem delegate.
void	setDocumentProperty(EbiProperty property, EbiContext context) Sets a property on a document.
void	setProperty(EbiProperty property, EbiContext context) Sets a property on the workitem.
void	setProperty(EbiProperty property, String user) Sets a property on the workitem.
void	setWorkitem(EbiWorkitem workitem) Sets the workitem that this delegate will work on.
void	unlock(EbiContext context) Unlocks the workitem for a context
void	unlock(String user) Unlocks the workitem.
void	unlockDocument(String docName, EbiContext context) Unlocks a document in the workitem.
void	updateDocument(String name, Document doc, EbiContext context) Updates a document in the workitem.
void	updateDocument(String docName, String identiifer, EbiContext context) Updates a document in the workitem.
void	updateDocument(String docName, URL url, EbiContext context) Updates a document in the workitem.

Methods implemented from interface com.sssw.wf.api.EbiDocumentManager

addDocument, addDocument, addDocument, getDocument, getDocumentNames, getDocumentProperties, getDocumentProperty, getDocumentPropertyNames, hasDocument, hasDocumentProperty, isDocumentLocked, isDocumentLockedBy, lockDocument, removeDocument, setDocumentProperty, unlockDocument, updateDocument, updateDocument, updateDocument

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

getActivityName

public String getActivityName()
                       throws com.sssw.wf.exception.EboWorkitemException

Gets the name of the activity the workitem is currently at in the process.

Returns:

The name of the current activity

Throws:

com.sssw.wf.exception.EboWorkitemException -

getContext

public EbiContext getContext()
                      throws com.sssw.wf.exception.EboWorkitemException

Gets the context for the workitem delegate.

Returns:

The context for the workitem delegate.

Throws:

com.sssw.wf.exception.EboWorkitemException -

setContext

public void setContext(EbiContext context)
                throws com.sssw.wf.exception.EboWorkitemException

Sets the context for the workitem delegate.

Parameters:

context - The context to set.

Throws:

com.sssw.wf.exception.EboWorkitemException -

setWorkitem

public void setWorkitem(EbiWorkitem workitem)
                 throws com.sssw.wf.exception.EboWorkitemException

Sets the workitem that this delegate will work on.

Parameters:

workitem - The workitem to be used by the delegate.

Throws:

com.sssw.wf.exception.EboWorkitemException -

getWorkitem

public EbiWorkitem getWorkitem()
                        throws com.sssw.wf.exception.EboWorkitemException

Gets the workitem that this delegate is working on.

Returns:

The workitem the delegate is using.

Throws:

com.sssw.wf.exception.EboWorkitemException -

hasProperty

public boolean hasProperty(String propName)
                    throws com.sssw.wf.exception.EboWorkitemException

Tests whether a workitem contains a property

Parameters:

propName - The property name to test for.

Returns:

True if the workitem contains the property.

Throws:

com.sssw.wf.exception.EboWorkitemException -

getProperty

public EbiProperty getProperty(String propName)
                        throws com.sssw.wf.exception.EboWorkitemException

Gets a property from the workitem.

Parameters:

propName - The name of the property to get.

Returns:

The property

Throws:

com.sssw.wf.exception.EboWorkitemException -

getWorkitemProperties

public List getWorkitemProperties()
                           throws com.sssw.wf.exception.EboWorkitemException

Gets all workitem (non-document) properties.

Returns:

The list of properties for the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

getAllProperties

public List getAllProperties()
                      throws com.sssw.wf.exception.EboWorkitemException

Gets all properties assigned to workitem and all properties for each document.

Returns:

The list of properties.

Throws:

com.sssw.wf.exception.EboWorkitemException -

getWorkitemPropertyNames

public List getWorkitemPropertyNames()
                              throws com.sssw.wf.exception.EboWorkitemException

Gets all workitem (non-document) property names.

Returns:

The list of property names for the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

getAllPropertyNames

public List getAllPropertyNames()
                         throws com.sssw.wf.exception.EboWorkitemException

Gets all property names assigned to the workitem and all property names for each document.

Returns:

The list of properties.

Throws:

com.sssw.wf.exception.EboWorkitemException -

setProperty

public void setProperty(EbiProperty property,
                        String user)
                 throws com.sssw.wf.exception.EboWorkitemException

Sets a property on the workitem.

Parameters:

property - The property to set.

user - The user that is setting the property. Note you must have the workitem locked in order to set properties.

Throws:

com.sssw.wf.exception.EboWorkitemException -

lock

public void lock(String user)
          throws com.sssw.wf.exception.EboWorkitemException

Locks the workitem.

Parameters:

user - The user to lock the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException - Throws an exception when the workitem is already locked.

unlock

public void unlock(String user)
            throws com.sssw.wf.exception.EboWorkitemException

Unlocks the workitem.

Parameters:

user - The user to unlock the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException - Throws an exception when the workitem is not locked by this user.

setProperty

public void setProperty(EbiProperty property,
                        EbiContext context)
                 throws com.sssw.wf.exception.EboWorkitemException

Sets a property on the workitem. Note you must have the workitem locked in order to set properties.

Parameters:

property - The property to set.

context - The context for the user.

Throws:

com.sssw.wf.exception.EboWorkitemException -

lock

public void lock(EbiContext context)
          throws com.sssw.wf.exception.EboWorkitemException

Locks the workitem for a context.

Parameters:

context - The context.

Throws:

com.sssw.wf.exception.EboWorkitemException -

unlock

public void unlock(EbiContext context)
            throws com.sssw.wf.exception.EboWorkitemException

Unlocks the workitem for a context

Parameters:

context - The context

Throws:

com.sssw.wf.exception.EboWorkitemException -

isLocked

public boolean isLocked()
                 throws com.sssw.wf.exception.EboWorkitemException

Tests if the workitem is locked

Returns:

True if the workitem is locked.

Throws:

com.sssw.wf.exception.EboWorkitemException -

isLockedBy

public boolean isLockedBy(String user)
                   throws com.sssw.wf.exception.EboWorkitemException

Tests to see if the workitem is locked by the given user.

Returns:

Whether or not the workitem is locked by the given user.

Throws:

com.sssw.wf.exception.EboWorkitemException -

addDocument

public void addDocument(String name,
                        Document wfDoc,
                        EbiContext context)
                 throws com.sssw.wf.exception.EboWorkitemException

Adds a document to the workitem.

Parameters:

name - The name to store the document in the workitem with.

wfDoc - The document to be stored.

context - The context to use for accessing the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

addDocument

public void addDocument(String name,
                        String identifier,
                        EbiContext context)
                 throws com.sssw.wf.exception.EboWorkitemException

Adds a document to the workitem.

Parameters:

name - The name to store the document in the workitem with.

identifier - An identifier for the information in the document.

context - A context to use for accessing the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

addDocument

public void addDocument(String name,
                        URL url,
                        EbiContext context)
                 throws com.sssw.wf.exception.EboWorkitemException

Adds a document to the workitem.

Parameters:

name - The name to store the document in the workitem under.

url - The url for the document.

context - The context for accessing the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

updateDocument

public void updateDocument(String name,
                           Document doc,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboWorkitemException

Updates a document in the workitem.

Parameters:

name - The name of the document.

doc - The newly updated document.

context - The context used for accessing the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

updateDocument

public void updateDocument(String docName,
                           URL url,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboWorkitemException

Updates a document in the workitem.

Parameters:

docName - The name of the document in the workitem.

url - The new url for the document.

context - The context to use when accessing the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

updateDocument

public void updateDocument(String docName,
                           String identiifer,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboWorkitemException

Updates a document in the workitem.

Parameters:

docName - The name of the document.

identiifer - The new identifier for the document.

context - The context to use when accessing the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

removeDocument

public void removeDocument(String name,
                           boolean removeFromDb,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboWorkitemException

Removes a document from the workitem.

Parameters:

name - The name of the document.

removeFromDb - Whether or not to remove the document from the database.

context - The context to use when accessing the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

setDocumentProperty

public void setDocumentProperty(EbiProperty property,
                                EbiContext context)
                         throws com.sssw.wf.exception.EboWorkitemException

Sets a property on a document.

Parameters:

property - The property to set on the document.

context - The context to use to access the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

lockDocument

public void lockDocument(String docName,
                         EbiContext context)
                  throws com.sssw.wf.exception.EboWorkitemException

Locks a document in the workitem.

Parameters:

docName - The name of the document to lock.

context - The context to use to access the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

unlockDocument

public void unlockDocument(String docName,
                           EbiContext context)
                    throws com.sssw.wf.exception.EboWorkitemException

Unlocks a document in the workitem.

Parameters:

docName - The name of the document in the workitem.

context - The context to use to access the workitem.

Throws:

com.sssw.wf.exception.EboWorkitemException -

createProperty

public EbiProperty createProperty(String propertyName,
                                  String propertyValue,
                                  String propertyType,
                                  boolean immutable)

Helper method for creating property objects.

Parameters:

propertyName - The name of the property.

propertyValue - The value for the property.

propertyType - The type of property.

immutable - Whether or not the property is immutable.

Returns:

An EbiProperty for the new property.

createProperty

public EbiProperty createProperty(String documentName,
                                  String propertyName,
                                  String propertyValue,
                                  String propertyType,
                                  boolean immutable)

Helper method for creating property objects.

Parameters:

documentName - The name of the document.

propertyName - The name of the property.

propertyValue - The value of the property.

propertyType - The property type.

immutable - Whether or not the property is immutable.

Returns:

An EbiProperty for the new property.

reAssign

public void reAssign(EbiAddressee addressee,
                     EbiContext context)
              throws com.sssw.wf.exception.EboWorkitemException

Set the addressee to a different recepient.

Parameters:

addressee - The new addressee.

context - Workflow context for authorization.

getClientTypes

public String[] getClientTypes()

Return the set of client type names set for the workitem's activity.

Returns:

An String[] containing the client type names.

getClientDescription

public String getClientDescription(String type)

Return the description of the client type.

Parameters:

type - The type.

Returns:

The client type description.

getClientURI

public String getClientURI(String type)

Return the URI of the client type.

Parameters:

type - The type.

Returns:

The client type URI.

getDefaultDescription

public String getDefaultDescription()

Return the default client description. Return null if there is no default.

Returns:

The default client description.

getDefaultURI

public String getDefaultURI()

Return the default client URI. Return null if there is no default.

Returns:

The default client URI.

getPolicyDefaultDescription

public String getPolicyDefaultDescription()

Return the default policy client description. Return null if there is no default.

Returns:

The default client description.

getPolicyDefaultURI

public String getPolicyDefaultURI()

Return the default policy client URI. Return null if there is no default.

Returns:

The default client URI.

hasClientType

public Boolean hasClientType(String type)

Answer whether the workitem has the client type

Parameters:

type - The client type.

Returns:

Boolean.

hasClientDefault

public Boolean hasClientDefault()

Answer whether the workitem has a default client type

Returns:

Boolean.

hasPolicyDefault

public Boolean hasPolicyDefault()

Answer whether the workitem has a default policy client type

Returns:

Boolean.