Package com.uc4.communication.requests

Class MessageList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.MessageList

All Implemented Interfaces:

java.lang.Iterable<MessageListItem>

public class MessageList
extends XMLRequest
implements java.lang.Iterable<MessageListItem>

Find messages in the Automation Engine.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageList.Category	Category of the message.
static class	MessageList.MessageType	Type of the message.
static class	MessageList.Order	Sort order.

Constructor Summary

Constructors

Constructor	Description
MessageList()	Creates a new MessageList request.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected java.lang.String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
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()

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MessageList

public MessageList()

Creates a new MessageList request.

Method Detail

setAdminMessages

public void setAdminMessages(boolean value)

Sets or clears the filter for admin messages.

Parameters:

value - true if admin messages should be included in the result, false if not.

setSecurityMessages

public void setSecurityMessages(boolean value)

Sets or clears the filter for security messages.

Parameters:

value - true if security messages should be included in the result, false if not.

setMaxNumber

public void setMaxNumber(int maxNumber)

Sets the maximum number of the returned rows, the default value is 100.

Parameters:

maxNumber - Limit of returned messages, must be between 1 and 9999

setUser

public void setUser(UC4UserName user)

Sets the filter for a user.

Parameters:

user - User name or null to clear the filter.

setType

public void setType(MessageList.MessageType type)

Sets the filter for the type of the message.

Parameters:

type - Message type, must not be null

setCategory

public void setCategory(MessageList.Category cat)

Sets the filter for the message category.

Parameters:

cat - categroy, must not be null

setTextFilter

public void setTextFilter(int number,
                          java.lang.String insert)

Sets the filter for the message number and insert.

Parameters:

number - Number of the message

insert - Message insert or * for all inserts

setTimeRange

public void setTimeRange(DateTime from,
                         DateTime to)

Sets the filter the message timestamp.

Parameters:

from - From date and time

to - To date and time

setOrder

public void setOrder(MessageList.Order order)

Sets the sort order of the returned messages.

Parameters:

order - Ascending or descending

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

iterator

public java.util.Iterator<MessageListItem> iterator()

Specified by:

iterator in interface java.lang.Iterable<MessageListItem>

size

public int size()

Returns:

Number of returned messages