Interface StepQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidSubjugateableQuery, Suppliable

public interface StepQuery
extends OsidRuleQuery, 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 .

Method Summary

Modifier and Type	Method	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 an 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 .Multiple record retrievals produce a nested OR term.
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 an 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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Method Details

matchProcessId

void matchProcessId(Id processId,
 boolean match)

Sets the process Id for this query.

Parameters:

processId - the process Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - processId is null

Compliance:

mandatory - This method must be implemented.

clearProcessIdTerms

void clearProcessIdTerms()

Clears the process Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProcessQuery

boolean supportsProcessQuery()

Tests if a ProcessQuery is available.

Returns:

true if a process query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProcessQuery

ProcessQuery getProcessQuery()

Gets the query for a process. Multiple retrievals produce a nested OR term.

Returns:

the process query

Throws:

UnimplementedException - supportsProcessQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessQuery()} is {@code true} .

clearProcessTerms

void clearProcessTerms()

Clears the process query terms.

Compliance:

mandatory - This method must be implemented.

matchResourceId

void matchResourceId(Id resourceId,
 boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - the resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

Gets the query for a resource. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true} .

matchAnyResource

void matchAnyResource(boolean match)

Matches steps that have any resources.

Parameters:

match - true to match steps with any resources, false to match steps with no resources

Compliance:

mandatory - This method must be implemented.

clearResourceTerms

void clearResourceTerms()

Clears the resource query terms.

Compliance:

mandatory - This method must be implemented.

matchInitial

void matchInitial(boolean match)

Matches initial steps.

Parameters:

match - true to match initial steps, false otherwise

Compliance:

mandatory - This method must be implemented.

clearInitialTerms

void clearInitialTerms()

Clears the initial step terms.

Compliance:

mandatory - This method must be implemented.

matchTerminal

void matchTerminal(boolean match)

Matches terminal steps.

Parameters:

match - true to match terminal steps, false otherwise

Compliance:

mandatory - This method must be implemented.

clearTerminalTerms

void clearTerminalTerms()

Clears the terminal step terms.

Compliance:

mandatory - This method must be implemented.

matchInputStateId

void matchInputStateId(Id stateId,
 boolean match)

Sets the input state Id for this query.

Parameters:

stateId - the state Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearInputStateIdTerms

void clearInputStateIdTerms()

Clears the input state Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInputStateQuery

boolean supportsInputStateQuery()

Tests if a StateQuery is available.

Returns:

true if a state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInputStateQuery

StateQuery getInputStateQuery()

Gets the query for an input state. Multiple retrievals produce a nested OR term.

Returns:

the state query

Throws:

UnimplementedException - supportsInputStateQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsInputtStateQuery()} is {@code true} .

matchAnyInputState

void matchAnyInputState(boolean match)

Matches steps that have any input states.

Parameters:

match - true to match steps with any input states, false to match steps with no input states

Compliance:

mandatory - This method must be implemented.

clearInputStateTerms

void clearInputStateTerms()

Clears the input state terms.

Compliance:

mandatory - This method must be implemented.

matchNextStateId

void matchNextStateId(Id stateId,
 boolean match)

Sets the next state Id for this query.

Parameters:

stateId - the state Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearNextStateIdTerms

void clearNextStateIdTerms()

Clears the next state Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsNextStateQuery

boolean supportsNextStateQuery()

Tests if a StateQuery is available.

Returns:

true if a state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getNextStateQuery

StateQuery getNextStateQuery()

Gets the query for a state. Multiple retrievals produce a nested OR term.

Returns:

the state query

Throws:

UnimplementedException - supportsNextStateQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsNextStateQuery()} is {@code true} .

matchAnyNextState

void matchAnyNextState(boolean match)

Matches steps that have any next state,

Parameters:

match - true to match steps with any next state, false to match steps with no next state

Compliance:

mandatory - This method must be implemented.

clearNextStateTerms

void clearNextStateTerms()

Clears the state terms.

Compliance:

mandatory - This method must be implemented.

matchWorkId

void matchWorkId(Id workId,
 boolean match)

Sets the work Id for this query.

Parameters:

workId - the work Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - workId is null

Compliance:

mandatory - This method must be implemented.

clearWorkIdTerms

void clearWorkIdTerms()

Clears the work Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsWorkQuery

boolean supportsWorkQuery()

Tests if a WorkQuery is available.

Returns:

true if a work query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getWorkQuery

WorkQuery getWorkQuery()

Gets the query for a work. Multiple retrievals produce a nested OR term.

Returns:

the work query

Throws:

UnimplementedException - supportsWorkQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkQuery()} is {@code true} .

matchAnyWork

void matchAnyWork(boolean match)

Matches steps that have any work.

Parameters:

match - true to match steps with any work, false to match steps with no work

Compliance:

mandatory - This method must be implemented.

clearWorkTerms

void clearWorkTerms()

Clears the work query terms.

Compliance:

mandatory - This method must be implemented.

matchOfficeId

void matchOfficeId(Id officeId,
 boolean match)

Sets the office Id for this query to match steps assigned to offices.

Parameters:

officeId - the office Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - officeId is null

Compliance:

mandatory - This method must be implemented.

clearOfficeIdTerms

void clearOfficeIdTerms()

Clears the office Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsOfficeQuery

boolean supportsOfficeQuery()

Tests if an OfficeQuery is available.

Returns:

true if an office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOfficeQuery

OfficeQuery getOfficeQuery()

Gets the query for an office. Multiple retrievals produce a nested OR term.

Returns:

the office query

Throws:

UnimplementedException - supportsOfficeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeQuery()} is {@code true} .

clearOfficeTerms

void clearOfficeTerms()

Clears the office query terms.

Compliance:

mandatory - This method must be implemented.

getStepQueryRecord

StepQueryRecord getStepQueryRecord(Type stepRecordType)
                            throws OperationFailedException

Gets the step query record corresponding to the given Step record Type .Multiple record retrievals produce a nested OR term.

Parameters:

stepRecordType - a step record type

Returns:

the step query record

Throws:

NullArgumentException - stepRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepRecordType) is false

Compliance:

mandatory - This method must be implemented.