|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface implemented by classes that are used to manage secured documents.
EbiWorkitemDelegate
Method Summary | |
void |
addDocument(String name,
Document wfDoc,
String user)
Workflow documents are added through this interface. |
void |
addDocument(String name,
String identifier,
String user)
Workflow documents are added through this interface. |
void |
addDocument(String name,
URL url,
String user)
Workflow documents are added through this interface. |
Document |
getDocument(String name)
Workflow documents are fetched by this interface. |
List |
getDocumentNames()
Gets a list of all the document names that are being managed. |
Element |
getDocumentProperties(String docName)
Gets the properties for a document. |
EbiProperty |
getDocumentProperty(String docName,
String propName)
Gets a document property. |
List |
getDocumentPropertyNames(String docName)
Gets the property names for a document. |
boolean |
hasDocument(String docName)
Used to check if a workitem contains a document. |
boolean |
hasDocumentProperty(String docName,
String propName)
Used to check if a document has a specific property. |
boolean |
isDocumentLocked(String docName)
Used to check if a document is locked. |
boolean |
isDocumentLockedBy(String docName,
String user)
Checks to see if a document is locked by a specific user. |
void |
lockDocument(String docName,
String user)
Used to lock a document. |
void |
removeDocument(String name,
boolean removeFromDb,
String user)
Workflow documents are removed through this interface. |
void |
setDocumentProperty(EbiProperty property,
String user)
Each work document may have a set of meta properties that are used by the workflow system for routing decisions and activity operations. |
void |
unlockDocument(String docName,
String user)
Used to unlock a document |
void |
updateDocument(String name,
Document doc,
String user)
Workflow documents are updated through this interface. |
void |
updateDocument(String docName,
String identiifer,
String user)
Workflow documents are updated through this interface. |
void |
updateDocument(String docName,
URL url,
String user)
Workflow documents are updated through this interface. |
Method Detail |
public List getDocumentNames() throws EboWorkitemException
public void addDocument(String name, Document wfDoc, String user) throws EboWorkitemException
name
- The name of the document to be added.wfDoc
- The document to add.user
- The user name to use for adding the document.public void addDocument(String name, String identifier, String user) throws EboWorkitemException
name
- The name of the document to add.identifier
- A generic identifier for a document.user
- The user to add use to add this document.public void addDocument(String name, URL url, String user) throws EboWorkitemException
name
- The name of the document.url
- The url to the document.user
- The user to use to add the document.public Document getDocument(String name) throws EboWorkitemException
name
- The name of the document to get.public void updateDocument(String name, Document doc, String user) throws EboWorkitemException
name
- The name of the document.doc
- The newly updated document.user
- The user to use for updating.public void updateDocument(String docName, URL url, String user) throws EboWorkitemException
docName
- The name of the document.url
- The newly updated url for the document.user
- The user to use for updating the document.public void updateDocument(String docName, String identiifer, String user) throws EboWorkitemException
docName
- The name of the document.identiifer
- An identifier for the document.user
- The user to use for updating.public void removeDocument(String name, boolean removeFromDb, String user) throws EboWorkitemException
name
- The name of the document to remove.removeFromDb
- Whether or not to remove the document from the database.user
- The user to use to remove the document.public void setDocumentProperty(EbiProperty property, String user) throws EboWorkitemException
property
- The property to set.user
- The user to use for setting the property.public EbiProperty getDocumentProperty(String docName, String propName) throws EboWorkitemException
docName
- The name of the document.propName
- The name of the property.public Element getDocumentProperties(String docName) throws EboWorkitemException
docName
- The name of the document.public List getDocumentPropertyNames(String docName) throws EboWorkitemException
docName
- The name of the document.public boolean hasDocument(String docName) throws EboWorkitemException
docName
- The name of the document.public boolean hasDocumentProperty(String docName, String propName) throws EboWorkitemException
docName
- The name of the document.propName
- The name of the property.public void lockDocument(String docName, String user) throws EboWorkitemException
docName
- The name of the document to lock.user
- The name of the user to lock the document by.public void unlockDocument(String docName, String user) throws EboWorkitemException
docName
- The name of the document to unlock.user
- The user to use to unlock the document.public boolean isDocumentLocked(String docName) throws EboWorkitemException
docName
- The name of the document to check.public boolean isDocumentLockedBy(String docName, String user) throws EboWorkitemException
docName
- The name of the document to check.user
- The name of the user to check.
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |