MessageStatusRequestData

public class MessageStatusRequestData extends KVPairData

The MessageStatusRequestData is the data structures representing the parameters set for message status request query. This is the WSDL schema for the message status WS request.

<xs:sequence>
 <xs:element name="partnershipId" type="xs:string" minOccurs="0"/>
 <xs:element name="channelType" type="xs:string" minOccurs="0"/>
 <xs:element name="channelId" type="xs:string" minOccurs="0"/>
 <xs:element name="folderName" type="xs:string" minOccurs="0"/>
 <xs:element name="fileName" type="xs:string" minOccurs="0"/>
 <xs:element name="fromTimestamp" type="xs:dateTime" minOccurs="0"/>
 <xs:element name="toTimestamp" type="xs:dateTime" minOccurs="0"/>
 <xs:element name="numOfRecords" type="xs:integer" minOccurs="0"/>
 <xs:element name="conversationId" type="xs:string" minOccurs="0"/>
 <xs:element name="messageId" type="xs:string" minOccurs="0"/>
 <xs:element name="messageType" type="xs:string" minOccurs="0"/>
 <xs:element name="messageStatus" type="xs:string" minOccurs="0"/>
 <xs:element name="protocol" type="xs:string" minOccurs="0"/>
 <xs:element name="locale" type="xs:string" minOccurs="0"/>
 <xs:element name="levelOfDetails" type="xs:integer" minOccurs="0"/>
 <xs:element name="offset" type="xs:integer" minOccurs="0"/>
</xs:sequence>

Creation Date: 12/3/2007

Author:Twinsen Tsang

Fields

CONFIG_KEY_SET

public static final String[] CONFIG_KEY_SET

This is the configuration key set for XML serialization / de-serialization.

CONFIG_PREFIX

public static final String CONFIG_PREFIX

This is the prefix for serialization / de-serialization.

PARAM_KEY_SET

public static final String[] PARAM_KEY_SET

This is the key set for XML serialization / de-serialization.

PARAM_PREFIX

public static final String PARAM_PREFIX

This is the prefix for serialzation / de-serialization.

Constructors

MessageStatusRequestData

public MessageStatusRequestData()

Default Constructor.

Methods

getChannelId

public String getChannelId()

Gets the channelId value for this MessageStatusRequestData.

Returns:channelId

getChannelType

public String getChannelType()

Gets the channelType value for this MessageStatusRequestData.

Returns:channelType

getConversationId

public String getConversationId()

Gets the conversationId value for this MessageStatusRequestData.

Returns:conversationId

getFileName

public String getFileName()

Gets the fileName value for this MessageStatusRequestData.

Returns:fileName

getFolderName

public String getFolderName()

Gets the folderName value for this MessageStatusRequestData.

Returns:folderName

getFromTimestamp

public String getFromTimestamp()

Gets the fromTimestamp value for this MessageStatusRequestData.

Returns:fromTimestamp

getLevelOfDetails

public BigInteger getLevelOfDetails()

Gets the levelOfDetails value for this MessageStatusRequestData. The default value is 1.

Returns:levelOfDetails

getLocale

public String getLocale()

Gets the locale value for this MessageStatusRequestData.

Returns:locale

getMessageId

public String getMessageId()

Gets the messageId value for this MessageStatusRequestData.

Returns:messageId

getMessageStatus

public String getMessageStatus()

Gets the messageStatus value for this MessageStatusRequestData.

Returns:messageStatus

getMessageType

public String getMessageType()

Gets the messageType value for this MessageStatusRequestData.

Returns:messageType

getNumOfRecords

public BigInteger getNumOfRecords()

Gets the numOfRecords value for this MessageStatusRequestData. The default value is 1.

Returns:numOfRecords

getOffset

public BigInteger getOffset()

Gets the offset value for this MessageStatusRequestData. The default value is 1.

Returns:offset

getPartnershipId

public String getPartnershipId()

Gets the partnershipId value for this MessageStatusRequestData.

Returns:partnershipId

getPassword

public String getPassword()

Get the password for authentication.

getProtocol

public String getProtocol()

Gets the protocol value for this MessageStatusRequestData.

Returns:protocol

getToTimestamp

public String getToTimestamp()

Gets the toTimestamp value for this MessageStatusRequestData.

Returns:toTimestamp

getUsername

public String getUsername()

Get the username for authentication.

Returns:Get the username for authentication.

getWSEndpoint

public String getWSEndpoint()

Get the web service end point for this MessageStatusRequestData.

setChannelId

public void setChannelId(String channelId)

Sets the channelId value for this MessageStatusRequestData.

Parameters:
  • channelId

setChannelType

public void setChannelType(String channelType)

Sets the channelType value for this MessageStatusRequestData.

Parameters:
  • channelType

setConversationId

public void setConversationId(String conversationId)

Sets the conversationId value for this MessageStatusRequestData.

Parameters:
  • conversationId

setFileName

public void setFileName(String fileName)

Sets the fileName value for this MessageStatusRequestData.

Parameters:
  • fileName

setFolderName

public void setFolderName(String folderName)

Sets the folderName value for this MessageStatusRequestData.

Parameters:
  • folderName

setFromTimestamp

public void setFromTimestamp(Calendar fromTimestamp)

Sets the fromTimestamp value for this MessageStatusRequestData.

Parameters:
  • fromTimestamp

setLevelOfDetails

public void setLevelOfDetails(BigInteger levelOfDetails)

Sets the levelOfDetails value for this MessageStatusRequestData.

Parameters:
  • levelOfDetails

setLocale

public void setLocale(String locale)

Sets the locale value for this MessageStatusRequestData.

Parameters:
  • locale

setMessageId

public void setMessageId(String messageId)

Sets the messageId value for this MessageStatusRequestData.

Parameters:
  • messageId

setMessageStatus

public void setMessageStatus(String messageStatus)

Sets the messageStatus value for this MessageStatusRequestData.

Parameters:
  • messageStatus

setMessageType

public void setMessageType(String messageType)

Sets the messageType value for this MessageStatusRequestData.

Parameters:
  • messageType

setNumOfRecords

public void setNumOfRecords(BigInteger numOfRecords)

Sets the numOfRecords value for this MessageStatusRequestData.

Parameters:
  • numOfRecords

setOffset

public void setOffset(BigInteger offset)

Sets the offset value for this MessageStatusRequestData.

Parameters:
  • offset

setPartnershipId

public void setPartnershipId(String partnershipId)

Sets the partnershipId value for this MessageStatusRequestData.

Parameters:
  • partnershipId

setPassword

public void setPassword(String password)

Set the password for authentication.

setProtocol

public void setProtocol(String protocol)

Sets the protocol value for this MessageStatusRequestData.

Parameters:
  • protocol

setToTimestamp

public void setToTimestamp(Calendar toTimestamp)

Sets the toTimestamp value for this MessageStatusRequestData.

Parameters:
  • toTimestamp

setUsername

public void setUsername(String username)

Set the username for authentication.

Parameters:
  • username – The username for authentication.

setWSEndpoint

public void setWSEndpoint(String endpoint)

Set the web service end point for this MessageStatusRequestData.

Parameters:
  • endpoint – The new web service end point.

toString

public String toString()

toString method().