OSID - osid.tracking.QueueQuery Service Interface Definition

Interface	osid.tracking.QueueQuery
Implements	`osid.OsidGovernatorQuery`
Used By	`osid.tracking.FrontOfficeQuery`
	`osid.tracking.IssueQuery`
	`osid.tracking.QueueQuerySession`
	`osid.tracking.QueueSearchSession`
	`osid.tracking.QueueSmartFrontOfficeSession`
	`osid.tracking.rules.QueueConstrainerQuery`
	`osid.tracking.rules.QueueEnablerQuery`
	`osid.tracking.rules.QueueEnablerSmartFrontOfficeSession`
	`osid.tracking.rules.QueueProcessorQuery`
Description	This is the query for searching queues. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchManagerId
Description	Sets a manager `Id` for this query.
Parameters	`osid.id.Id`	`managerId`	a manager `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`managerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearManagerIdTerms
Description	Clears the manager `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsManagerQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a manager query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getManagerQuery
Description	Gets the query for a manager. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the manager query
Errors	UNIMPLEMENTED		`supportsManagerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsManagerQuery()` is `true`.
Method	matchAnyManager
Description	Matches objects with any manager.
Parameters	`boolean`	`match`	`true` to match objects with any manager, `false` to match objects with no manager
Compliance	`mandatory`		This method must be implemented.
Method	clearManagerTerms
Description	Clears the manager query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIssueId
Description	Sets the issue `Id` for this query to match queues that pass through issues.
Parameters	`osid.id.Id`	`issueId`	the issue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`issueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIssueIdTerms
Description	Clears the issue `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueQuery
Description	Tests if a `IssueQuery` is available.
Return	`boolean`		`true` if a issue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueQuery
Description	Gets the query for a issue. Multiple retrievals produce a nested `OR` term.
Return	`osid.tracking.IssueQuery`		the issue query
Errors	UNIMPLEMENTED		`supportsIssueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsIssueQuery()` is `true`.
Method	matchAnyIssue
Description	Matches log entries that go through any issue.
Parameters	`boolean`	`match`	`true` to match log entries with any issue, `false` to match log entries with no issue
Compliance	`mandatory`		This method must be implemented.
Method	clearIssueTerms
Description	Clears the issue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFrontOfficeId
Description	Sets the front office `Id` for this query to match queues assigned to front offices.
Parameters	`osid.id.Id`	`frontOfficeId`	the front office `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`frontOfficeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFrontOfficeIdTerms
Description	Clears the front office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeQuery
Description	Tests if a `FrontOfficeQuery` is available.
Return	`boolean`		`true` if a front office query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOfficeQuery
Description	Gets the query for a front office. Multiple retrievals produce a nested `OR` term.
Return	`osid.tracking.FrontOfficeQuery`		the front office query
Errors	UNIMPLEMENTED		`supportsFrontOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFrontOfficeQuery()` is `true`.
Method	clearFrontOfficeTerms
Description	Clears the front office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getQueueQueryRecord
Description	Gets the queue query record corresponding to the given `Queue` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`queueRecordType`	a queue record type
Return	`osid.tracking.records.QueueQueryRecord`		the queue query record
Errors	NULL_ARGUMENT		`queueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.