OSID Specifications
messaging package
Version 3.0.0
messaging package
Version 3.0.0
| Interface | osid.messaging.ReceiptQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Used By | osid.messaging.MessageQueryInspector | ||
| Description |
This is the query inspector for examining receipt queries. | ||
| Method | getMessageIdTerms | ||
| Description |
Gets the message | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMessageTerms | ||
| Description |
Gets the message query terms. | ||
| Return | osid.messaging.MessageQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceivedTimeTerms | ||
| Description |
Gets the received time query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceivingAgentIdTerms | ||
| Description |
Gets the receiving agent | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceivingAgentTerms | ||
| Description |
Gets the receiving agent query terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipientIdTerms | ||
| Description |
Gets the recipient | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipientTerms | ||
| Description |
Gets the recipient query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMailboxIdTerms | ||
| Description |
Gets the mailbox | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMailboxTerms | ||
| Description |
Gets the mailbox query terms. | ||
| Return | osid.messaging.MailboxQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceiptQueryInspectorRecord | ||
| Description |
Gets the receipt query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | receiptRecordType | a receipt record type |
| Return | osid.messaging.records.ReceiptQueryInspectorRecord | the receipt query inspector 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. | |