public class MessageList extends XMLRequest implements java.lang.Iterable<MessageListItem>
Modifier and Type | Class and Description |
---|---|
static class |
MessageList.Category
Category of the message.
|
static class |
MessageList.MessageType
Type of the message.
|
static class |
MessageList.Order
Sort order.
|
Constructor and Description |
---|
MessageList()
Creates a new
MessageList request. |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<MessageListItem> |
iterator() |
void |
setAdminMessages(boolean value)
Sets or clears the filter for admin messages.
|
void |
setCategory(MessageList.Category cat)
Sets the filter for the message category.
|
void |
setMaxNumber(int maxNumber)
Sets the maximum number of the returned rows, the default value is 100.
|
void |
setOrder(MessageList.Order order)
Sets the sort order of the returned messages.
|
void |
setSecurityMessages(boolean value)
Sets or clears the filter for security messages.
|
void |
setTextFilter(int number,
java.lang.String insert)
Sets the filter for the message number and insert.
|
void |
setTimeRange(DateTime from,
DateTime to)
Sets the filter the message timestamp.
|
void |
setType(MessageList.MessageType type)
Sets the filter for the type of the message.
|
void |
setUser(UC4UserName user)
Sets the filter for a user.
|
int |
size() |
getMessageBox, getRequestID, handleResponse, send
public void setAdminMessages(boolean value)
value
- true if admin messages should be included in the result, false if not.public void setSecurityMessages(boolean value)
value
- true if security messages should be included in the result, false if not.public void setMaxNumber(int maxNumber)
maxNumber
- Limit of returned messages, must be between 1 and 9999public void setUser(UC4UserName user)
user
- User name or null
to clear the filter.public void setType(MessageList.MessageType type)
type
- Message type, must not be nullpublic void setCategory(MessageList.Category cat)
cat
- categroy, must not be nullpublic void setTextFilter(int number, java.lang.String insert)
number
- Number of the messageinsert
- Message insert or * for all insertspublic void setTimeRange(DateTime from, DateTime to)
from
- From date and timeto
- To date and timepublic void setOrder(MessageList.Order order)
order
- Ascending or descendingpublic java.util.Iterator<MessageListItem> iterator()
iterator
in interface java.lang.Iterable<MessageListItem>
public int size()