org.osid.workflow

Interface StepQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, OsidSubjugateableQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

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 supportsProcessQuery() is 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 supportsResourceQuery() is 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 supportsInputtStateQuery() is 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 supportsNextStateQuery() is 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 supportsWorkQuery() is 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 a OfficeQuery is available.

Returns:

true if a office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOfficeQuery

OfficeQuery getOfficeQuery()

Gets the query for a 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 supportsOfficeQuery() is 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.