Interface SettingQuery

All Superinterfaces:

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

public interface SettingQuery
extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching settings. 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	clearControllerIdTerms()	Clears the controller Id query terms.
void	clearControllerTerms()	Clears the controller query terms.
void	clearDiscreetStateIdTerms()	Clears the state Id query terms.
void	clearDiscreetStateTerms()	Clears the state query terms.
void	clearOffTerms()	Clears the off query terms.
void	clearOnTerms()	Clears the on query terms.
void	clearRampRateTerms()	Clears the ramp rate query terms.
void	clearSystemIdTerms()	Clears the system Id query terms.
void	clearSystemTerms()	Clears the system query terms.
void	clearVariableAmountTerms()	Clears the variable amount query terms.
void	clearVariablePercentageTerms()	Clears the variable percentages query terms.
ControllerQuery	getControllerQuery()	Gets the query for a InputQntry .
StateQuery	getDiscreetStateQuery()	Gets the query for a State .
SettingQueryRecord	getSettingQueryRecord(Type settingRecordType)	Gets the query record corresponding to the given Setting record Type .Multiple record retrievals produce a nested OR term.
SystemQuery	getSystemQuery()	Gets the query for a system.
void	matchAnyDiscreetState(boolean match)	Matches any discreet states.
void	matchAnyRampRate(boolean match)	Matches any ramp rate.
void	matchAnyVariableAmount(boolean match)	Matches any variable amount.
void	matchAnyVariablePercentage(boolean match)	Matches any variable percentages.
void	matchControllerId(Id controllerId, boolean match)	Sets the controller Id for this query.
void	matchDiscreetStateId(Id stateId, boolean match)	Sets the state Id for this query.
void	matchOff(boolean match)	Matches off settings.
void	matchOn(boolean match)	Matches on settings.
void	matchRampRate(Duration start, Duration end, boolean match)	Matches ramp rates between the given range inclusive.
void	matchSystemId(Id systemId, boolean match)	Sets the system Id for this query to match controllers assigned to systems.
void	matchVariableAmount(BigDecimal start, BigDecimal end, boolean match)	Matches variable amount between the given range inclusive.
void	matchVariablePercentage(BigDecimal start, BigDecimal end, boolean match)	Matches variable percentages between the given range inclusive.
boolean	supportsControllerQuery()	Tests if a ControllerQuery is available.
boolean	supportsDiscreetStateQuery()	Tests if a StateQuery 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 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

matchControllerId

void matchControllerId(Id controllerId,
 boolean match)

Sets the controller Id for this query.

Parameters:

controllerId - the controller Id

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

Throws:

NullArgumentException - controllerId is null

Compliance:

mandatory - This method must be implemented.

clearControllerIdTerms

void clearControllerIdTerms()

Clears the controller Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsControllerQuery

boolean supportsControllerQuery()

Tests if a ControllerQuery is available.

Returns:

true if a controller query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getControllerQuery

ControllerQuery getControllerQuery()

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

Returns:

the controller query

Throws:

UnimplementedException - supportsControllerQuery() is false

Compliance:

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

clearControllerTerms

void clearControllerTerms()

Clears the controller query terms.

Compliance:

mandatory - This method must be implemented.

matchOn

void matchOn(boolean match)

Matches on settings.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearOnTerms

void clearOnTerms()

Clears the on query terms.

Compliance:

mandatory - This method must be implemented.

matchOff

void matchOff(boolean match)

Matches off settings.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearOffTerms

void clearOffTerms()

Clears the off query terms.

Compliance:

mandatory - This method must be implemented.

matchVariablePercentage

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

Matches variable percentages 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.

matchAnyVariablePercentage

void matchAnyVariablePercentage(boolean match)

Matches any variable percentages.

Parameters:

match - true to match settings with variable percentages, false to match settings with no variable percentages

Compliance:

mandatory - This method must be implemented.

clearVariablePercentageTerms

void clearVariablePercentageTerms()

Clears the variable percentages query terms.

Compliance:

mandatory - This method must be implemented.

matchVariableAmount

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

Matches variable amount 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.

matchAnyVariableAmount

void matchAnyVariableAmount(boolean match)

Matches any variable amount.

Parameters:

match - true to match settings with variable amounts, false to match settings with no variable amounts

Compliance:

mandatory - This method must be implemented.

clearVariableAmountTerms

void clearVariableAmountTerms()

Clears the variable amount 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 settings with discreet states, false to match settings 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.

matchRampRate

void matchRampRate(Duration start,
 Duration end,
 boolean match)

Matches ramp rates 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.

matchAnyRampRate

void matchAnyRampRate(boolean match)

Matches any ramp rate.

Parameters:

match - true to match settings with ramp rates, false to match settings with no ramp rates

Compliance:

mandatory - This method must be implemented.

clearRampRateTerms

void clearRampRateTerms()

Clears the ramp rate query terms.

Compliance:

mandatory - This method must be implemented.

matchSystemId

void matchSystemId(Id systemId,
 boolean match)

Sets the system Id for this query to match controllers assigned to systems.

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.

getSettingQueryRecord

SettingQueryRecord getSettingQueryRecord(Type settingRecordType)
                                  throws OperationFailedException

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

Parameters:

settingRecordType - a setting record type

Returns:

the setting query record

Throws:

NullArgumentException - settingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(settingRecordType) is false

Compliance:

mandatory - This method must be implemented.