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

Modifier and Type	Method	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	clearOwnerIdTerms()	Clears the owner Id query terms.
void	clearOwnerTerms()	Clears the owner 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 an office.
ResourceQuery	getOwnerQuery()	Gets the query for a owner.
ProcessQueryRecord	getProcessQueryRecord(Type processRecordType)	Gets the process query record corresponding to the given Process record Type .Multiple record retrievals produce a nested OR term.
StepQuery	getStepQuery()	Gets the query for a step Multiple retrievals produce a nested OR term.
WorkQuery	getWorkQuery()	Gets the query for a work.
void	matchAnyOwner(boolean match)	Matches objects with any owner.
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	matchOwnerId(Id ownerId, boolean match)	Sets a owner Id for this query.
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 an OfficeQuery is available.
boolean	supportsOwnerQuery()	Tests if a ResourceQuery is available.
boolean	supportsStepQuery()	Tests if a StepQuery 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, clearOperationalTerms, matchActive, matchDisabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
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 OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchOwnerId

void matchOwnerId(Id ownerId,
 boolean match)

Sets a owner Id for this query.

Parameters:

ownerId - a owner Id

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

Throws:

NullArgumentException - ownerId is null

Compliance:

mandatory - This method must be implemented.

clearOwnerIdTerms

void clearOwnerIdTerms()

Clears the owner Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsOwnerQuery

boolean supportsOwnerQuery()

Tests if a ResourceQuery is available.

Returns:

true if a owner query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOwnerQuery

ResourceQuery getOwnerQuery()

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

Returns:

the owner query

Throws:

UnimplementedException - supportsOwnerQuery() is false

Compliance:

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

matchAnyOwner

void matchAnyOwner(boolean match)

Matches objects with any owner.

Parameters:

match - true to match objects with any owner, false to match objects with no owner

Compliance:

mandatory - This method must be implemented.

clearOwnerTerms

void clearOwnerTerms()

Clears the owner query terms.

Compliance:

mandatory - This method must be implemented.

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 {@code supportsInitialStepQuery()} is {@code 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 {@code supportsInitialStateQuery()} is {@code 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 {@code supportsStepQuery()} is {@code 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 {@code supportsWorkQuery()} is {@code 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 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.

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.