public interface WorkQuery extends OsidObjectQuery
This is the query for searching works. Each method match specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearOfficeIdTerms()
Clears the office
Id query terms. |
void |
clearOfficeTerms()
Clears the office query terms.
|
void |
clearProcessIdTerms()
Clears the process
Id query terms. |
void |
clearProcessTerms()
Clears the process query terms.
|
void |
clearStepIdTerms()
Clears the step
Id query terms. |
void |
clearStepTerms()
Clears the step query terms.
|
void |
clearSuspendedTerms()
Clears the suspended query terms.
|
OfficeQuery |
getOfficeQuery()
Gets the query for a office.
|
ProcessQuery |
getProcessQuery()
Gets the query for a process.
|
StepQuery |
getStepQuery()
Gets the query for a step Multiple retrievals produce a nested
OR term. |
WorkQueryRecord |
getWorkQueryRecord(Type workRecordType)
Gets the work query record corresponding to the given
Work
record Type. |
void |
matchAnyStep(boolean match)
Matches processes that have any step.
|
void |
matchOfficeId(Id officeId,
boolean match)
Sets the office
Id for this query to match works
assigned to offices. |
void |
matchProcessId(Id processId,
boolean match)
Sets the process
Id for this query. |
void |
matchStepId(Id stepId,
boolean match)
Sets the step
Id for this query. |
void |
matchSuspended(boolean match)
Matches suspended work.
|
boolean |
supportsOfficeQuery()
Tests if a
OfficeQuery is available. |
boolean |
supportsProcessQuery()
Tests if a
ProcessQuery is available. |
boolean |
supportsStepQuery()
Tests if a
StepQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchSuspended(boolean match)
match
- true
to match suspended work,
false
otherwisemandatory
- This method must be implemented. void clearSuspendedTerms()
mandatory
- This method must be implemented. void matchProcessId(Id processId, boolean match)
Id
for this query.processId
- the process Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- processId
is
null
mandatory
- This method must be implemented. void clearProcessIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProcessQuery()
ProcessQuery
is available. true
if a process query is available,
false
otherwisemandatory
- This method must be implemented. ProcessQuery getProcessQuery()
OR
term.UnimplementedException
- supportsProcessQuery()
is false
optional
- This method must be implemented if
supportsProcessQuery()
is true.
void clearProcessTerms()
mandatory
- This method must be implemented. void matchStepId(Id stepId, boolean match)
Id
for this query.stepId
- the step Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stepId
is
null
mandatory
- This method must be implemented. void clearStepIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsStepQuery()
StepQuery
is available. true
if a step query is available, false
otherwisemandatory
- This method must be implemented. StepQuery getStepQuery()
OR
term.UnimplementedException
- supportsStepyQuery()
is false
optional
- This method must be implemented if
supportsStepQuery()
is true.
void matchAnyStep(boolean match)
match
- true
to match processes with any step,
false
to match processes with no stepmandatory
- This method must be implemented. void clearStepTerms()
mandatory
- This method must be implemented. void matchOfficeId(Id officeId, boolean match)
Id
for this query to match works
assigned to offices.officeId
- the office Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- officeId
is
null
mandatory
- This method must be implemented. void clearOfficeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsOfficeQuery()
OfficeQuery
is available. true
if a office query is available,
false
otherwisemandatory
- This method must be implemented. OfficeQuery getOfficeQuery()
OR
term.UnimplementedException
- supportsOfficeQuery()
is false
optional
- This method must be implemented if
supportsOfficeQuery()
is true.
void clearOfficeTerms()
mandatory
- This method must be implemented. WorkQueryRecord getWorkQueryRecord(Type workRecordType) throws OperationFailedException
Work
record Type.
Multiple record retrievals produce
a nested OR
term.workRecordType
- a work record typeNullArgumentException
- workRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(workRecordType)
is false
mandatory
- This method must be implemented.