|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface implemented by any workitem delegate class. The workitem delegate is used by clients to interact with workitems.
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 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. |
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. |
com.sssw.wf.api.EbiWorkitem |
getWorkitem()
Gets the workitem that this delegate is working on. |
List |
getWorkitemProperties()
Gets all workitem properties. |
List |
getWorkitemPropertyNames()
Gets all workitem 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 or not a workitem contains a property |
boolean |
isLocked()
Tests to see 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 |
removeDocument(String name,
boolean removeFromDb,
EbiContext context)
Removes a document from the workitem. |
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(com.sssw.wf.client.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.EbiSecuredDocumentManager |
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 |
public String getActivityName() throws EboWorkitemException
public void setWorkitem(com.sssw.wf.client.EbiWorkitem workitem) throws EboWorkitemException
wi
- The workitem to be used by the delegate.public com.sssw.wf.api.EbiWorkitem getWorkitem() throws EboWorkitemException
public boolean hasProperty(String propName) throws EboWorkitemException
propName
- The property name to test for.public EbiProperty getProperty(String propName) throws EboWorkitemException
propName
- The name of the property to get.public List getWorkitemProperties() throws EboWorkitemException
docName
- The name of the document.public List getAllProperties() throws EboWorkitemException
docName
- The name of the document.public List getWorkitemPropertyNames() throws EboWorkitemException
docName
- The name of the document.public List getAllPropertyNames() throws EboWorkitemException
docName
- The name of the document.public void setProperty(EbiProperty property, String user) throws EboWorkitemException
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.public void lock(String user) throws EboWorkitemException
user
- The user to lock the workitem.public void unlock(String user) throws EboWorkitemException
user
- The user to unlock the workitem.public void setProperty(EbiProperty property, EbiContext context) throws EboWorkitemException
property
- The property to set.context
- The context for the user.public void lock(EbiContext context) throws EboWorkitemException
context
- The context.public void unlock(EbiContext context) throws EboWorkitemException
context
- The contextpublic boolean isLocked() throws EboWorkitemException
public boolean isLockedBy(String user) throws EboWorkitemException
public void addDocument(String name, Document wfDoc, EbiContext context) throws EboWorkitemException
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.public void addDocument(String name, String identifier, EbiContext context) throws EboWorkitemException
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.public void addDocument(String name, URL url, EbiContext context) throws EboWorkitemException
name
- The name to store the document in the workitem under.url
- The url for the document.context
- The context for accessing the workitem.public void updateDocument(String name, Document doc, EbiContext context) throws EboWorkitemException
name
- The name of the document.doc
- The newly updated document.context
- The context used for accessing the workitem.public void updateDocument(String docName, URL url, EbiContext context) throws EboWorkitemException
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.public void updateDocument(String docName, String identiifer, EbiContext context) throws EboWorkitemException
docName
- The name of the document.identiifer
- The new identifier for the document.context
- The context to use when accessing the workitem.public void removeDocument(String name, boolean removeFromDb, EbiContext context) throws EboWorkitemException
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.public void setDocumentProperty(EbiProperty property, EbiContext context) throws EboWorkitemException
property
- The property to set on the document.context
- The context to use to access the workitem.public void lockDocument(String docName, EbiContext context) throws EboWorkitemException
docName
- The name of the document to lock.context
- The context to use to access the workitem.public void unlockDocument(String docName, EbiContext context) throws EboWorkitemException
docName
- The name of the document in the workitem.context
- The context to use to access the workitem.public EbiProperty createProperty(String propertyName, String propertyValue, String propertyType, boolean immutable)
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.public EbiProperty createProperty(String documentName, String propertyName, String propertyValue, String propertyType, boolean immutable)
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.public String[] getClientTypes()
public String getClientDescription(String type)
type
- The type.public String getClientURI(String type)
type
- The type.public String getDefaultDescription()
public String getDefaultURI()
public String getPolicyDefaultDescription()
public String getPolicyDefaultURI()
public Boolean hasClientType(String type)
type
- The client type.public Boolean hasClientDefault()
public Boolean hasPolicyDefault()
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |