com.sssw.wf.api
Interface EbiDocumentManager

public interface EbiDocumentManager

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

See Also:

EbiWorkitemDelegate

Method Summary

void	addDocument(String name, Document wfDoc) Unsecured workflow documents are added through this interface.
void	addDocument(String name, String identifier) Unsecured workflow documents are added through this interface.
void	addDocument(String name, URL url) Unsecured 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.
void	removeDocument(String name) Workflow documents are removed through this interface.
void	setDocumentProperty(EbiProperty property) Each work document may have a set of meta properties that are used by the workflow system for routing decisions and activity operations.
void	updateDocument(String name, Document doc) Unsecured workflow documents are updated through this interface.
void	updateDocument(String docName, String identifer) Workflow documents are updated through this interface.
void	updateDocument(String docName, URL url) Unsecured 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)
                 throws EboWorkitemException

Unsecured workflow documents are added through this interface.

Parameters:

name - The name of the document to be added.

wfDoc - The document to add.

Throws:

EboWorkitemException -

addDocument

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

Unsecured workflow documents are added through this interface.

Parameters:

name - The name of the document to add.

identifier - A generic identifier for a document.

Throws:

EboWorkitemException -

addDocument

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

Unsecured workflow documents are added through this interface.

Parameters:

name - The name of the document.

url - The url to 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)
                    throws EboWorkitemException

Unsecured workflow documents are updated through this interface. The entire document is updated.

Parameters:

name - The name of the document.

doc - The newly updated document.

Throws:

EboWorkitemException -

updateDocument

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

Unsecured workflow documents are updated through this interface.

Parameters:

docName - The name of the document.

url - The newly updated url for the document.

Throws:

EboWorkitemException -

updateDocument

public void updateDocument(String docName,
                           String identifer)
                    throws EboWorkitemException

Workflow documents are updated through this interface.

Parameters:

docName - The name of the document.

identiifer - An identifier for the document.

Throws:

EboWorkitemException -

removeDocument

public void removeDocument(String name)
                    throws EboWorkitemException

Workflow documents are removed through this interface.

Parameters:

name - The name of the document to remove.

Throws:

EboWorkitemException -

setDocumentProperty

public void setDocumentProperty(EbiProperty property)
                         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. This interface applies to unsecured documents.

Parameters:

property - The property to set.

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 -