com.ibm.commerce.messaging.outboundservice

Class WCMSRecord

  • java.lang.Object
    • com.ibm.commerce.messaging.outboundservice.WCMSRecord
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, javax.resource.cci.Record, javax.resource.cci.Streamable


    public class WCMSRecord
    extends java.lang.Object
    implements javax.resource.cci.Record, javax.resource.cci.Streamable, java.io.Serializable
    The WCMSRecord class
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright statement.
    • Constructor Summary

      Constructors 
      Constructor and Description
      WCMSRecord()
      The WCMSRecord constructor calls its superclass constructor and performs initialization of the record.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addPart(com.ibm.commerce.messaging.outboundservice.ContentPart part)
      This method adds a new content part to the message.
      java.lang.Object clone()
      This method calls super.clone().
      int countParts()
      This method returns the number of content parts in the message.
      byte[] getBytes()
      This message returns the content of the message body in byte format.
      byte[] getBytes(java.lang.String csClassName, javax.resource.cci.InteractionSpec is)
      This method returns the content of the message in byte format according to the ConnectionSpec object.
      java.lang.Object getContentObject()
      This method gets a content object.
      java.lang.String getContentType()
      This method gets a content type.
      com.ibm.commerce.messaging.outboundservice.ContentPart getPart(int index)
      This method returns the content part based on the given index.
      java.lang.String getRecordName()
      This method gets the RecordName.
      java.lang.String getRecordShortDescription()
      This method gets the RecordShortDescription.
      void read(java.io.InputStream arg1)
      This method reads an object into an input stream.
      void setBytes(byte[] arg1)
      This method sets the bytes of the IByteBuffer.
      void setContentObject(java.lang.Object newContentObj)
      This method sets the content object.
      void setContentType(java.lang.String content_type)
      This method sets the content type.
      void setRecordName(java.lang.String arg1)
      This method sets the record name.
      void setRecordShortDescription(java.lang.String arg1)
      This method sets the RecordShortDescription.
      void write(java.io.OutputStream arg1)
      This method writes the output stream into a byte array.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface javax.resource.cci.Record

        equals, hashCode
    • Field Detail

      • COPYRIGHT

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

      • WCMSRecord

        public WCMSRecord()
        The WCMSRecord constructor calls its superclass constructor and performs initialization of the record.
    • Method Detail

      • addPart

        public void addPart(com.ibm.commerce.messaging.outboundservice.ContentPart part)
        This method adds a new content part to the message.
        Parameters:
        part - The content part to add.
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        This method calls super.clone().
        Specified by:
        clone in interface javax.resource.cci.Record
        Overrides:
        clone in class java.lang.Object
        Returns:
        This method always returns null.
        Throws:
        java.lang.CloneNotSupportedException - Raised when clone is not supported.
      • countParts

        public int countParts()
        This method returns the number of content parts in the message.
        Returns:
        int The number of content parts.
      • getBytes

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

        public byte[] getBytes(java.lang.String csClassName,
                               javax.resource.cci.InteractionSpec is)
        This method returns the content of the message in byte format according to the ConnectionSpec object.
        Parameters:
        csClassName - The ConnectionSpec object
        is - The InteractionSpec object
        Returns:
        byte[] The whole message in byte format.
      • getContentObject

        public java.lang.Object getContentObject()
        This method gets a content object.
        Returns:
        contentObject The WCMSRecord content object
      • getContentType

        public java.lang.String getContentType()
        This method gets a content type.
        Returns:
        contentType The message content type
      • getPart

        public com.ibm.commerce.messaging.outboundservice.ContentPart getPart(int index)
        This method returns the content part based on the given index.
        Parameters:
        index - The Integer index of the content part to return.
        Returns:
        ContentPart The content part.
      • getRecordName

        public java.lang.String getRecordName()
        This method gets the RecordName.
        Specified by:
        getRecordName in interface javax.resource.cci.Record
        Returns:
        This method always returns null.
      • getRecordShortDescription

        public java.lang.String getRecordShortDescription()
        This method gets the RecordShortDescription.
        Specified by:
        getRecordShortDescription in interface javax.resource.cci.Record
        Returns:
        This method always returns null;
      • read

        public void read(java.io.InputStream arg1)
                  throws java.io.IOException
        This method reads an object into an input stream.
        Specified by:
        read in interface javax.resource.cci.Streamable
        Parameters:
        arg1 - The input stream
        Throws:
        java.io.IOException - Raised if there is java.IOException
      • setBytes

        public void setBytes(byte[] arg1)
        This method sets the bytes of the IByteBuffer.
        Parameters:
        arg1 - byte[] the byte array.
      • setContentObject

        public void setContentObject(java.lang.Object newContentObj)
        This method sets the content object.
        Parameters:
        newContentObj - The content object to set.
      • setContentType

        public void setContentType(java.lang.String content_type)
        This method sets the content type.
        Parameters:
        content_type - The message content type.
      • setRecordName

        public void setRecordName(java.lang.String arg1)
        This method sets the record name. This method is not implemented.
        Specified by:
        setRecordName in interface javax.resource.cci.Record
        Parameters:
        arg1 - The RecordName.
      • setRecordShortDescription

        public void setRecordShortDescription(java.lang.String arg1)
        This method sets the RecordShortDescription. This method is not implemented.
        Specified by:
        setRecordShortDescription in interface javax.resource.cci.Record
        Parameters:
        arg1 - The RecordShortDescription.
      • write

        public void write(java.io.OutputStream arg1)
                   throws java.io.IOException
        This method writes the output stream into a byte array.
        Specified by:
        write in interface javax.resource.cci.Streamable
        Parameters:
        arg1 - The output stream.
        Throws:
        java.io.IOException - Raised when there is java.IOException.