Interface | osid.workflow.OfficeQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching offices. Each method match
specifies an | ||
Method | matchProcessId | ||
Description |
Sets the step | ||
Parameters | osid.id.Id | processId | the process Id |
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 | ||
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 | ||
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 | ||
Parameters | osid.id.Id | stepId | the step Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsStepQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an step query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepQuery | ||
Description |
Gets the query for an step. Multiple retrievals produce
a nested | ||
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 | ||
Parameters | osid.id.Id | workId | the work Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsWorkQuery | ||
Description |
Tests if a | ||
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 | ||
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 | ||
Parameters | osid.id.Id | officeId | a office Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorOfficeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a office query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorOfficeQuery | ||
Description |
Gets the query for a office/ Multiple retrievals
produce a nested | ||
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 | ||
Parameters | osid.id.Id | officeId | a office Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantOfficeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a office query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantOfficeQuery | ||
Description |
Gets the query for a office/ Multiple retrievals
produce a nested | ||
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 | ||
Parameters | osid.type.Type | officeRecordType | a 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. |