wt.doc
Class DocumentContentProcessing

java.lang.Object
  wt.doc.DocumentContentProcessing

public class DocumentContentProcessing

extends Object

Warning! This class is no longer used in most of the content processing done in any of the clients. This class will probably be deprecated or moved in a future release when the supported clients no longer use this class. Client class used as a place holder for content processing associated with document structures. The content processing for the selected document is done by the beans in the user interface. This class will handle the content process for other documents in the structure. This is not a delegate but may be overridden or replaced. Change the wt.doc.DocumentContentProcessing=wt.doc.DocumentContentProcessing property in wt.properties if another class should be used instead of this class.

Supported API: true

Extendable: true

Field Summary

private static String	CLASSNAME
private static boolean	DEBUG
static String	GETCONTENT Used for the method name when calling DocumentContentProcessing.runContentProcess().
static String	POSTCREATE Used for the method name when calling DocumentContentProcessing.runContentProcess().
static String	POSTUPDATE Used for the method name when calling DocumentContentProcessing.runContentProcess().
static String	PRECHECKIN Used for the method name when calling DocumentContentProcessing.runContentProcess().
private static String	RESOURCE

Constructor Summary

DocumentContentProcessing()

Method Summary

protected static void	downloadStructureContent(WTDocument doc, String upload_from_path, HTTPUploadDownloadTask download_task)
static String	getContent(DocumentFormData form_data, FormatContentHolder doc) Method that is called after the Check Out and Get Content to allow for customizers to do any local file handling on other documents in the structure.
static String	postCreate(DocumentFormData form_data, ReferenceHolder doc_handle) Method that is called after the create of the document and any links are created to allow customizers to do any local file handling on other documents in the structure.
static String	postUpdate(DocumentFormData form_data, ReferenceHolder doc_handle) Method that is called after the update of the document and any links are updated to allow customizers to do any local file handling on other documents in the structure.
static String	preCheckin(DocumentFormData form_data, ReferenceHolder doc_handle) Method that is called before the checkin to allow for customizers to do any local file handling on other documents in the structure.
static String	runContentProcess(String method_name, DocumentFormData form_data, FormatContentHolder doc) This method is used to call the other methods in this class through the document UI.
static String	runContentProcess(String method_name, DocumentFormData form_data, ReferenceHolder doc_handle) This method is used to call the other methods in this class through the document UI.

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

DEBUG

private static boolean DEBUG

GETCONTENT

public static final String GETCONTENT

Used for the method name when calling DocumentContentProcessing.runContentProcess().

Supported API: true

See Also:

Constant Field Values

POSTCREATE

public static final String POSTCREATE

Used for the method name when calling DocumentContentProcessing.runContentProcess().

Supported API: true

See Also:

Constant Field Values

POSTUPDATE

public static final String POSTUPDATE

Used for the method name when calling DocumentContentProcessing.runContentProcess().

Supported API: true

See Also:

Constant Field Values

PRECHECKIN

public static final String PRECHECKIN

Used for the method name when calling DocumentContentProcessing.runContentProcess().

Supported API: true

See Also:

Constant Field Values

Constructor Detail

DocumentContentProcessing

public DocumentContentProcessing()

Method Detail

postCreate

public static String postCreate(DocumentFormData form_data,
                                ReferenceHolder doc_handle)
                         throws WTException

Method that is called after the create of the document and any links are created to allow customizers to do any local file handling on other documents in the structure. The local file handling on the selected document is done outside of this method, it is done in the bean. This method currently does nothing, but it is called from inside of the client.

Supported API: true

Parameters:

form_data - Name value pairs from the UI.

doc_handle - A reference to the document that will be processed.

Returns:

String

Throws:

WTException

postUpdate

public static String postUpdate(DocumentFormData form_data,
                                ReferenceHolder doc_handle)
                         throws WTException

Method that is called after the update of the document and any links are updated to allow customizers to do any local file handling on other documents in the structure. The local file handling on the selected document is done outside of this method, it is done in the bean. This method currently does nothing, but it is called from inside of the client.

Supported API: true

Parameters:

form_data - Name value pairs from the UI.

doc_handle - A reference to the document that will be processed.

Returns:

String

Throws:

WTException

preCheckin

public static String preCheckin(DocumentFormData form_data,
                                ReferenceHolder doc_handle)
                         throws WTException

Method that is called before the checkin to allow for customizers to do any local file handling on other documents in the structure. The local file handling on the selected document is done outside of this method, it is done in the bean. This method currently does nothing.

Supported API: true

Parameters:

form_data - Name value pairs from the UI.

doc_handle - A reference to the document that will be processed.

Returns:

String

Throws:

WTException

getContent

public static String getContent(DocumentFormData form_data,
                                FormatContentHolder doc)
                         throws WTException

Method that is called after the Check Out and Get Content to allow for customizers to do any local file handling on other documents in the structure. The local file handling on the selected document is done outside of this method, it is done in the bean. This method currently does a download of the files from walking the selected document's structure. All of the files are downloaded to the same directory that the primary file from the selected document will be put to.

Supported API: true

Parameters:

form_data - Name value pairs from the UI.

doc - A reference to the document that will be processed.

Returns:

String

Throws:

WTException

runContentProcess

public static String runContentProcess(String method_name,
                                       DocumentFormData form_data,
                                       ReferenceHolder doc_handle)
                                throws WTException

This method is used to call the other methods in this class through the document UI. Uses the method string to set the method and a wt.properties property wt.doc.contentProcessingDelegate to set the class to call and then passes in the other parameters in and returns the results. If wt.doc.contentProcessingDelegate is not set or there is an error reading the properties the class will default to wt.doc.DocumentContentProcessing.

Supported API: true

Parameters:

method_name -

form_data - Name value pairs from the UI.

doc_handle - A reference to the document that will be processed.

Returns:

String

Throws:

WTException

runContentProcess

public static String runContentProcess(String method_name,
                                       DocumentFormData form_data,
                                       FormatContentHolder doc)
                                throws WTException

This method is used to call the other methods in this class through the document UI. Uses the method string to set the method and a wt.properties property wt.doc.contentProcessingDelegate to set the class to call and then passes in the other parameters in and returns the results. If wt.doc.contentProcessingDelegate is not set or there is an error reading the properties the class will default to wt.doc.DocumentContentProcessing.

Supported API: true

Parameters:

method_name -

form_data - Name value pairs from the UI.

doc - A reference to the document that will be processed.

Returns:

String

Throws:

WTException

downloadStructureContent

protected static void downloadStructureContent(WTDocument doc,
                                               String upload_from_path,
                                               HTTPUploadDownloadTask download_task)
                                        throws WTException

Throws:

WTException