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.

Like all OsidQueries, ProcessQuery is stateful and must not be accessed by multiple processing threads.

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

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

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

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface OsidSourceableQuery

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

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.