Interface ControllerQuery

All Superinterfaces:

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

public interface ControllerQuery
extends OsidObjectQuery, OsidOperableQuery

This is the query for searching controllers. 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	clearAddressTerms()	Clears the address query terms.
void	clearDiscreetStateIdTerms()	Clears the state Id query terms.
void	clearDiscreetStatesTerms()	Clears the discreet states query terms.
void	clearDiscreetStateTerms()	Clears the state query terms.
void	clearModelIdTerms()	Clears the model Id query terms.
void	clearModelTerms()	Clears the model query terms.
void	clearSystemIdTerms()	Clears the system Id query terms.
void	clearSystemTerms()	Clears the system query terms.
void	clearToggleableTerms()	Clears the toggleable query terms.
void	clearVariableByPercentageTerms()	Clears the variable query terms.
void	clearVariableMaximumTerms()	Clears the variable maximum query terms.
void	clearVariableMinimumTerms()	Clears the variable minimum query terms.
void	clearVariableTerms()	Clears the variable query terms.
void	clearVersionSinceTerms()	Clears the version since query terms.
void	clearVersionTerms()	Clears the version query terms.
ControllerQueryRecord	getControllerQueryRecord(Type controllerRecordType)	Gets the controller query record corresponding to the given Controller record Type .
StateQuery	getDiscreetStateQuery()	Gets the query for a State .
ModelQuery	getModelQuery()	Gets the query for a Model .
SystemQuery	getSystemQuery()	Gets the query for a system.
void	matchAddress(String address, Type stringMatchType, boolean match)	Mathes an address.
void	matchAnyDiscreetState(boolean match)	Matches any discreet states.
void	matchAnyModel(boolean match)	Matches any models.
void	matchAnyVariableMaximum(boolean match)	Matches any variable maximums.
void	matchAnyVariableMinimum(boolean match)	Matches any variable minimums.
void	matchAnyVersion(boolean match)	Matches controllers with any version.
void	matchDiscreetStateId(Id stateId, boolean match)	Sets the state Id for this query.
void	matchDiscreetStates(boolean match)	Matches discreet states controllers.
void	matchModelId(Id modelId, boolean match)	Sets the model Id for this query.
void	matchSystemId(Id systemId, boolean match)	Sets the system Id for this query.
void	matchToggleable(boolean match)	Matches toggleable controllers.
void	matchVariable(boolean match)	Matches variable controllers.
void	matchVariableByPercentage(boolean match)	Matches variable by percentage controllers.
void	matchVariableMaximum(BigDecimal start, BigDecimal end, boolean match)	Matches variable maximums between the given range inclusive.
void	matchVariableMinimum(BigDecimal start, BigDecimal end, boolean match)	Matches variable minimums between the given range inclusive.
void	matchVersion(Version version, boolean match)	Sets the version for this query.
void	matchVersionSince(Version version, boolean match)	Matches controllers with versions including and more recent than the given version.
boolean	supportsDiscreetStateQuery()	Tests if a StateQuery is available.
boolean	supportsModelQuery()	Tests if a ModelQuery is available.
boolean	supportsSystemQuery()	Tests if a SystemQuery 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, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

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

Method Details

matchAddress

void matchAddress(String address,
 Type stringMatchType,
 boolean match)

Mathes an address.

Parameters:

address - an address

stringMatchType - a string match type

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

Throws:

NullArgumentException - address or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

clearAddressTerms

void clearAddressTerms()

Clears the address query terms.

Compliance:

mandatory - This method must be implemented.

matchModelId

void matchModelId(Id modelId,
 boolean match)

Sets the model Id for this query.

Parameters:

modelId - the model Id

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

Throws:

NullArgumentException - modelId is null

Compliance:

mandatory - This method must be implemented.

clearModelIdTerms

void clearModelIdTerms()

Clears the model Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsModelQuery

boolean supportsModelQuery()

Tests if a ModelQuery is available.

Returns:

true if a model query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getModelQuery

ModelQuery getModelQuery()

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

Returns:

the model query

Throws:

UnimplementedException - supportsModelQuery() is false

Compliance:

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

matchAnyModel

void matchAnyModel(boolean match)

Matches any models.

Parameters:

match - true to match controllers with models, false to match controllers with no model defined

Compliance:

mandatory - This method must be implemented.

clearModelTerms

void clearModelTerms()

Clears the model query terms.

Compliance:

mandatory - This method must be implemented.

matchVersion

void matchVersion(Version version,
 boolean match)

Sets the version for this query.

Parameters:

version - the version

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

Throws:

NullArgumentException - version is null

Compliance:

mandatory - This method must be implemented.

matchAnyVersion

void matchAnyVersion(boolean match)

