BusinessDocumentInterface

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

Method

getDocumentUUID

Method description

Retrieves the universally unique ID (UUID) associated with this document

Syntax

public String getDocumentUUID()

Parameters

None

Method

getDocumentParentUUID

Method description

Retrieves the universally unique ID (UUID) associated with this document's parent

Syntax

public String getDocumentParentUUID()

Parameters

None

Method

createFile

Method description

Creates a file. You can call this method if you need to create additional files during the flow of a business document. For example, in the case of a synchronous response received by the sender, the sender can call this method to create a file to store the response.

Syntax

public File createFile()

Parameters

None

Method

getDocument

Method description

Retrieves a file reference for the business document

Syntax

public File getDocument()

Parameters

None

Method

setDocument

Method description

Sets the file reference for the business document

Syntax

public void setDocument(File document)

Parameters

document
The business document

Method

getOriginalFile

Method description

Gets the file reference for the original business document file that created the business document object

Syntax

public File getOriginalFile()

Parameters

None

Method

getDocumentState

Method description

Gets the state of this business document. It can return one of the following states:

Syntax

public String getDocumentState()

Parameters

None

Method

setDocumentState

Method description

Sets the state of the business document object to one of the following states:

Syntax

public String setDocumentState(String state)

Parameters

state
The state 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 the events associated with this business document object

Syntax

public void clearEvents()

Parameters

None

Method

getAttribute

Method description

Gets the named attribute. Used to retrieve information such as packaging name and version, and so forth. For list of available attributes refer to BCGDocumentConstants.

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 BCGDocumentConstants.

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 requested object

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. The method return type is java.util.HashMap.

Syntax

public ListIterator getTransportHeaders()

Parameters

None

Copyright IBM Corp. 2003, 2005