org.osid.process

Interface StateQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface StateQuery
extends OsidObjectQuery

This is the query for searching states. Each method 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	clearProcessIdTerms() Clears the process Id terms.
void	clearProcessTerms() Clears the process terms.
ProcessQuery	getProcessQuery() Gets the query for a process.
StateQueryRecord	getStateQueryRecord(Type stateRecordType) Gets the state query record corresponding to the given State record Type.
void	matchProcessId(Id processId, boolean match) Sets the process Id for this query.
boolean	supportsProcessQuery() Tests if a ProcessQuery 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

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 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 terms.

Compliance:

mandatory - This method must be implemented.

getStateQueryRecord

StateQueryRecord getStateQueryRecord(Type stateRecordType)
                                     throws OperationFailedException

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

Parameters:

stateRecordType - a state record type

Returns:

the state query record

Throws:

NullArgumentException - stateRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stateRecordType) is false

Compliance:

mandatory - This method must be implemented.