wt.doc
Class DocumentFactory

java.lang.Object
  wt.doc.DocumentFactory

All Implemented Interfaces:

ApplicationContextChild, Externalizable, Serializable

public class DocumentFactory

extends Object

implements ApplicationContextChild, Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private ApplicationContext	applicationContext
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from interface wt.services.applicationcontext.ApplicationContextChild

APPLICATION_CONTEXT

Constructor Summary

DocumentFactory()

Method Summary

static FormatContentHolder	checkinDocument(FormatContentHolder document, DocumentFormData form_data) Does the checkin of the document and allows for any post checkin processing.
static FormatContentHolder	checkOutDocument(FormatContentHolder document, DocumentFormData form_data) Does the checkout of the document and allows for any post checkout processing.
static FormatContentHolder	createDocument(String doc_type, DocumentFormData form_data) Create a document object and persist it.
ApplicationContext	getApplicationContext() Gets the object for the association that plays role: applicationContext.
ApplicationContextServices	getApplicationContextServices()
static FormatContentHolder	postCreateDocument(FormatContentHolder document, DocumentFormData form_data) Allow for extra post processing of the document after it has been persisted.
static FormatContentHolder	postUpdateDocument(FormatContentHolder document, DocumentFormData form_data) Allow for extra post processing of the document after it has been persisted.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(DocumentFactory thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setApplicationContext(ApplicationContext a_ApplicationContext) Sets the object for the association that plays role: applicationContext.
static FormatContentHolder	updateDocument(FormatContentHolder document, DocumentFormData form_data) Update a document object and persist it.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

applicationContext

private ApplicationContext applicationContext

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

DocumentFactory

public DocumentFactory()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(DocumentFactory thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

createDocument

public static FormatContentHolder createDocument(String doc_type,
                                                 DocumentFormData form_data)
                                          throws WTException

Create a document object and persist it.

Supported API: true

Parameters:

doc_type - The class for the document to be created.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

postCreateDocument

public static 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 - Object used to retrieve the correct delegate. Not used for any other processing.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

updateDocument

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

Update a document object and persist it.

Supported API: true

Parameters:

document - Object used to retrieve the correct delegate. Not used for any other processing.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

postUpdateDocument

public static 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 - Object used to retrieve the correct delegate. Not used for any other processing.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

checkinDocument

public static 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 - Object used to retrieve the correct delegate. Not used for any other processing.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

checkOutDocument

public static 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 - Object used to retrieve the correct delegate. Not used for any other processing.

form_data - Name value pairs from the UI.

Returns:

FormatContentHolder

Throws:

WTException

getApplicationContext

public ApplicationContext getApplicationContext()

Gets the object for the association that plays role: applicationContext.

Supported API: false

Specified by:

getApplicationContext in interface ApplicationContextChild

Returns:

ApplicationContext

setApplicationContext

public void setApplicationContext(ApplicationContext a_ApplicationContext)
                           throws WTPropertyVetoException

Sets the object for the association that plays role: applicationContext.

Supported API: false

Specified by:

setApplicationContext in interface ApplicationContextChild

Parameters:

a_ApplicationContext -

Throws:

WTPropertyVetoException

getApplicationContextServices

public ApplicationContextServices getApplicationContextServices()