| Interface | osid.messaging.MailboxQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining mailbox 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 | getAncestorMailboxIdTerms | ||
| Description |
Gets the ancestor mailbox | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorMailboxTerms | ||
| Description |
Gets the ancestor mailbox query terms. | ||
| Return | osid.messaging.MailboxQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantMailboxIdTerms | ||
| Description |
Gets the descendant mailbox | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantMailboxTerms | ||
| Description |
Gets the descendant mailbox query terms. | ||
| Return | osid.messaging.MailboxQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMailboxQueryInspectorRecord | ||
| Description |
Gets the mailbox query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | mailboxRecordType | a mailbox record type |
| Return | osid.messaging.records.MailboxQueryInspectorRecord | the mailbox query inspector record | |
| Errors | NULL_ARGUMENT | mailboxRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(mailboxRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |