com.plumtree.remote.prc.collaboration.discussion
Interface IDiscussionMessageFilter

All Superinterfaces:

IFilter

public interface IDiscussionMessageFilter

extends IFilter

Interface for filters used for querying discussion messages. By default, a discussion message filter will be set to give the largest possible result set. The various setter methods can be used to narrow the kinds of results to return.

Method Summary

DiscussionMessageStatusFilterType	getMessageStatusType() Returns the message status filter type.
DiscussionMessageModeratorFilterType	getModeratorType() Returns the moderator filter type.
DiscussionMessageQueryOrder[]	getQueryOrders() Returns the DiscussionMessageQueryOrder that the results will be returned in.
void	setMessageStatusType(DiscussionMessageStatusFilterType messageStatus) Sets the message status filter type.
void	setModeratorType(DiscussionMessageModeratorFilterType moderatorType) Sets the moderator filter type.
void	setQueryOrders(DiscussionMessageQueryOrder[] queryOrders) Sets the DiscussionMessageQueryOrder that results should be returned in.

Methods inherited from interface com.plumtree.remote.prc.collaboration.query.IFilter

getMaximumResults, isRestoreSecurity, setMaximumResults, setRestoreSecurity

Method Detail

getMessageStatusType

public DiscussionMessageStatusFilterType getMessageStatusType()

Returns the message status filter type.

Returns:

the message status filter

getModeratorType

public DiscussionMessageModeratorFilterType getModeratorType()

Returns the moderator filter type. When set, only messages where the user is a moderator of the discussion will show up.

Returns:

the moderator filter type

getQueryOrders

public DiscussionMessageQueryOrder[] getQueryOrders()

Returns the DiscussionMessageQueryOrder that the results will be returned in.

Returns:

queryField - an array of DiscussionMessageQueryOrders

setMessageStatusType

public void setMessageStatusType(DiscussionMessageStatusFilterType messageStatus)

Sets the message status filter type.

Parameters:

messageStatus - the message status filter; cannot be null

setModeratorType

public void setModeratorType(DiscussionMessageModeratorFilterType moderatorType)

Sets the moderator filter type.

Parameters:

moderatorType - the moderator filter type; cannot be null

setQueryOrders

public void setQueryOrders(DiscussionMessageQueryOrder[] queryOrders)

Sets the DiscussionMessageQueryOrder that results should be returned in.

Parameters:

queryOrders - an array of DiscussionMessageQueryOrder; cannot be null or of 0 length. The rows will be returned as the order of the DiscussionMessageQueryOrder array.