Interface | osid.messaging.ReceiptQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching message receipts. Each
method specifies an | ||
Method | matchMessageId | ||
Description |
Sets the message | ||
Parameters | osid.id.Id | messageId | a message Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | messageId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMessageIdTerms | ||
Description |
Clears the message | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMessageQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a message query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMessageQuery | ||
Description |
Gets the query for a message. Multiple retrievals
produce a nested | ||
Return | osid.messaging.MessageQuery | the message query | |
Errors | UNIMPLEMENTED | supportsMessageQuery() is false | |
Compliance | optional | This method must be implemented if supportsMessageQuery() is
true. | |
Method | clearMessageTerms | ||
Description |
Clears the message terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchReceivedTime | ||
Description |
Matches messages whose received time is between the supplied range inclusive. | ||
Parameters | osid.calendaring.DateTime | startTime | start time |
osid.calendaring.DateTime | endTime | end time | |
boolean | match | true if for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | startTime is greater than endTime | |
NULL_ARGUMENT | startTime or endTime is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearReceivedTimeTerms | ||
Description |
Clears the received time terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchReceivingAgentId | ||
Description |
Matches the endpoint recipient of the message. | ||
Parameters | osid.id.Id | agentId | Id to match |
boolean | match | true if for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearReceivingAgentIdTerms | ||
Description |
Clears the receiving agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsReceivingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getReceivingAgentQuery | ||
Description |
Gets the query for the receiving agent. | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsReceivingQuery() is false | |
Compliance | optional | This method must be implemented if supportsReceivingQuery()
is true. | |
Method | clearReceivingAgentTerms | ||
Description |
Clears the receiving agent terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRecipientId | ||
Description |
Matches any recipient of the message. | ||
Parameters | osid.id.Id | resourceId | Id to match |
boolean | match | true if for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRecipientIdTerms | ||
Description |
Clears the recipient | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipientQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipientQuery | ||
Description |
Gets the query for a recipient resource. | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsRecipientQuery() is false | |
Compliance | optional | This method must be implemented if supportsRecipientQuery()
is true. | |
Method | clearRecipientTerms | ||
Description |
Clears the recipient terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMailboxId | ||
Description |
Sets the mailbox | ||
Parameters | osid.id.Id | mailboxId | the mailbox Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | mailboxId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMailboxIdTerms | ||
Description |
Clears the mailbox | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMailboxQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a mailbox query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMailboxQuery | ||
Description |
Gets the query for a mailbox. Multiple retrievals
produce a nested | ||
Return | osid.messaging.MailboxQuery | the mailbox query | |
Errors | UNIMPLEMENTED | supportsMailboxQuery() is false | |
Compliance | optional | This method must be implemented if supportsMailboxQuery() is
true. | |
Method | clearMailboxTerms | ||
Description |
Clears the mailbox terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptQueryRecord | ||
Description |
Gets the receipt query record corresponding to the
given | ||
Parameters | osid.type.Type | receiptRecordType | a receipt record type |
Return | osid.messaging.records.ReceiptQueryRecord | the recript query record | |
Errors | NULL_ARGUMENT | receiptRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(receiptRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |