com.ibm.commerce.messaging.outboundservice
Class WCMSRecord

java.lang.Object
  |
  +--com.ibm.commerce.messaging.outboundservice.WCMSRecord
All Implemented Interfaces:
java.io.Serializable

public class WCMSRecord
extends java.lang.Object
implements java.io.Serializable

The WCSRecord class

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright statement.
 
Constructor Summary
WCMSRecord()
          WCMSRecord constructor comment.
 
Method Summary
 void addPart(ContentPart part)
          Adds a new content part to the message.
 java.lang.Object clone()
          Calls super.clone().
 int countParts()
          Returns the number of content parts in the message.
 byte[] getBytes()
          Returns the content of the message body in byte format.
 byte[] getBytes(java.lang.String csClassName, InteractionSpec is)
          Returns the content of the message in byte format according to ConnectionSpec.
 java.lang.Object getContentObject()
          Gets the object
 java.lang.String getContentType()
          Gets contentType
 ContentPart getPart(int index)
          Returns the content part based on the given index.
 java.lang.String getRecordName()
          Gets RecordName.
 java.lang.String getRecordShortDescription()
          Gets RecordShortDescription.
 void read(java.io.InputStream arg1)
          Read an object into an input stream.
 void setBytes(byte[] arg1)
          Sets the bytes of the IByteBuffer.
 void setContentObject(java.lang.Object contentObject)
          Sets the content object
 void setContentType(java.lang.String content_type)
          Sets content type
 void setRecordName(java.lang.String arg1)
          Sets RecordName.
 void setRecordShortDescription(java.lang.String arg1)
          Sets RecordShortDescription.
 void write(java.io.OutputStream arg1)
          Writes the output stream into a byte array.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright statement.
See Also:
Constant Field Values
Constructor Detail

WCMSRecord

public WCMSRecord()
WCMSRecord constructor comment.
Method Detail

addPart

public void addPart(ContentPart part)
Adds a new content part to the message.
Parameters:
part - ContentPart The content part.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Calls super.clone().
Overrides:
clone in class java.lang.Object
Returns:
null
Throws:
java.lang.CloneNotSupportedException - rasied when clone is not supported.

countParts

public int countParts()
Returns the number of content parts in the message.
Returns:
int The number of content parts.

getBytes

public byte[] getBytes()
Returns the content of the message body in byte format.
Returns:
byte[] The message body.

getBytes

public byte[] getBytes(java.lang.String csClassName,
                       InteractionSpec is)
Returns the content of the message in byte format according to ConnectionSpec.
Parameters:
csClassName - The ConnectionSpec object
is - The InteractionSpec object
Returns:
byte[] The whole message.

getContentObject

public java.lang.Object getContentObject()
Gets the object
Returns:
contentObject Returns a Object

getContentType

public java.lang.String getContentType()
Gets contentType
Returns:
contentType Returns the message content type

getPart

public ContentPart getPart(int index)
Returns the content part based on the given index.
Parameters:
index - int The index of the content part to return.
Returns:
ContentPart The content part.

getRecordName

public java.lang.String getRecordName()
Gets RecordName.
Returns:
null.

getRecordShortDescription

public java.lang.String getRecordShortDescription()
Gets RecordShortDescription.
Returns:
null;

read

public void read(java.io.InputStream arg1)
          throws java.io.IOException
Read an object into an input stream.
Parameters:
arg1 - The input stream
Throws:
java.io.IOException - Raised if there is java.IOException

setBytes

public void setBytes(byte[] arg1)
Sets the bytes of the IByteBuffer.
Parameters:
arg1 - byte[] the byte array.

setContentObject

public void setContentObject(java.lang.Object contentObject)
Sets the content object
Parameters:
contentObject - The contentObject is set.

setContentType

public void setContentType(java.lang.String content_type)
Sets content type
Parameters:
content_type - The message content type.

setRecordName

public void setRecordName(java.lang.String arg1)
Sets RecordName. This method is not implemented.
Parameters:
arg1 - The RecordName.

setRecordShortDescription

public void setRecordShortDescription(java.lang.String arg1)
Sets RecordShortDescription. This method is not implemented.
Parameters:
arg1 - The RecordShortDescription.

write

public void write(java.io.OutputStream arg1)
           throws java.io.IOException
Writes the output stream into a byte array.
Parameters:
arg1 - The output stream.
Throws:
IOException. - Raised when there is java.IOException.
java.io.IOException