wt.doc
Interface DocumentDelegate

All Known Implementing Classes:

WTDocumentDelegate

public interface DocumentDelegate

Delegate for the UI to process documents with. Allows customers to substitute site specific processing.

Supported API: true

Extendable: true

Method Summary

FormatContentHolder	checkinDocument(FormatContentHolder document, DocumentFormData form_data) Does the checkin of the document and allows for any post checkin processing.
FormatContentHolder	checkOutDocument(FormatContentHolder document, DocumentFormData form_data) Does the checkout of the document and allows for any post checkout processing.
FormatContentHolder	createDocument(DocumentFormData form_data) Create a document object and persist it.
FormatContentHolder	postCreateDocument(FormatContentHolder document, DocumentFormData form_data) Allow for extra post processing of the document after it has been persisted.
FormatContentHolder	postUpdateDocument(FormatContentHolder document, DocumentFormData form_data) Allow for extra post processing of the document after it has been persisted.
FormatContentHolder	updateDocument(FormatContentHolder document, DocumentFormData form_data) Update a document object and persist it.

Method Detail

createDocument

public FormatContentHolder createDocument(DocumentFormData form_data)
                                   throws WTException

Create a document object and persist it.

Supported API: true

Parameters:

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

postCreateDocument

public FormatContentHolder postCreateDocument(FormatContentHolder document,
                                              DocumentFormData form_data)
                                       throws WTException

Allow for extra post processing of the document after it has been persisted. For example this will handle the creation and persistance of relationships.

Supported API: true

Parameters:

document - The document that will be processed.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

updateDocument

public FormatContentHolder updateDocument(FormatContentHolder document,
                                          DocumentFormData form_data)
                                   throws WTException

Update a document object and persist it.

Supported API: true

Parameters:

document - The document that will be processed.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

postUpdateDocument

public FormatContentHolder postUpdateDocument(FormatContentHolder document,
                                              DocumentFormData form_data)
                                       throws WTException

Allow for extra post processing of the document after it has been persisted. For example this will handle the creation and persistance of relationships or the removal of relationships.

Supported API: true

Parameters:

document - The document that will be processed.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

checkinDocument

public FormatContentHolder checkinDocument(FormatContentHolder document,
                                           DocumentFormData form_data)
                                    throws WTException

Does the checkin of the document and allows for any post checkin processing.

Supported API: true

Parameters:

document - The document that will be processed.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

checkOutDocument

public FormatContentHolder checkOutDocument(FormatContentHolder document,
                                            DocumentFormData form_data)
                                     throws WTException

Does the checkout of the document and allows for any post checkout processing.

Supported API: true

Parameters:

document - The document that will be processed.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException