public interface ProcessQuery extends OsidGovernatorQuery
This is the query for searching processes. 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 |
clearEnabledTerms()
Clears the enabled query terms.
|
void |
clearInitialStateIdTerms()
Clears the initial state
Id query terms. |
void |
clearInitialStateTerms()
Clears the state terms.
|
void |
clearInitialStepIdTerms()
Clears the initial stap
Id query terms. |
void |
clearInitialStepTerms()
Clears the initial step terms.
|
void |
clearOfficeIdTerms()
Clears the office
Id query terms. |
void |
clearOfficeTerms()
Clears the office query terms.
|
void |
clearStepIdTerms()
Clears the step
Id query terms. |
void |
clearStepTerms()
Clears the step query terms.
|
void |
clearWorkIdTerms()
Clears the work
Id query terms. |
void |
clearWorkTerms()
Clears the work query terms.
|
StateQuery |
getInitialStateQuery()
Gets the query for a state.
|
StepQuery |
getInitialStepQuery()
Gets the query for a step.
|
OfficeQuery |
getOfficeQuery()
Gets the query for a office.
|
ProcessQueryRecord |
getProcessQueryRecord(Type processRecordType)
Gets the process query record corresponding to the given
Process record Type. |
StepQuery |
getStepQuery()
Gets the query for a step Multiple retrievals produce a nested
OR term. |
WorkQuery |
getWorkQuery()
Gets the query for a work.
|
void |
matchAnyStep(boolean match)
Matches processes that have any step.
|
void |
matchAnyWork(boolean match)
Matches processs that have any work.
|
void |
matchEnabled(boolean match)
Matches enabled processes.
|
void |
matchInitialStateId(Id stateId,
boolean match)
Sets the initial state
Id for this query. |
void |
matchInitialStepId(Id stepId,
boolean match)
Sets the initial step
Id for this query. |
void |
matchOfficeId(Id officeId,
boolean match)
Sets the office
Id for this query to match process
assigned to offices. |
void |
matchStepId(Id stepId,
boolean match)
Sets the step
Id for this query. |
void |
matchWorkId(Id workId,
boolean match)
Sets the work
Id for this query. |
boolean |
supportsInitialStateQuery()
Tests if a
StateQuery is available. |
boolean |
supportsInitialStepQuery()
Tests if a
StepQuery is available. |
boolean |
supportsOfficeQuery()
Tests if a
OfficeQuery is available. |
boolean |
supportsStepQuery()
Tests if a
StepQuery is available. |
boolean |
supportsWorkQuery()
Tests if a
WorkQuery 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
clearActiveTerms, clearDisabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchOperational
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchEnabled(boolean match)
matchEnabled
in interface OsidOperableQuery
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearEnabledTerms()
clearEnabledTerms
in interface OsidOperableQuery
mandatory
- This method must be implemented. void matchInitialStepId(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 clearInitialStepIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInitialStepQuery()
StepQuery
is available. true
if a step query is available, false
otherwisemandatory
- This method must be implemented. StepQuery getInitialStepQuery()
OR
term.UnimplementedException
-
supportsInitialStepQuery()
is false
optional
- This method must be implemented if
supportsInitialStepQuery()
is true.
void clearInitialStepTerms()
mandatory
- This method must be implemented. void matchInitialStateId(Id stateId, boolean match)
Id
for this query.stateId
- the state Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearInitialStateIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInitialStateQuery()
StateQuery
is available. true
if a state query is available,
false
otherwisemandatory
- This method must be implemented. StateQuery getInitialStateQuery()
OR
term.UnimplementedException
-
supportsInitialStateQuery()
is false
optional
- This method must be implemented if
supportsInitialStateQuery()
is true.
void clearInitialStateTerms()
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 matchWorkId(Id workId, boolean match)
Id
for this query.workId
- the work Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- workId
is
null
mandatory
- This method must be implemented. void clearWorkIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsWorkQuery()
WorkQuery
is available. true
if a work query is available, false
otherwisemandatory
- This method must be implemented. WorkQuery getWorkQuery()
OR
term.UnimplementedException
- supportsWorkQuery()
is false
optional
- This method must be implemented if
supportsWorkQuery()
is true.
void matchAnyWork(boolean match)
match
- true
to match processes with any work,
false
to match processes with no workmandatory
- This method must be implemented. void clearWorkTerms()
mandatory
- This method must be implemented. void matchOfficeId(Id officeId, boolean match)
Id
for this query to match process
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. ProcessQueryRecord getProcessQueryRecord(Type processRecordType) throws OperationFailedException
Process
record Type.
Multiple record retrievals
produce a nested OR
term.processRecordType
- a process record typeNullArgumentException
- processRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(processRecordType)
is false
mandatory
- This method must be implemented.