OSID - osid.workflow.event.WorkflowEventQuery Service Interface Definition

Interface	osid.workflow.event.WorkflowEventQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.workflow.event.WorkflowEventQuerySession`
	`osid.workflow.event.WorkflowEventSearchSession`
	`osid.workflow.event.WorkflowEventSmartOfficeSession`
Description	This is the query for searching workflow events. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchTimestamp
Description	Matches temporals whose timestamp falls in between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is less than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimestampTerms
Description	Clears the timestamp query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProcessId
Description	Sets the process `Id` for this query to match workflow events for processes.
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 `Id` 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	clearProcessTerms
Description	Clears the process query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWorkerId
Description	Sets the worker `Id` for this query to match workers.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkerIdTerms
Description	Clears the worker `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkerQuery
Description	Tests if a `WorkerQuery` is available.
Return	`boolean`		`true` if a worker query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWorkerQuery
Description	Gets the query for a worker. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the worker query
Errors	UNIMPLEMENTED		`supportsWorkerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkerQuery()` is `true`.
Method	clearWorkerTerms
Description	Clears the worker query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWorkingAgentId
Description	Sets the agent `Id` for this query to match working agents.
Parameters	`osid.id.Id`	`agentId`	the agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkingAgentIdTerms
Description	Clears the agent `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkingAgentQuery
Description	Tests if a `WorkingAgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWorkingAgentQuery
Description	Gets the query for a working agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsWorkingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkingAgentQuery()` is `true`.
Method	clearWorkingAgentTerms
Description	Clears the working agent query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWorkId
Description	Sets the work `Id` for this query to match work.
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	clearWorkTerms
Description	Clears the work query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCanceled
Description	Matches work that has been canceled.
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	clearCanceledTerms
Description	Clears the work `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStepId
Description	Sets the step `Id` for this query to match work.
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 work query
Errors	UNIMPLEMENTED		`supportsStepQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStepQuery()` is `true`.
Method	clearStepTerms
Description	Clears the step query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOfficeId
Description	Sets the office `Id` for this query to match workflow events assigned to offices.
Parameters	`osid.id.Id`	`officeId`	the 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	clearOfficeIdTerms
Description	Clears the office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeQuery
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	getOfficeQuery
Description	Gets the query for an office. Multiple retrievals produce a nested `OR` term.
Return	`osid.workflow.OfficeQuery`		the office query
Errors	UNIMPLEMENTED		`supportsOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOfficeQuery()` is `true`.
Method	clearOfficeTerms
Description	Clears the office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventQueryRecord
Description	Gets the workflow event query record corresponding to the given `WorkflowEvent` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`workflowEventRecordType`	a workflow event record type
Return	`osid.workflow.event.records.WorkflowEventQueryRecord`		the workflow event query record
Errors	NULL_ARGUMENT		`workflowEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(workflowEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.