OSID - osid.tracking.FrontOfficeQuery Service Interface Definition

Interface	osid.tracking.FrontOfficeQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.tracking.FrontOfficeQuery`
	`osid.tracking.FrontOfficeQuerySession`
	`osid.tracking.FrontOfficeSearchSession`
	`osid.tracking.IssueQuery`
	`osid.tracking.LogEntryQuery`
	`osid.tracking.QueueQuery`
	`osid.tracking.rules.QueueConstrainerEnablerQuery`
	`osid.tracking.rules.QueueConstrainerQuery`
	`osid.tracking.rules.QueueEnablerQuery`
	`osid.tracking.rules.QueueProcessorEnablerQuery`
	show 1 more…
`osid.tracking.rules.QueueProcessorQuery`
Description	This is the query for searching front offices. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchIssueId
Description	Sets the issue `Id` for this query to match front offices that have a related issue.
Parameters	`osid.id.Id`	`issueId`	a issue `Id`
Parameters	`boolean`	`match`	`true` if 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 front offices that have any issue.
Parameters	`boolean`	`match`	`true` to match front offices with any issue, `false` to match front offices 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	matchQueueId
Description	Sets the effort `Id` for this query to match front offices containing queues.
Parameters	`osid.id.Id`	`queueId`	the queue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`queueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearQueueIdTerms
Description	Clears the queue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueQuery
Description	Tests if a `QueueQuery` is available.
Return	`boolean`		`true` if a queue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQueueQuery
Description	Gets the query for a queue. Multiple retrievals produce a nested `OR` term.
Return	`osid.tracking.QueueQuery`		the queue query
Errors	UNIMPLEMENTED		`supportsQueueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsQueueQuery()` is `true`.
Method	matchAnyQueue
Description	Matches front offices that have any queue.
Parameters	`boolean`	`match`	`true` to match front offices with any queue, `false` to match front offices with no queue
Compliance	`mandatory`		This method must be implemented.
Method	clearQueueTerms
Description	Clears the queue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorFrontOfficeId
Description	Sets the front office `Id` for this query to match front offices that have the specified front office as an ancestor.
Parameters	`osid.id.Id`	`frontOfficeId`	a 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	clearAncestorFrontOfficeIdTerms
Description	Clears the ancestor front office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorFrontOfficeQuery
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	getAncestorFrontOfficeQuery
Description	Gets the query for a frontOffice/ Multiple retrievals produce a nested `OR` term.
Return	`osid.tracking.FrontOfficeQuery`		the front office query
Errors	UNIMPLEMENTED		`supportsAncestorFrontOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorFrontOfficeQuery()` is `true`.
Method	matchAnyAncestorFrontOffice
Description	Matches front offices with any ancestor.
Parameters	`boolean`	`match`	`true` to match front offices with any ancestor, `false` to match root frontOffices
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorFrontOfficeTerms
Description	Clears the ancestor front office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantFrontOfficeId
Description	Sets the front office `Id` for this query to match front offices that have the specified front office as a descendant.
Parameters	`osid.id.Id`	`frontOfficeId`	a 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	clearDescendantFrontOfficeIdTerms
Description	Clears the descendant front office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantFrontOfficeQuery
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	getDescendantFrontOfficeQuery
Description	Gets the query for a frontOffice/ Multiple retrievals produce a nested `OR` term.
Return	`osid.tracking.FrontOfficeQuery`		the front office query
Errors	UNIMPLEMENTED		`supportsDescendantFrontOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantFrontOfficeQuery()` is `true`.
Method	matchAnyDescendantFrontOffice
Description	Matches front offices with any descendant.
Parameters	`boolean`	`match`	`true` to match front offices with any descendant, `false` to match leaf frontOffices
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantFrontOfficeTerms
Description	Clears the descendant front office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOfficeQueryRecord
Description	Gets the front office query record corresponding to the given `FrontOffice` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`frontOfficeRecordType`	a front office record type
Return	`osid.tracking.records.FrontOfficeQueryRecord`		the front office query record
Errors	NULL_ARGUMENT		`frontOfficeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(frontOfficeRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.