MessageLookupParams (eC-Messenger Remote API v1.82)

Object
- MessageLookupParams

All Implemented Interfaces:

Serializable
```
public class MessageLookupParams
extends Object
implements Serializable
```
Helper class wrapping a collection of parameters used to express search criteria for message lookup.

Author:

jfischer

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MessageLookupParams()
Creates new, empty MessageLookupParams.

Constructors
Constructor and Description
`MessageLookupParams()` Creates new, empty `MessageLookupParams`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getBatchOffset()`
`Integer`	`getBatchSize()`
`String`	`getGroupId()`
`String`	`getGroupName()`
`Date`	`getMessageCreationDateFrom()`
`Date`	`getMessageCreationDateTo()`
`String`	`getMessageId()`
`String`	`getMessageName()`
`Date`	`getMessageSendDateFrom()`
`Date`	`getMessageSendDateTo()`
`String`	`getMessageStatus()`
`String`	`getMessageSubject()`
`String`	`getMessageType()`
`String`	`getSortProperty()`
`Boolean`	`isSortAscending()`
`void`	`setBatchOffset(Integer batchOffset)` Sets the batch offset for the returned data.
`void`	`setBatchSize(Integer batchSize)` Sets the batch size for the returned data.
`void`	`setGroupId(String groupId)` Sets the group id search criterion.
`void`	`setGroupName(String groupName)` Sets the group name search criterion.
`void`	`setMessageCreationDateFrom(Date messageCreationDateFrom)` Sets the start date of the time interval for message lookup by creation date.
`void`	`setMessageCreationDateTo(Date messageCreationDateTo)` Sets the end date of the time interval for message lookup by creation date.
`void`	`setMessageId(String messageId)` Sets the message id search criterion.
`void`	`setMessageName(String messageName)` Sets the message name search criterion.
`void`	`setMessageSendDateFrom(Date messageSendDateFrom)` Sets the start date of the time interval for message lookup by send date.
`void`	`setMessageSendDateTo(Date messageSendDateTo)` Sets the end date of the time interval for message lookup by send date.
`void`	`setMessageStatus(String messageStatus)` Sets the message status search criterion.
`void`	`setMessageSubject(String messageSubject)` Sets the message subject search criterion.
`void`	`setMessageType(String messageType)` Sets the message type search criterion.
`void`	`setSortAscending(Boolean sortAscending)` Sets the sort direction of the result.
`void`	`setSortProperty(String sortProperty)` Sets the sort column name for the result.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MessageLookupParams
```
public MessageLookupParams()
```
    Creates new, empty MessageLookupParams.
- Method Detail
  - getMessageId
```
public String getMessageId()
```
    Returns:
    
    thr message id search criterion.
    
    See Also:
    
    setMessageId(String)
  - setMessageId
```
public void setMessageId(String messageId)
```
    Sets the message id search criterion. This property is used to lookup a particular message by id.
    
    Parameters:
    
    messageId - the message id.
  - getMessageType
```
public String getMessageType()
```
    Returns:
    
    the message type search criterion.
    
    See Also:
    
    setMessageType(String)
  - setMessageType
```
public void setMessageType(String messageType)
```
    Sets the message type search criterion. One of:
    - NORMAL - regular group message
    - SINGLE - prepared message
    - TEST - test message (from test sendout)
    - SUPER - super message
    - SUB - sub message
    - SPLIT_MAIN - main message from spilt sendout
    - SPLIT_TEST - test message from split sendout
    Parameters:
    
    messageType - the message type.
  - getMessageStatus
```
public String getMessageStatus()
```
    Returns:
    
    the message status search criterion.
    
    See Also:
    
    setMessageStatus(String)
  - setMessageStatus
```
public void setMessageStatus(String messageStatus)
```
    Sets the message status search criterion. One of:
    - PROCESSING - message currently being send out
    - SENT - sent message
    - MODERATED - message waiting for moderation
    - SCHEDULED - scheduled message
    - READY - prepared message
    Parameters:
    
    messageStatus -
  - getMessageName
```
public String getMessageName()
```
    Returns:
    
    the message name search criterion.
    
    See Also:
    
    setMessageName(String)
  - setMessageName
```
public void setMessageName(String messageName)
```
    Sets the message name search criterion. A substring search is performed for the message name.
    
    Parameters:
    
    messageName - the message name, or a part of the name.
  - getMessageSubject
```
public String getMessageSubject()
```
    Returns:
    
    the message subject search criterion.
    
    See Also:
    
    setMessageSubject(String)
  - setMessageSubject
```
public void setMessageSubject(String messageSubject)
```
    Sets the message subject search criterion. A substring search is performed for the message subject.
    
    Parameters:
    
    messageSubject - the message subject, or a part of the subject.
  - getGroupId
```
public String getGroupId()
```
    Returns:
    
    the group id search criterion.
    
    See Also:
    
    setGroupId(String)
  - setGroupId
```
public void setGroupId(String groupId)
```
    Sets the group id search criterion. Limits the lookup to messages of the group identified through the given id.
    
    Parameters:
    
    groupId - the group id.
    
    See Also:
    
    setGroupName(String)
  - getGroupName
```
public String getGroupName()
```
    Returns:
    
    the group name search criterion.
    
    See Also:
    
    setGroupName(String)
  - setGroupName
```
public void setGroupName(String groupName)
```
    Sets the group name search criterion. A substring search is performed for the group name.
    
    Parameters:
    
    groupName - the group name, or a part of the name.
    
    See Also:
    
    setGroupId(String)
  - getMessageSendDateFrom
```
public Date getMessageSendDateFrom()
```
    Returns:
    
    the start date of the time interval.
    
    See Also:
    
    setMessageSendDateFrom(Date)
  - setMessageSendDateFrom
```
public void setMessageSendDateFrom(Date messageSendDateFrom)
```
    Sets the start date of the time interval for message lookup by send date.
    
    Parameters:
    
    messageSendDateFrom - the start date of the date range.
    
    See Also:
    
    setMessageSendDateTo(Date)
  - getMessageSendDateTo
```
public Date getMessageSendDateTo()
```
    Returns:
    
    the end date of the time interval.
    
    See Also:
    
    setMessageSendDateTo(Date)
  - setMessageSendDateTo
```
public void setMessageSendDateTo(Date messageSendDateTo)
```
    Sets the end date of the time interval for message lookup by send date.
    
    Parameters:
    
    messageSendDateTo - the end date of the date range.
    
    See Also:
    
    setMessageSendDateFrom(Date)
  - getMessageCreationDateFrom
```
public Date getMessageCreationDateFrom()
```
    Returns:
    
    the start date of the time interval.
    
    See Also:
    
    setMessageCreationDateFrom(Date)
  - setMessageCreationDateFrom
```
public void setMessageCreationDateFrom(Date messageCreationDateFrom)
```
    Sets the start date of the time interval for message lookup by creation date.
    
    Parameters:
    
    messageCreationDateFrom - the start date of the date range.
    
    See Also:
    
    setMessageCreationDateTo(Date)
  - getMessageCreationDateTo
```
public Date getMessageCreationDateTo()
```
    Returns:
    
    the end date of the time interval.
    
    See Also:
    
    setMessageCreationDateTo(Date)
  - setMessageCreationDateTo
```
public void setMessageCreationDateTo(Date messageCreationDateTo)
```
    Sets the end date of the time interval for message lookup by creation date.
    
    Parameters:
    
    messageCreationDateTo - the end date of the date range.
    
    See Also:
    
    setMessageCreationDateFrom(Date)
  - getBatchSize
```
public Integer getBatchSize()
```
    Returns:
    
    the batch size.
    
    See Also:
    
    setBatchSize(Integer)
  - setBatchSize
```
public void setBatchSize(Integer batchSize)
```
    Sets the batch size for the returned data. The maximum value for this parameter is 250.
    
    Parameters:
    
    batchSize - the batch size.
  - getBatchOffset
```
public Integer getBatchOffset()
```
    Returns:
    
    the batch offset.
    
    See Also:
    
    setBatchOffset(Integer)
  - setBatchOffset
```
public void setBatchOffset(Integer batchOffset)
```
    Sets the batch offset for the returned data. Must be a positive number.
    
    Parameters:
    
    batchOffset - the batch offset.
  - getSortProperty
```
public String getSortProperty()
```
    Returns:
    
    the sort property name.
    
    See Also:
    
    setSortProperty(String)
  - setSortProperty
```
public void setSortProperty(String sortProperty)
```
    Sets the sort column name for the result. One of:
    - message.PK
    - message.Name
    - message.Subject
    - message.Type
    - message.Status
    - message.CreationDate
    - message.Size
    - send_date
    - message.RecipientCount
    - message.ActualRecipientCount
    - message.BounceCount
    - message.ReaderCount
    - message.UniqueClickCount
    - message.ForwardedCount
    - message.UnsubscriptionCount
    - group.PK
    - group.Name
    Parameters:
    
    sortProperty - the sort property name.
  - isSortAscending
```
public Boolean isSortAscending()
```
    Returns:
    
    the sort ascending flag.
    
    See Also:
    
    setSortAscending(Boolean)
  - setSortAscending
```
public void setSortAscending(Boolean sortAscending)
```
    Sets the sort direction of the result. If set to true, the returned result is sorted in ascending order, otherwise in descending order.
    
    Parameters:
    
    sortAscending - the sort ascending flag.

Class MessageLookupParams

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

MessageLookupParams

Method Detail

getMessageId

setMessageId

getMessageType

setMessageType

getMessageStatus

setMessageStatus

getMessageName

setMessageName

getMessageSubject

setMessageSubject

getGroupId

setGroupId

getGroupName

setGroupName

getMessageSendDateFrom

setMessageSendDateFrom

getMessageSendDateTo

setMessageSendDateTo

getMessageCreationDateFrom

setMessageCreationDateFrom

getMessageCreationDateTo

setMessageCreationDateTo

getBatchSize

setBatchSize

getBatchOffset

setBatchOffset

getSortProperty

setSortProperty

isSortAscending

setSortAscending