OSID - osid.messaging.MessageQueryInspector Service Interface Definition

Interface	osid.messaging.MessageQueryInspector
Implements	`osid.OsidObjectQueryInspector`
Description	This is the query inspector for examining message queries.
Method	getSubjectLineTerms
Description	Gets the subject line query terms.
Return	`osid.search.terms.StringTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getTextTerms
Description	Gets the text query terms.
Return	`osid.search.terms.StringTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getSentTerms
Description	Gets the sent query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getSentTimeTerms
Description	Gets the sent time query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getSenderIdTerms
Description	Gets the sender `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getSenderTerms
Description	Gets the sender query terms.
Return	`osid.resource.ResourceQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getSendingAgentIdTerms
Description	Gets the sending agent `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getSendingAgentTerms
Description	Gets the sending agent query terms.
Return	`osid.authentication.AgentQueryInspector[]`		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	getDeliveryTimeTerms
Description	Gets the delivery time query terms.
Return	`osid.search.terms.DurationRangeTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRecipientIdTerms
Description	Gets the recipient `Id` query terms.
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	getReceiptIdTerms
Description	Gets the receipt `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptTerms
Description	Gets the receipt query terms.
Return	`osid.messaging.ReceiptQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxIdTerms
Description	Gets the mailbox `Id` query terms.
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	getMessageQueryInspectorRecord
Description	Gets the message query inspector record corresponding to the given `Message` record `Type.`
Parameters	`osid.type.Type`	`messageRecordType`	a message record type
Return	`osid.messaging.records.MessageQueryInspectorRecord`		the message query inspector 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.