getDocumentUUID
Retrieves the universally unique ID (UUID) associated with this document
public String getDocumentUUID()
None
getDocumentParentUUID
Retrieves the universally unique ID (UUID) associated with this document's parent
public String getDocumentParentUUID()
None
createFile
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.
public File createFile()
None
getDocument
Retrieves a file reference for the business document
public File getDocument()
None
setDocument
Sets the file reference for the business document
public void setDocument(File document)
getOriginalFile
Gets the file reference for the original business document file that created the business document object
public File getOriginalFile()
None
getDocumentState
Gets the state of this business document. It can return one of the following states:
public String getDocumentState()
None
setDocumentState
Sets the state of the business document object to one of the following states:
public String setDocumentState(String state)
addEvents
Adds events to be associated with this document. These events will be displayed in the event viewer and the document viewer
public void addEvents(EventInfo[] events)
getEvents
Retrieves the array of EventInfo objects associated with this document
public EventInfo[] getEvents()
None
clearEvents
Clears the events associated with this business document object
public void clearEvents()
None
getAttribute
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.
public Object getAttribute(String attrName)
setAttribute
Sets the named attribute on this document. For list of available attributes refer to BCGDocumentConstants.
public void setAttribute(String attrName, Object attrValue)
getTempObject
Retrieves a temporary object associated with this flow
public Object getTempObject(String objectName)
setTempObject
Sets a temporary object associated with this flow
public void setTempObject(String objectName, Object objectValue)
getAttachments
Retrieves the list of attachments for this document
public ListIterator getAttachments()
None
addAttachment
Adds an attachment to this document
public void addAttachment(AttachmentInterface attachment)
getTransportHeaders
Retrieves the transport headers that were set by the receiver. The method return type is java.util.HashMap.
public ListIterator getTransportHeaders()
None