com.sssw.wf.api
Interface EbiSecuredDocumentManager

All Known Subinterfaces:

EbiWorkitemDelegate

public interface EbiSecuredDocumentManager

Interface implemented by classes that are used to manage secured documents.

See Also:

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

getDocumentNames

public List getDocumentNames()
                      throws EboWorkitemException

Gets a list of all the document names that are being managed.

Returns:

A list of document names.

Throws:

EboWorkitemException -

addDocument

public void addDocument(String name,
                        Document wfDoc,
                        String user)
                 throws EboWorkitemException

Workflow documents are added through this interface.

Parameters:

name - The name of the document to be added.

wfDoc - The document to add.

user - The user name to use for adding the document.

Throws:

EboWorkitemException -

addDocument

public void addDocument(String name,
                        String identifier,
                        String user)
                 throws EboWorkitemException

Workflow documents are added through this interface.

Parameters:

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.

Throws:

EboWorkitemException -

addDocument

public void addDocument(String name,
                        URL url,
                        String user)
                 throws EboWorkitemException

Workflow documents are added through this interface.

Parameters:

name - The name of the document.

url - The url to the document.

user - The user to use to add the document.

Throws:

EboWorkitemException -

getDocument

public Document getDocument(String name)
                     throws EboWorkitemException

Workflow documents are fetched by this interface.

Parameters:

name - The name of the document to get.

Returns:

The document.

Throws:

EboWorkitemException -

updateDocument

public void updateDocument(String name,
                           Document doc,
                           String user)
                    throws EboWorkitemException

Workflow documents are updated through this interface. The entire document is updated.

Parameters:

name - The name of the document.

doc - The newly updated document.

user - The user to use for updating.

Throws:

EboWorkitemException -

updateDocument

public void updateDocument(String docName,
                           URL url,
                           String user)
                    throws EboWorkitemException

Workflow documents are updated through this interface.

Parameters:

docName - The name of the document.

url - The newly updated url for the document.

user - The user to use for updating the document.

Throws:

EboWorkitemException -

updateDocument

public void updateDocument(String docName,
                           String identiifer,
                           String user)
                    throws EboWorkitemException

Workflow documents are updated through this interface.

Parameters:

docName - The name of the document.

identiifer - An identifier for the document.

user - The user to use for updating.

Throws:

EboWorkitemException -

removeDocument

public void removeDocument(String name,
                           boolean removeFromDb,
                           String user)
                    throws EboWorkitemException

Workflow documents are removed through this interface. The boolean flag determines whether the document is purged from the database.

Parameters:

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.

Throws:

EboWorkitemException -

setDocumentProperty

public void setDocumentProperty(EbiProperty property,
                                String user)
                         throws EboWorkitemException

Each work document may have a set of meta properties that are used by the workflow system for routing decisions and activity operations. These properties can be assigned and retrieved as needed. They are considered part of the document and will be saved in the document audit.

Parameters:

property - The property to set.

user - The user to use for setting the property.

Throws:

EboWorkitemException -

getDocumentProperty

public EbiProperty getDocumentProperty(String docName,
                                       String propName)
                                throws EboWorkitemException

Gets a document property.

Parameters:

docName - The name of the document.

propName - The name of the property.

Returns:

The property for the document.

Throws:

EboWorkitemException -

getDocumentProperties

public Element getDocumentProperties(String docName)
                              throws EboWorkitemException

Gets the properties for a document.

Parameters:

docName - The name of the document.

Returns:

Properties element for the document.

Throws:

EboWorkitemException -

getDocumentPropertyNames

public List getDocumentPropertyNames(String docName)
                              throws EboWorkitemException

Gets the property names for a document.

Parameters:

docName - The name of the document.

Returns:

The list of property names for the document.

Throws:

EboWorkitemException -

hasDocument

public boolean hasDocument(String docName)
                    throws EboWorkitemException

Used to check if a workitem contains a document.

Parameters:

docName - The name of the document.

Returns:

Whether or not a document by that name exists within the workitem.

Throws:

EboWorkitemException -

hasDocumentProperty

public boolean hasDocumentProperty(String docName,
                                   String propName)
                            throws EboWorkitemException

Used to check if a document has a specific property.

Parameters:

docName - The name of the document.

propName - The name of the property.

Returns:

Whether or not the document contains the property.

Throws:

EboWorkitemException -

lockDocument

public void lockDocument(String docName,
                         String user)
                  throws EboWorkitemException

Used to lock a document.

Parameters:

docName - The name of the document to lock.

user - The name of the user to lock the document by.

Throws:

EboWorkitemException -

unlockDocument

public void unlockDocument(String docName,
                           String user)
                    throws EboWorkitemException

Used to unlock a document

Parameters:

docName - The name of the document to unlock.

user - The user to use to unlock the document.

Throws:

EboWorkitemException -

isDocumentLocked

public boolean isDocumentLocked(String docName)
                         throws EboWorkitemException

Used to check if a document is locked.

Parameters:

docName - The name of the document to check.

Returns:

Whether or not the document is locked.

isDocumentLockedBy

public boolean isDocumentLockedBy(String docName,
                                  String user)
                           throws EboWorkitemException

Checks to see if a document is locked by a specific user.

Parameters:

docName - The name of the document to check.

user - The name of the user to check.

Returns:

Whether or not the document is locked by the specific user.