org.osid.control

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

Methods

Modifier and Type	Method and 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.
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(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches variable amount between the given range inclusive.
void	matchVariablePercentage(java.math.BigDecimal start, java.math.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 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

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 supportsControllerQuery() is 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(java.math.BigDecimal start,
                           java.math.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(java.math.BigDecimal start,
                       java.math.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 supportsDiscreetStateQuery() is 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 supportsSystemQuery() is 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.