All Examples  XML Examples  BizTalk Example

Interface examples.xml.biztalk.OutgoingMessage

public interface OutgoingMessage

Author:

Copyright (c) 2000 by BEA Systems, Inc. All Rights Reserved.

getBodyAsXML()

returns XML doc of the payload

getDocDesc()

returns a description of the document

getDocName()

returns Document name

getFromAddress()

returns the return address for this doc

getFromHandle()

returns senders handle

getFromProcess()

returns sender's process value

getFromReferenceID()

returns senders reference ID

getMsgID()

returns document's message ID

getMsgSubject()

returns text description of document

getNameSpace()

returns namespace designation

getTimeStamp()

returns time message created/sent

getToAddress()

returns recipient's address

getToHandle()

returns recipient's handle

getToProcess()

returns recipient's process

getToReferenceID()

returns recipient's reference ID

setBodyAsObject(Object)

convert object to XML fragment to use as document body

setBodyAsXML(String)

Provides an XML documwent fragment representing the document body of the response.

setDocDesc(String)

Provides a descripion of the document

setDocName(String)

Sets the document name.

setFromAddress(String)

Sets address of sender.

setFromHandle(String)

Sets state info set for the sender.

setFromProcess(String)

Sets state info set for the sender.

setFromReferenceID(String)

Sets the reference ID of sender.

setMsgID(String)

Sets the message ID for the message.

setMsgSubject(String)

Sets the message subject for the document.

setNameSpace()

Sets the name space associated with the payload.

setTimeStamp()

Sets the sending timestamp of the message to the time of the method call.

setToAddress(String)

Sets address of receiver.

setToHandle(String)

Sets state info set for the recipient.

setToProcess(String)

Sets state info for the recipient.

setToReferenceID(String)

Sets the reference ID for the recipient.

setType(String)

Sets the document type for this document.

toString()

returns Biztalk XML string representation of this object

 public abstract String getNameSpace()

returns namespace designation

Returns:

namespace of this document

 public abstract String getFromAddress()

returns the return address for this doc

Returns:

senders address

 public abstract String getFromReferenceID()

returns senders reference ID

Returns:

senders reference ID

 public abstract String getFromProcess()

returns sender's process value

Returns:

sender's process value

 public abstract String getFromHandle()

returns senders handle

Returns:

senders handle

 public abstract String getToAddress()

returns recipient's address

Returns:

recipient's address

 public abstract String getToReferenceID()

returns recipient's reference ID

Returns:

recipient's reference ID

 public abstract String getToProcess()

returns recipient's process

Returns:

recipient's process

 public abstract String getToHandle()

returns recipient's handle

Returns:

recipient's handle

 public abstract String getBodyAsXML()

returns XML doc of the payload

Returns:

XML doc of the payload

 public abstract String getDocName()

returns Document name

Returns:

Document name

 public abstract String getDocDesc()

returns a description of the document

Returns:

a description of the document

 public abstract String getMsgID()

returns document's message ID

Returns:

document's message ID

 public abstract String getMsgSubject()

returns text description of document

Returns:

text description of document

 public abstract String getTimeStamp()

returns time message created/sent

Returns:

time message created/sent

 public abstract void setType(String type)

Sets the document type for this document.

Parameters:

type - The name to be used as a document type.

 public abstract void setNameSpace()

Sets the name space associated with the payload. The name space identifies the schema associated with the payload (body) of the document.

Parameters:

space - Envelope name space.

 public abstract void setFromAddress(String id)

Sets address of sender. The address is a Universal Resource Identifier (URI) describing the logical address of the sending or receiving system. It is resolved to a transport-specific system address by the BizTalk server. This transport-specific address is transparent to the applications.

Parameters:

id - URI of sender.

 public abstract void setFromReferenceID(String id)

Sets the reference ID of sender. A reference ID is a unique identifier or cookie used to reference which interchange this document is associated with. The reference ID for the document interchange would typically be unique for an instance of a particular business process.

Parameters:

id - Sender reference ID.

 public abstract void setFromProcess(String process)

Sets state info set for the sender. Process may be used to again refine the state of the interchange, by identifying the user account, process, or security context where the document originated, or is intended to be sent. This is a further refinement of the handle.

Parameters:

process - Process value.

 public abstract void setFromHandle(String handle)

Sets state info set for the sender. Handle provides additional handling or processing information that may be required by the application. An example would be the handle for a functional module or step within a business process. The handle is used as a further refinement of the reference ID.

Parameters:

handle - Handle value.

 public abstract void setToAddress(String path)

Sets address of receiver. The address is a Universal Resource Identifier (URI) describing the logical address of the sending or receiving system. It is resolved to a transport-specific system address by the BizTalk server. This transport-specific address is transparent to the applications.

Parameters:

path - URI of message recipient.

 public abstract void setToReferenceID(String id)

Sets the reference ID for the recipient. A reference ID is a unique identifier or cookie used to reference which interchange this document is associated with. The reference ID for the document interchange would typically be unique for an instance of a particular business process.

Parameters:

id - Recipient reference ID.

 public abstract void setToProcess(String process)

Sets state info for the recipient. Process may be used to again refine the state of the interchange, by identifying the user account, process, or security context where the document originated, or is intended to be sent. This is a further refinement of the handle.

Parameters:

process - Process value.

 public abstract void setToHandle(String handle)

Sets state info set for the recipient. Handle provides additional handling or processing information that may be required by the application. An example would be the handle for a functional module or step within a business process. The handle is used as a further refinement of the reference ID.

Parameters:

handle - Handle value.

 public abstract void setBodyAsXML(String body)

Provides an XML documwent fragment representing the document body of the response.

Parameters:

body - XML fragment for document body.

 public abstract String toString()

returns Biztalk XML string representation of this object

Returns:

XML string

Overrides:

toString in class Object

 public abstract void setBodyAsObject(Object obj)

convert object to XML fragment to use as document body

Parameters:

obj - Object to convert to XML

 public abstract void setMsgSubject(String subject)

Sets the message subject for the document.

Parameters:

subject - description of the message

 public abstract void setDocName(String doc)

Sets the document name.

Parameters:

doc - a descriptive name for the document.

 public abstract void setDocDesc(String desc)

Provides a descripion of the document

Parameters:

desc - a descriptive statement about the payload.

 public abstract void setMsgID(String msgid)

Sets the message ID for the message. It may be used for logging, tracking, error handling, or other message processing/reprocessing requirements. Generation of the message numbers or GUIDs is customer or implementation specific at this time. This value may be generated either by the business application/adapter, or by the BizTalk server transmitting the message

Parameters:

msgid - a message identifier.

 public abstract void setTimeStamp()

Sets the sending timestamp of the message to the time of the method call. This is formatted according to ISO 8601 format.

Parameters:

time - ISO 8601 time stamp value

All Examples  XML Examples  BizTalk Example