org.osid.workflow

Interface ProcessQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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, clearOperationalTerms, matchActive, matchDisabled, 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

matchEnabled

void matchEnabled(boolean match)

Matches enabled processes.

Specified by:

matchEnabled in interface OsidOperableQuery

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearEnabledTerms

void clearEnabledTerms()

Clears the enabled query terms.

Specified by:

clearEnabledTerms in interface OsidOperableQuery

Compliance:

mandatory - This method must be implemented.

matchInitialStepId

void matchInitialStepId(Id stepId,
                      boolean match)

Sets the initial step Id for this query.

Parameters:

stepId - the step Id

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

Throws:

NullArgumentException - stepId is null

Compliance:

mandatory - This method must be implemented.

clearInitialStepIdTerms

void clearInitialStepIdTerms()

Clears the initial stap Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInitialStepQuery

boolean supportsInitialStepQuery()

Tests if a StepQuery is available.

Returns:

true if a step query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInitialStepQuery

StepQuery getInitialStepQuery()

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

Returns:

the step query

Throws:

UnimplementedException - supportsInitialStepQuery() is false

Compliance:

optional - This method must be implemented if supportsInitialStepQuery() is true.

clearInitialStepTerms

void clearInitialStepTerms()

Clears the initial step terms.

Compliance:

mandatory - This method must be implemented.

matchInitialStateId

void matchInitialStateId(Id stateId,
                       boolean match)

Sets the initial 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.

clearInitialStateIdTerms

void clearInitialStateIdTerms()

Clears the initial state Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInitialStateQuery

boolean supportsInitialStateQuery()

Tests if a StateQuery is available.

Returns:

true if a state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInitialStateQuery

StateQuery getInitialStateQuery()

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

Returns:

the state query

Throws:

UnimplementedException - supportsInitialStateQuery() is false

Compliance:

optional - This method must be implemented if supportsInitialStateQuery() is true.

clearInitialStateTerms

void clearInitialStateTerms()

Clears the state terms.

Compliance:

mandatory - This method must be implemented.

matchStepId

void matchStepId(Id stepId,
               boolean match)

Sets the step Id for this query.

Parameters:

stepId - the step Id

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

Throws:

NullArgumentException - stepId is null

Compliance:

mandatory - This method must be implemented.

clearStepIdTerms

void clearStepIdTerms()

Clears the step Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsStepQuery

boolean supportsStepQuery()

Tests if a StepQuery is available.

Returns:

true if a step query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStepQuery

StepQuery getStepQuery()

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

Returns:

the step query

Throws:

UnimplementedException - supportsStepyQuery() is false

Compliance:

optional - This method must be implemented if supportsStepQuery() is true.

matchAnyStep

void matchAnyStep(boolean match)

Matches processes that have any step.

Parameters:

match - true to match processes with any step, false to match processes with no step

Compliance:

mandatory - This method must be implemented.

clearStepTerms

void clearStepTerms()

Clears the step query 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 processs that have any work.

Parameters:

match - true to match processes with any work, false to match processes 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 process 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.

getProcessQueryRecord

ProcessQueryRecord getProcessQueryRecord(Type processRecordType)
                                         throws OperationFailedException

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

Parameters:

processRecordType - a process record type

Returns:

the process query record

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processRecordType) is false

Compliance:

mandatory - This method must be implemented.