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.
Modifier and Type | Method and 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(java.lang.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(java.math.BigDecimal start,
java.math.BigDecimal end,
boolean match)
Matches variable maximums between the given range inclusive.
|
void |
matchVariableMinimum(java.math.BigDecimal start,
java.math.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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchAddress(java.lang.String address, Type stringMatchType, boolean match)
address
- an addressstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- address
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void clearAddressTerms()
mandatory
- This method must be implemented. void matchModelId(Id modelId, boolean match)
Id
for this query.modelId
- the model Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- modelId
is
null
mandatory
- This method must be implemented. void clearModelIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsModelQuery()
ModelQuery
is available. true
if a model query is available,
false
otherwisemandatory
- This method must be implemented. ModelQuery getModelQuery()
Model.
Multiple retrievals produce
a nested OR
term.UnimplementedException
- supportsModelQuery()
is false
optional
- This method must be implemented if
supportsModelQuery()
is true.
void matchAnyModel(boolean match)
match
- true
to match controllers with models,
false
to match controllers with no model
definedmandatory
- This method must be implemented. void clearModelTerms()
mandatory
- This method must be implemented. void matchVersion(Version version, boolean match)
version
- the versionmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- version
is
null
mandatory
- This method must be implemented. void matchAnyVersion(boolean match)
match
- true
to match controllers with versions,
false
to match controllers with no version
definedmandatory
- This method must be implemented. void clearVersionTerms()
mandatory
- This method must be implemented. void matchVersionSince(Version version, boolean match)
version
- the versionmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- version
is
null
mandatory
- This method must be implemented. void clearVersionSinceTerms()
mandatory
- This method must be implemented. void matchToggleable(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearToggleableTerms()
mandatory
- This method must be implemented. void matchVariable(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearVariableTerms()
mandatory
- This method must be implemented. void matchVariableByPercentage(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearVariableByPercentageTerms()
mandatory
- This method must be implemented. void matchVariableMinimum(java.math.BigDecimal start, java.math.BigDecimal end, boolean match)
start
- start of rangeend
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
NullArgumentException
- start or end
is
null
mandatory
- This method must be implemented. void matchAnyVariableMinimum(boolean match)
match
- true
to match controllers with variable
minimums, false
to match controllers with no
variable minimumsmandatory
- This method must be implemented. void clearVariableMinimumTerms()
mandatory
- This method must be implemented. void matchVariableMaximum(java.math.BigDecimal start, java.math.BigDecimal end, boolean match)
start
- start of rangeend
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
NullArgumentException
- start or end
is
null
mandatory
- This method must be implemented. void matchAnyVariableMaximum(boolean match)
match
- true
to match controllers with variable
maximums, false
to match controllers with no
variable maximumsmandatory
- This method must be implemented. void clearVariableMaximumTerms()
mandatory
- This method must be implemented. void matchDiscreetStates(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearDiscreetStatesTerms()
mandatory
- This method must be implemented. void matchDiscreetStateId(Id stateId, boolean match)
Id
for this query.stateId
- the state Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearDiscreetStateIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDiscreetStateQuery()
StateQuery
is available. true
if a state query is available,
false
otherwisemandatory
- This method must be implemented. StateQuery getDiscreetStateQuery()
State.
Multiple retrievals produce
a nested OR
term.UnimplementedException
-
supportsDiscreetStateQuery()
is false
optional
- This method must be implemented if
supportsDiscreetStateQuery()
is true.
void matchAnyDiscreetState(boolean match)
match
- true
to match controllers with discreet
states, false
to match controllers with no
discreet statesmandatory
- This method must be implemented. void clearDiscreetStateTerms()
mandatory
- This method must be implemented. void matchSystemId(Id systemId, boolean match)
Id
for this query.systemId
- the system Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- systemId
is
null
mandatory
- This method must be implemented. void clearSystemIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsSystemQuery()
SystemQuery
is available. true
if a system query is available,
false
otherwisemandatory
- This method must be implemented. SystemQuery getSystemQuery()
OR
term.UnimplementedException
- supportsSystemQuery()
is false
optional
- This method must be implemented if
supportsSystemQuery()
is true.
void clearSystemTerms()
mandatory
- This method must be implemented. ControllerQueryRecord getControllerQueryRecord(Type controllerRecordType) throws OperationFailedException
Controller
record Type.
Multiple record
retrievals produce a nested OR
term.controllerRecordType
- a controller record typeNullArgumentException
- controllerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(controllerRecordType)
is false
mandatory
- This method must be implemented.