BusinessDocumentInterface

This interface represents the business document that is being processed. It has 18 methods.

Method

getDocumentUUID

Method description

Retrieves the Unique ID associated with this document

Syntax

public String getDocumentUUID()

Parameters

None

Method

getDocumentParentUUID

Method description

Retrieves the Unique ID associated with this document's parent

Syntax

public String getDocumentParentUUID()

Parameters

None

Method

createFile

Method description

Creates a File object for use in writing files other than the Business Document to the file system. Creates a name based on the Business Document name. This method is used, for example, in handling attachments. It is also used to create the File object in the case of a sync response document which must then be set in the Sender Result object.

Syntax

public File createFile()

Parameters

None

Method

getDocument

Method description

Retrieves a File reference for the Business Document in the WBI-C working directory

Syntax

public File getDocument()

Parameters

None

Method

setDocument

Method description

Writes the document to the WBI-C working directory

Syntax

public void setDocument(File document)

Parameters

document
The business document

Method

getOriginalFile

Method description

Gets the location of the original file, that is, the one that came into the in_process directory (the WBI-C working directory)

Syntax

public File getOriginalFile()

Parameters

None

Method

getDocumentState

Method description

Retrieves the status of the document

Syntax

public String getDocumentState()

Parameters

None

Method

setDocumentState

Method description

Sets the status of the document

Syntax

public String setDocumentState(String state)

Parameters

state
The status to be set

Method

addEvents

Method description

Adds events to be associated with this document. These events will be displayed in the event viewer and the document viewer.

Syntax

public void addEvents(EventInfo[] events)

Parameters

events
The array of EventInfo objects to be added

Method

getEvents

Method description

Retrieves the array of EventInfo objects associated with this document.

Syntax

public EventInfo[] getEvents()

Parameters

None

Method

clearEvents

Method description

Clears events set till now. When BPE has finished processing all events for the business process, it calls this method to clear all events so that it does not process the same events twice.

Syntax

public void clearEvents()

Parameters

None

Method

getAttribute

Method description

Gets the named attribute. Used to retrieve information such as packaging name and version, etc. For list of available attributes refer to the DocumentConstant class below.

Syntax

public Object getAttribute(String attrName)

Parameters

attrName
The name of the attribute requested

Method

setAttribute

Method description

Sets the named attribute on this document. For list of available attributes refer to the DocumentConstant class below.

Syntax

public void setAttribute(String attrName, Object attrValue)

Parameters

attrName
The name of the attribute to be set

attrValue
The value to be set

Method

getTempObject

Method description

Retrieves a temporary object associated with this flow.

Syntax

public Object getTempObject(String objectName)

Parameters

objectName
The name of the object requested

Method

setTempObject

Method description

Sets a temporary object associated with this flow.

Syntax

public void setTempObject(String objectName, Object objectValue)

Parameters

objectName
The name of the object to be set

objectValue
The value to be set

Method

getAttachments

Method description

Retrieves the list of attachments for this document.

Syntax

public ListIterator getAttachments()

Parameters

None

Method

addAttachment

Method description

Adds an attachment to this document.

Syntax

public void addAttachment(AttachmentInterface attachment)

Parameters

attachment
The attachment to be added.

Method

getTransportHeaders

Method description

Retrieves the transport headers that were set by the receiver.

Syntax

public ListIterator getTransportHeaders()

Parameters

None

Copyright IBM Corp. 2003, 2004