OSID - osid.workflow.OfficeQuery Service Interface Definition

Interface	osid.workflow.OfficeQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.workflow.OfficeQuery`
	`osid.workflow.OfficeQuerySession`
	`osid.workflow.OfficeSearchSession`
	`osid.workflow.ProcessQuery`
	`osid.workflow.StepQuery`
	`osid.workflow.WorkQuery`
	`osid.workflow.event.WorkflowEventQuery`
	`osid.workflow.rules.ProcessConstrainerEnablerQuery`
	`osid.workflow.rules.ProcessConstrainerQuery`
	`osid.workflow.rules.ProcessEnablerQuery`
	show 7 more…
`osid.workflow.rules.ProcessProcessorEnablerQuery`
`osid.workflow.rules.ProcessProcessorQuery`
`osid.workflow.rules.StepConstrainerEnablerQuery`
`osid.workflow.rules.StepConstrainerQuery`
`osid.workflow.rules.StepEnablerQuery`
`osid.workflow.rules.StepProcessorEnablerQuery`
`osid.workflow.rules.StepProcessorQuery`
Description	This is the query for searching offices. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchProcessId
Description	Sets the step `Id` for this query to match offices containing process.
Parameters	`osid.id.Id`	`processId`	the process `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`processId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessIdTerms
Description	Clears the process query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessQuery
Description	Tests if a `ProcessQuery` is available.
Return	`boolean`		`true` if a process query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcessQuery
Description	Gets the query for a process. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.ProcessQuery`		the process query
Errors	UNIMPLEMENTED		`supportsProcessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessQuery()` is `true`.
Method	matchAnyProcess
Description	Matches offices that have any process.
Parameters	`boolean`	`match`	`true` to match offices with any process, `false` to match offices with no process
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessTerms
Description	Clears the process query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStepId
Description	Sets the step `Id` for this query.
Parameters	`osid.id.Id`	`stepId`	the step `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stepId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStepIdTerms
Description	Clears the step `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepQuery
Description	Tests if a `StepQuery` is available.
Return	`boolean`		`true` if a step query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStepQuery
Description	Gets the query for a step. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.StepQuery`		the step query
Errors	UNIMPLEMENTED		`supportsStepQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStepQuery()` is `true`.
Method	matchAnyStep
Description	Matches offices with any step.
Parameters	`boolean`	`match`	`true` to match offices with any step, `false` to match offices with no step
Compliance	`mandatory`		This method must be implemented.
Method	clearStepTerms
Description	Clears the step query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWorkId
Description	Sets the work `Id` for this query.
Parameters	`osid.id.Id`	`workId`	the work `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`workId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkIdTerms
Description	Clears the work `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkQuery
Description	Tests if a `WorkQuery` is available.
Return	`boolean`		`true` if a work query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWorkQuery
Description	Gets the query for a work. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.WorkQuery`		the work query
Errors	UNIMPLEMENTED		`supportsWorkQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkQuery()` is `true`.
Method	matchAnyWork
Description	Matches offices that have any work.
Parameters	`boolean`	`match`	`true` to match offices with any work, `false` to match offices with no process
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkTerms
Description	Clears the work query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorOfficeId
Description	Sets the office `Id` for this query to match offices that have the specified office as an ancestor.
Parameters	`osid.id.Id`	`officeId`	an office `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`officeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorOfficeIdTerms
Description	Clears the ancestor office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorOfficeQuery
Description	Tests if an `OfficeQuery` is available.
Return	`boolean`		`true` if an office query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorOfficeQuery
Description	Gets the query for an office. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.OfficeQuery`		the office query
Errors	UNIMPLEMENTED		`supportsAncestorOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorOfficeQuery()` is `true`.
Method	matchAnyAncestorOffice
Description	Matches offices with any ancestor.
Parameters	`boolean`	`match`	`true` to match offices with any ancestor, `false` to match root offices
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorOfficeTerms
Description	Clears the ancestor office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantOfficeId
Description	Sets the office `Id` for this query to match offices that have the specified office as a descendant.
Parameters	`osid.id.Id`	`officeId`	an office `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`officeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantOfficeIdTerms
Description	Clears the descendant office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantOfficeQuery
Description	Tests if an `OfficeQuery` is available.
Return	`boolean`		`true` if an office query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantOfficeQuery
Description	Gets the query for an office. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.OfficeQuery`		the office query
Errors	UNIMPLEMENTED		`supportsDescendantOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantOfficeQuery()` is `true`.
Method	matchAnyDescendantOffice
Description	Matches offices with any descendant.
Parameters	`boolean`	`match`	`true` to match offices with any descendant, `false` to match leaf offices
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantOfficeTerms
Description	Clears the descendant office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeQueryRecord
Description	Gets the office query corresponding to the given `Office` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`officeRecordType`	an office record type
Return	`osid.workflow.records.OfficeQueryRecord`		the office query record
Errors	NULL_ARGUMENT		`officeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(officeRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.