public interface MessageSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
MessageSearchOrderRecord |
getMessageSearchOrderRecord(Type messageRecordType)
Gets the message search order record corresponding to the given
message record
Type. |
ReceiptSearchOrder |
getReceiptSearchOrder()
Gets the receipt order.
|
ResourceSearchOrder |
getSenderSearchOrder()
Gets the resource order.
|
AgentSearchOrder |
getSendingAgentSearchOrder()
Gets the sending agent order.
|
void |
orderByDeliveryTime(SearchOrderStyle style)
Specifies a preference for ordering messages by the delivery time.
|
void |
orderByReceipt(SearchOrderStyle style)
Specifies a preference for ordering messages by receipt.
|
void |
orderByReceivedTime(SearchOrderStyle style)
Specifies a preference for ordering messages by the sent time.
|
void |
orderBySender(SearchOrderStyle style)
Specifies a preference for ordering messages by sender.
|
void |
orderBySendingAgent(SearchOrderStyle style)
Specifies a preference for ordering messages by sending agent.
|
void |
orderBySent(SearchOrderStyle style)
Specifies a preference for ordering messages by sent.
|
void |
orderBySentTime(SearchOrderStyle style)
Specifies a preference for ordering messages by the sent time.
|
void |
orderBySubjectLine(SearchOrderStyle style)
Specifies a preference for ordering messages by subject line.
|
void |
orderByText(SearchOrderStyle style)
Specifies a preference for ordering messages by text.
|
boolean |
supportsReceiptSearchOrder()
Tests if a receipt order is available.
|
boolean |
supportsSenderSearchOrder()
Tests if a resource order is available.
|
boolean |
supportsSendingAgentSearchOrder()
Tests if an agent order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderBySubjectLine(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByText(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySentTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySender(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSenderSearchOrder()
true
if a resource order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getSenderSearchOrder()
UnimplementedException
-
supportsSenderSearchOrder()
is false
optional
- This method must be implemented if
supportsSenderSearchOrder()
is true.
void orderBySendingAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSendingAgentSearchOrder()
true
if an agent order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getSendingAgentSearchOrder()
UnimplementedException
-
supportsSendingAgentSearchOrder()
is false
optional
- This method must be implemented if
supportsSendingAgentSearchOrder()
is true.
void orderByReceivedTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDeliveryTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByReceipt(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsReceiptSearchOrder()
true
if a receipt order is available,
false
otherwisemandatory
- This method must be implemented. ReceiptSearchOrder getReceiptSearchOrder()
UnimplementedException
-
supportsReceiptSearchOrder()
is false
optional
- This method must be implemented if
supportsReceipttSearchOrder()
is true.
MessageSearchOrderRecord getMessageSearchOrderRecord(Type messageRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.messageRecordType
- a message record typeNullArgumentException
- messageRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(messageRecordType)
is false
mandatory
- This method must be implemented.