OSID - osid.messaging.MailboxQuery Service Interface Definition

Interface	osid.messaging.MailboxQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.messaging.MailboxQuery`
	`osid.messaging.MailboxQuerySession`
	`osid.messaging.MailboxSearchSession`
	`osid.messaging.MessageQuery`
	`osid.messaging.ReceiptQuery`
Description	This is the query for searching mailboxes. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchMessageId
Description	Sets the message `Id` for this query.
Parameters	`osid.id.Id`	`messageId`	a message `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageQuery
Description	Tests if a `MessageQuery` is available.
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 `OR` term.
Return	`osid.messaging.MessageQuery`		the message query
Errors	UNIMPLEMENTED		`supportsMessageQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageQuery()` is `true` .
Method	matchAnyMessage
Description	Matches mailboxes with any messages.
Parameters	`boolean`	`match`	`true` to match mailboxes with any messages, `false` to match mailboxes with no messages
Compliance	`mandatory`		This method must be implemented.
Method	clearMessageTerms
Description	Clears the message terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorMailboxId
Description	Sets the mailbox `Id` for this query to match mailboxes that have the specified mailbox as an ancestor.
Parameters	`osid.id.Id`	`mailboxId`	a mailbox `Id`
Parameters	`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	clearAncestorMailboxIdTerms
Description	Clears the ancestor mailbox `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorMailboxQuery
Description	Tests if a `MailboxQuery` is available.
Return	`boolean`		`true` if a mailbox query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorMailboxQuery
Description	Gets the query for a mailbox. Multiple retrievals produce a nested `OR` term.
Return	`osid.messaging.MailboxQuery`		the mailbox query
Errors	UNIMPLEMENTED		`supportsAncestorMailboxQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorMailboxQuery()` is `true` .
Method	matchAnyAncestorMailbox
Description	Matches mailboxes with any ancestor.
Parameters	`boolean`	`match`	`true` to match mailboxes with any ancestor, `false` to match root mailboxes
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorMailboxTerms
Description	Clears the ancestor mailbox terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantMailboxId
Description	Sets the mailbox `Id` for this query to match mailboxes that have the specified mailbox as a descendant.
Parameters	`osid.id.Id`	`mailboxId`	a mailbox `Id`
Parameters	`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	clearDescendantMailboxIdTerms
Description	Clears the descendant mailbox `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantMailboxQuery
Description	Tests if a `MailboxQuery` is available.
Return	`boolean`		`true` if a mailbox query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantMailboxQuery
Description	Gets the query for a mailbox. Multiple retrievals produce a nested `OR` term.
Return	`osid.messaging.MailboxQuery`		the mailbox query
Errors	UNIMPLEMENTED		`supportsDescendantMailboxQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantMailboxQuery()` is `true` .
Method	matchAnyDescendantMailbox
Description	Matches mailboxes with any descendant.
Parameters	`boolean`	`match`	`true` to match mailboxes with any descendant, `false` to match leaf mailboxes
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantMailboxTerms
Description	Clears the descendant mailbox terms.
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxQueryRecord
Description	Gets the mailbox query record corresponding to the given `Mailbox` record `Type` .Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`mailboxRecordType`	a mailbox record type
Return	`osid.messaging.records.MailboxQueryRecord`		the mailbox query record
Errors	NULL_ARGUMENT		`mailboxRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(mailboxRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.