OSID - osid.messaging.MessageQuery Service Interface Definition

Interface	osid.messaging.MessageQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching messages. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchSubjectLine
Description	Adds a subject line to match. Multiple subject line matches can be added to perform a boolean `OR` among them.
Parameters	`string`	`subject`	subject to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`subject is` not of `stringMatchType`
	NULL_ARGUMENT		`subject` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySubjectLine
Description	Matches messages with any subject line.
Parameters	`boolean`	`match`	`true` to match messages with any subject line, `false` to match messages with no subject line
Compliance	`mandatory`		This method must be implemented.
Method	clearSubjectLineTerms
Description	Clears the subject line terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchText
Description	Adds text to match. Multiple subject line matches can be added to perform a boolean `OR` among them.
Parameters	`string`	`text`	dtext to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`text is` not of `stringMatchType`
	NULL_ARGUMENT		`text` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyText
Description	Matches messages with any text.
Parameters	`boolean`	`match`	`true` to match messages with any text, `false` to match messages with no text
Compliance	`mandatory`		This method must be implemented.
Method	clearTextTerms
Description	Clears the text terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSent
Description	Matches messages that have been sent.
Parameters	`boolean`	`match`	`true` to match sent messages, `false` to match unsent messages
Compliance	`mandatory`		This method must be implemented.
Method	clearSentTerms
Description	Clears the sent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSentTime
Description	Matches messages whose sent 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`
Errors	NULL_ARGUMENT		`startTime` or `endTime` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSentTimeTerms
Description	Clears the sent time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSenderId
Description	Matches the sender of the message.
Parameters	`osid.id.Id`	`resourceId`	`Id` to match
Parameters	`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	clearSenderIdTerms
Description	Clears the sender `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSenderQuery
Description	Tests if a `ResourceQuery` is available for querying senders.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSenderQuery
Description	Gets the query for a resource.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsSenderQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSenderQuery()` is `true.`
Method	clearSenderTerms
Description	Clears the sender terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSendingAgentId
Description	Matches the sending agent of the message.
Parameters	`osid.id.Id`	`agentId`	`Id` to match
Parameters	`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	clearSendingAgentIdTerms
Description	Clears the sending agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSendingAgentQuery
Description	Tests if an `AgentQuery` is available for querying senders.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSendingAgentQuery
Description	Gets the query for an agent.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsSendingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSendingAgentQuery()` is `true.`
Method	clearSendingAgentTerms
Description	Clears the sending agent 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`
Errors	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	matchDeliveryTime
Description	Matches messages whose delivery duration is between the supplied range inclusive.
Parameters	`osid.calendaring.Duration`	`start`	start time
	`osid.calendaring.Duration`	`end`	end time
	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDeliveryTimeTerms
Description	Clears the delivery time 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
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecipientQuery
Description	Tests if a `ResourceQuery` is available for querying recipients.
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	matchReceiptId
Description	Matches the receipt of the message.
Parameters	`osid.id.Id`	`receiptId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`receiptId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearReceiptIdTerms
Description	Clears the receipt `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsReceiptQuery
Description	Tests if a `ReceiptQuery` is available for querying receipts.
Return	`boolean`		`true` if a receipt query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptQuery
Description	Gets the query for the receipt.
Return	`osid.messaging.ReceiptQuery`		the receipt query
Errors	UNIMPLEMENTED		`supportsReceiptQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReceiptQuery()` is `true.`
Method	matchAnyReceipt
Description	Matches any received messages.
Parameters	`boolean`	`match`	`true` to match any received messages, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearReceiptTerms
Description	Clears the receipt terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMailboxId
Description	Sets the mailbox `Id` for this query.
Parameters	`osid.id.Id`	`mailboxId`	the 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	clearMailboxIdTerms
Description	Clears the mailbox `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxQuery
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	getMailboxQuery
Description	Gets the query for a mailbox. Multiple retrievals produce a nested `OR` term.
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	getMessageQueryRecord
Description	Gets the message query record corresponding to the given `Message` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`messageRecordType`	a message record type
Return	`osid.messaging.records.MessageQueryRecord`		the message query record
Errors	NULL_ARGUMENT		`messageRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(messageRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.