Interface ProcessQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface ProcessQuery
extends OsidCatalogQuery

This is the query for searching processes. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAncestorProcessIdTerms()	Clears the ancestor process Id terms.
void	clearAncestorProcessTerms()	Clears the ancestor process terms.
void	clearDescendantProcessIdTerms()	Clears the descendant process Id terms.
void	clearDescendantProcessTerms()	Clears the descendant process terms.
void	clearStateIdTerms()	Clears the state Id terms.
void	clearStateTerms()	Clears the state terms.
ProcessQuery	getAncestorProcessQuery()	Gets the query for a process.
ProcessQuery	getDescendantProcessQuery()	Gets the query for a process.
ProcessQueryRecord	getProcessQueryRecord(Type processRecordType)	Gets the process query record corresponding to the given Process record Type .Multiple retrievals produce a nested OR term.
StateQuery	getStateQuery()	Gets the query for a state.
void	matchAncestorProcessId(Id processId, boolean match)	Sets the process Id for this query to match processes that have the specified process as an ancestor.
void	matchAnyAncestorProcess(boolean match)	Matches processes with any ancestor.
void	matchAnyDescendantProcess(boolean match)	Matches processes with any descendant.
void	matchAnyState(boolean match)	Matches processes with any states.
void	matchDescendantProcessId(Id processId, boolean match)	Sets the process Id for this query to match that have the specified process as a descendant.
void	matchStateId(Id stateId, boolean match)	Sets the state Id for this query.
boolean	supportsAncestorProcessQuery()	Tests if a ProcessQuery is available.
boolean	supportsDescendantProcessQuery()	Tests if a ProcessQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery 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, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, 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	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.
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	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	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	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 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

matchStateId

void matchStateId(Id stateId,
 boolean match)

Sets the state Id for this query.

Specified by:

matchStateId in interface OsidObjectQuery

Parameters:

stateId - a 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.

clearStateIdTerms

void clearStateIdTerms()

Clears the state Id terms.

Specified by:

clearStateIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsStateQuery

boolean supportsStateQuery()

Tests if a StateQuery is available.

Specified by:

supportsStateQuery in interface OsidObjectQuery

Returns:

true if a state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStateQuery

StateQuery getStateQuery()

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

Specified by:

getStateQuery in interface OsidObjectQuery

Returns:

the state query

Throws:

UnimplementedException - supportsStateQuery() is false

Compliance:

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

matchAnyState

void matchAnyState(boolean match)

Matches processes with any states.

Specified by:

matchAnyState in interface OsidObjectQuery

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearStateTerms

void clearStateTerms()

Clears the state terms.

Specified by:

clearStateTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

matchAncestorProcessId

void matchAncestorProcessId(Id processId,
 boolean match)

Sets the process Id for this query to match processes that have the specified process as an ancestor.

Parameters:

processId - a 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.

clearAncestorProcessIdTerms

void clearAncestorProcessIdTerms()

Clears the ancestor process Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorProcessQuery

boolean supportsAncestorProcessQuery()

Tests if a ProcessQuery is available.

Returns:

true if a process query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorProcessQuery

ProcessQuery getAncestorProcessQuery()

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

Returns:

the process query

Throws:

UnimplementedException - supportsAncestorProcessQuery() is false

Compliance:

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

matchAnyAncestorProcess

void matchAnyAncestorProcess(boolean match)

Matches processes with any ancestor.

Parameters:

match - true to match process with any ancestor, false to match root processes

Compliance:

mandatory - This method must be implemented.

clearAncestorProcessTerms

void clearAncestorProcessTerms()

Clears the ancestor process terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantProcessId

void matchDescendantProcessId(Id processId,
 boolean match)

Sets the process Id for this query to match that have the specified process as a descendant.

Parameters:

processId - a 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.

clearDescendantProcessIdTerms

void clearDescendantProcessIdTerms()

Clears the descendant process Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantProcessQuery

boolean supportsDescendantProcessQuery()

Tests if a ProcessQuery is available.

Returns:

true if a process query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantProcessQuery

ProcessQuery getDescendantProcessQuery()

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

Returns:

the process query

Throws:

UnimplementedException - supportsDescendantProcessQuery() is false

Compliance:

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

matchAnyDescendantProcess

void matchAnyDescendantProcess(boolean match)

Matches processes with any descendant.

Parameters:

match - true to match process with any descendant, false to match leaf processes

Compliance:

mandatory - This method must be implemented.

clearDescendantProcessTerms

void clearDescendantProcessTerms()

Clears the descendant process 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 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.