public interface StepQuery extends OsidGovernatorQuery, OsidSubjugateableQuery
This is the query for searching steps. 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 |
clearInitialTerms()
Clears the initial step terms.
|
void |
clearInputStateIdTerms()
Clears the input state
Id query terms. |
void |
clearInputStateTerms()
Clears the input state terms.
|
void |
clearNextStateIdTerms()
Clears the next state
Id query terms. |
void |
clearNextStateTerms()
Clears the state terms.
|
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 |
clearResourceIdTerms()
Clears the resource
Id query terms. |
void |
clearResourceTerms()
Clears the resource query terms.
|
void |
clearTerminalTerms()
Clears the terminal step terms.
|
void |
clearWorkIdTerms()
Clears the work
Id query terms. |
void |
clearWorkTerms()
Clears the work query terms.
|
StateQuery |
getInputStateQuery()
Gets the query for an input state.
|
StateQuery |
getNextStateQuery()
Gets the query for a state.
|
OfficeQuery |
getOfficeQuery()
Gets the query for a office.
|
ProcessQuery |
getProcessQuery()
Gets the query for a process.
|
ResourceQuery |
getResourceQuery()
Gets the query for a resource.
|
StepQueryRecord |
getStepQueryRecord(Type stepRecordType)
Gets the step query record corresponding to the given
Step
record Type. |
WorkQuery |
getWorkQuery()
Gets the query for a work.
|
void |
matchAnyInputState(boolean match)
Matches steps that have any input states.
|
void |
matchAnyNextState(boolean match)
Matches steps that have any next state,
|
void |
matchAnyResource(boolean match)
Matches steps that have any resources.
|
void |
matchAnyWork(boolean match)
Matches steps that have any work.
|
void |
matchInitial(boolean match)
Matches initial steps.
|
void |
matchInputStateId(Id stateId,
boolean match)
Sets the input state
Id for this query. |
void |
matchNextStateId(Id stateId,
boolean match)
Sets the next state
Id for this query. |
void |
matchOfficeId(Id officeId,
boolean match)
Sets the office
Id for this query to match steps
assigned to offices. |
void |
matchProcessId(Id processId,
boolean match)
Sets the process
Id for this query. |
void |
matchResourceId(Id resourceId,
boolean match)
Sets the resource
Id for this query. |
void |
matchTerminal(boolean match)
Matches terminal steps.
|
void |
matchWorkId(Id workId,
boolean match)
Sets the work
Id for this query. |
boolean |
supportsInputStateQuery()
Tests if a
StateQuery is available. |
boolean |
supportsNextStateQuery()
Tests if a
StateQuery is available. |
boolean |
supportsOfficeQuery()
Tests if a
OfficeQuery is available. |
boolean |
supportsProcessQuery()
Tests if a
ProcessQuery is available. |
boolean |
supportsResourceQuery()
Tests if a
ResourceQuery 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, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
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 matchResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- the resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void matchAnyResource(boolean match)
match
- true
to match steps with any resources,
false
to match steps with no resourcesmandatory
- This method must be implemented. void clearResourceTerms()
mandatory
- This method must be implemented. void matchInitial(boolean match)
match
- true
to match initial steps, false
otherwisemandatory
- This method must be implemented. void clearInitialTerms()
mandatory
- This method must be implemented. void matchTerminal(boolean match)
match
- true
to match terminal steps,
false
otherwisemandatory
- This method must be implemented. void clearTerminalTerms()
mandatory
- This method must be implemented. void matchInputStateId(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 clearInputStateIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInputStateQuery()
StateQuery
is available. true
if a state query is available,
false
otherwisemandatory
- This method must be implemented. StateQuery getInputStateQuery()
OR
term.UnimplementedException
-
supportsInputStateQuery()
is false
optional
- This method must be implemented if
supportsInputtStateQuery()
is true.
void matchAnyInputState(boolean match)
match
- true
to match steps with any input
states, false
to match steps with no input
statesmandatory
- This method must be implemented. void clearInputStateTerms()
mandatory
- This method must be implemented. void matchNextStateId(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 clearNextStateIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsNextStateQuery()
StateQuery
is available. true
if a state query is available,
false
otherwisemandatory
- This method must be implemented. StateQuery getNextStateQuery()
OR
term.UnimplementedException
-
supportsNextStateQuery()
is false
optional
- This method must be implemented if
supportsNextStateQuery()
is true.
void matchAnyNextState(boolean match)
match
- true
to match steps with any next state,
false
to match steps with no next statemandatory
- This method must be implemented. void clearNextStateTerms()
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 steps with any work,
false
to match steps 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 steps
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. StepQueryRecord getStepQueryRecord(Type stepRecordType) throws OperationFailedException
Step
record Type.
Multiple record retrievals produce
a nested OR
term.stepRecordType
- a step record typeNullArgumentException
- stepRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepRecordType)
is false
mandatory
- This method must be implemented.