public interface ProvisionableQuery extends OsidRelationshipQuery
This is the query for searching provisionables. 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 |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearPoolIdTerms()
Clears the pool
Id query terms. |
void |
clearPoolTerms()
Clears the pool query terms.
|
void |
clearResourceIdTerms()
Clears the resource
Id query terms. |
void |
clearResourceTerms()
Clears the resource query terms.
|
void |
clearUseTerms()
Clears the position query terms.
|
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
PoolQuery |
getPoolQuery()
Gets the query for a pool.
|
ProvisionableQueryRecord |
getProvisionableQueryRecord(Type provisionableRecordType)
Gets the query record corresponding to the given
Provisionable
record Type. |
ResourceQuery |
getResourceQuery()
Gets the query for a resource.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Sets the distributor
Id for this query to match queues
assigned to distributors. |
void |
matchPoolId(Id poolId,
boolean match)
Sets the pool
Id for this query. |
void |
matchResourceId(Id resourceId,
boolean match)
Sets the resource
Id for this query. |
void |
matchUse(long start,
long end,
boolean match)
Matches provisionables provisioned the number of times in the given
range inclusive.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsPoolQuery()
Tests if a
PoolQuery is available. |
boolean |
supportsResourceQuery()
Tests if a
ResourceQuery is available. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchPoolId(Id poolId, boolean match)
Id
for this query.poolId
- the pool Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- poolId
is
null
mandatory
- This method must be implemented. void clearPoolIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPoolQuery()
PoolQuery
is available. true
if a pool query is available, false
otherwisemandatory
- This method must be implemented. PoolQuery getPoolQuery()
OR
term.UnimplementedException
- supportsPoolQuery()
is false
optional
- This method must be implemented if
supportsPoolQuery()
is true.
void clearPoolTerms()
mandatory
- This method must be implemented. void matchResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- the resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
mandatory
- This method must be implemented. void matchUse(long start, long 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
mandatory
- This method must be implemented. void clearUseTerms()
mandatory
- This method must be implemented. void matchDistributorId(Id distributorId, boolean match)
Id
for this query to match queues
assigned to distributors.distributorId
- the broker Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- distributorId
is
null
mandatory
- This method must be implemented. void clearDistributorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDistributorQuery()
DistributorQuery
is available. true
if a distributor query is available,
false
otherwisemandatory
- This method must be implemented. DistributorQuery getDistributorQuery()
OR
term.UnimplementedException
-
supportsDistributorQuery()
is false
optional
- This method must be implemented if
supportsDistributorQuery()
is true.
void clearDistributorTerms()
mandatory
- This method must be implemented. ProvisionableQueryRecord getProvisionableQueryRecord(Type provisionableRecordType) throws OperationFailedException
Provisionable
record Type.
Multiple record retrievals produce
a nested OR
term.provisionableRecordType
- a provisionable record typeNullArgumentException
- provisionableRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionableRecordType)
is false
mandatory
- This method must be implemented.