Matches controllers with any version.

Parameters:

match - true to match controllers with versions, false to match controllers with no version defined

Compliance:

mandatory - This method must be implemented.

clearVersionTerms

void clearVersionTerms()

Clears the version query terms.

Compliance:

mandatory - This method must be implemented.

matchVersionSince

void matchVersionSince(Version version,
 boolean match)

Matches controllers with versions including and more recent than the given version.

Parameters:

version - the version

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

Throws:

NullArgumentException - version is null

Compliance:

mandatory - This method must be implemented.

clearVersionSinceTerms

void clearVersionSinceTerms()

Clears the version since query terms.

Compliance:

mandatory - This method must be implemented.

matchToggleable

void matchToggleable(boolean match)

Matches toggleable controllers.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearToggleableTerms

void clearToggleableTerms()

Clears the toggleable query terms.

Compliance:

mandatory - This method must be implemented.

matchVariable

void matchVariable(boolean match)

Matches variable controllers.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearVariableTerms

void clearVariableTerms()

Clears the variable query terms.

Compliance:

mandatory - This method must be implemented.

matchVariableByPercentage

void matchVariableByPercentage(boolean match)

Matches variable by percentage controllers.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearVariableByPercentageTerms

void clearVariableByPercentageTerms()

Clears the variable query terms.

Compliance:

mandatory - This method must be implemented.

matchVariableMinimum

void matchVariableMinimum(BigDecimal start,
 BigDecimal end,
 boolean match)

Matches variable minimums between the given range inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyVariableMinimum

void matchAnyVariableMinimum(boolean match)

Matches any variable minimums.

Parameters:

match - true to match controllers with variable minimums, false to match controllers with no variable minimums

Compliance:

mandatory - This method must be implemented.

clearVariableMinimumTerms

void clearVariableMinimumTerms()

Clears the variable minimum query terms.

Compliance:

mandatory - This method must be implemented.

matchVariableMaximum

void matchVariableMaximum(BigDecimal start,
 BigDecimal end,
 boolean match)

Matches variable maximums between the given range inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyVariableMaximum

void matchAnyVariableMaximum(boolean match)

Matches any variable maximums.

Parameters:

match - true to match controllers with variable maximums, false to match controllers with no variable maximums

Compliance:

mandatory - This method must be implemented.

clearVariableMaximumTerms

void clearVariableMaximumTerms()

Clears the variable maximum query terms.

Compliance:

mandatory - This method must be implemented.

matchDiscreetStates

void matchDiscreetStates(boolean match)

Matches discreet states controllers.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDiscreetStatesTerms

void clearDiscreetStatesTerms()

Clears the discreet states query terms.

Compliance:

mandatory - This method must be implemented.

matchDiscreetStateId

void matchDiscreetStateId(Id stateId,
 boolean match)

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

clearDiscreetStateIdTerms

void clearDiscreetStateIdTerms()

Clears the state Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDiscreetStateQuery

boolean supportsDiscreetStateQuery()

Tests if a StateQuery is available.

Returns:

true if a state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDiscreetStateQuery

StateQuery getDiscreetStateQuery()

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

Returns:

the state query

Throws:

UnimplementedException - supportsDiscreetStateQuery() is false

Compliance:

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

matchAnyDiscreetState

void matchAnyDiscreetState(boolean match)

Matches any discreet states.

Parameters:

match - true to match controllers with discreet states, false to match controllers with no discreet states

Compliance:

mandatory - This method must be implemented.

clearDiscreetStateTerms

void clearDiscreetStateTerms()

Clears the state query terms.

Compliance:

mandatory - This method must be implemented.

matchSystemId

void matchSystemId(Id systemId,
 boolean match)

Sets the system Id for this query.

Parameters:

systemId - the system Id

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

Throws:

NullArgumentException - systemId is null

Compliance:

mandatory - This method must be implemented.

clearSystemIdTerms

void clearSystemIdTerms()

Clears the system Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSystemQuery

boolean supportsSystemQuery()

Tests if a SystemQuery is available.

Returns:

true if a system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSystemQuery

SystemQuery getSystemQuery()

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

Returns:

the system query

Throws:

UnimplementedException - supportsSystemQuery() is false

Compliance:

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

clearSystemTerms

void clearSystemTerms()

Clears the system query terms.

Compliance:

mandatory - This method must be implemented.

getControllerQueryRecord

ControllerQueryRecord getControllerQueryRecord(Type controllerRecordType)
                                        throws OperationFailedException

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

Parameters:

controllerRecordType - a controller record type

Returns:

the controller query record

Throws:

NullArgumentException - controllerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(controllerRecordType) is false

Compliance:

mandatory - This method must be implemented.