ReceiverDocumentInterface

Represents the document. This object will be created by the receiver before it invokes the Framework. It has the following methods:

Method

getTempObject

Method description

Retrieves temporary information for passing among handlers

Syntax

public Object getTempObject(String objectName)

Parameters

objectName
The name of the object holding the temporary information

Method

setTempObject

Method description

Sets temporary information for passing among handlers

Syntax

public void setTempObject(String objectName, Object objectValue)

Parameters

objectName
The name of the object holding the temporary information
objectValue
The temporary information

Method

getAttribute

Method description

Retrieves a console-defined attribute

Syntax

public Object getAttribute(String name)

Parameters

name
The name of the attribute

Method

setAttribute

Method description

Sets console-defined attribute

Syntax

public void setAttribute(String name, Object value)

Parameters

name
The name of the attribute
value
The value to be set on the attribute

Method

getAttributes

Method description

Retrieves the entire attribute map

Syntax

public Map getAttributes()

Parameters

None

Method

getTransportHeaders

Method description

Retrieves transport headers

Syntax

public HashMap getTransportHeaders()

Parameters

None

Method

setTransportHeaders

Method description

Sets transport headers

Syntax

public setTransportHeaders(Hashmap transportHeaders)

Parameters

transportHeaders
The transport headers

Method

getDocument

Method description

Retrieves the document content as a file

Syntax

public File getDocument()

Parameters

None

Method

setDocument

Method description

Sets the document content in the file object

Syntax

public void setDocument(File document)

Parameters

document
The name of the file object that contains the document

Method

getDocumentUUID

Method description

Gets the unique reference ID for this document. Every document is assigned a unique ID.

Syntax

String getDocumentUUID()

Parameters

None

Copyright IBM Corp. 2003, 2005