public interface AvailabilityQuery extends OsidRelationshipQuery
This is the query for searching availabilities. 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 |
clearCompetencyIdTerms()
Clears the competency
Id query terms. |
void |
clearCompetencyTerms()
Clears the competency query terms.
|
void |
clearFoundryIdTerms()
Clears the foundry
Id query terms. |
void |
clearFoundryTerms()
Clears the foundry query terms.
|
void |
clearJobIdTerms()
Clears the job
Id query terms. |
void |
clearJobTerms()
Clears the job query terms.
|
void |
clearPercentageTerms()
Clears the percentage query terms.
|
void |
clearResourceIdTerms()
Clears the resource
Id query terms. |
void |
clearResourceTerms()
Clears the resource query terms.
|
AvailabilityQueryRecord |
getAvailabilityQueryRecord(Type availabilityRecordType)
Gets the availability query record corresponding to the given
Availability record Type. |
CompetencyQuery |
getCompetencyQuery()
Gets the query for a competency.
|
FoundryQuery |
getFoundryQuery()
Gets the query for a foundry.
|
JobQuery |
getJobQuery()
Gets the query for a job.
|
ResourceQuery |
getResourceQuery()
Gets the query for a resource.
|
void |
matchCompetencyId(Id competencyId,
boolean match)
Sets the competency
Id for this query. |
void |
matchFoundryId(Id foundryId,
boolean match)
Sets the foundry
Id for this query to match
availabilities assigned to foundries. |
void |
matchJobId(Id jobId,
boolean match)
Sets the job
Id for this query. |
void |
matchPercentage(long low,
long high,
boolean match)
Matches percentages within the given range inclusive.
|
void |
matchResourceId(Id resourceId,
boolean match)
Sets the resource
Id for this query. |
boolean |
supportsCompetencyQuery()
Tests if a
CompetencyQuery is available. |
boolean |
supportsFoundryQuery()
Tests if a
FoundryQuery is available. |
boolean |
supportsJobQuery()
Tests if a
JobQuery 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 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 matchJobId(Id jobId, boolean match)
Id
for this query.jobId
- the job Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- jobId
is
null
mandatory
- This method must be implemented. void clearJobIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsJobQuery()
JobQuery
is available. true
if a job query is available, false
otherwisemandatory
- This method must be implemented. JobQuery getJobQuery()
OR
term.UnimplementedException
- supportsJobQuery()
is false
optional
- This method must be implemented if
supportsJobQuery()
is true.
void clearJobTerms()
mandatory
- This method must be implemented. void matchCompetencyId(Id competencyId, boolean match)
Id
for this query.competencyId
- the competency Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- competencyId
is
null
mandatory
- This method must be implemented. void clearCompetencyIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCompetencyQuery()
CompetencyQuery
is available. true
if a competency query is available,
false
otherwisemandatory
- This method must be implemented. CompetencyQuery getCompetencyQuery()
OR
term.UnimplementedException
-
supportsCompetencyQuery()
is false
optional
- This method must be implemented if
supportsCompetencyQuery()
is true.
void clearCompetencyTerms()
mandatory
- This method must be implemented. void matchPercentage(long low, long high, boolean match)
low
- start rangehigh
- end rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearPercentageTerms()
mandatory
- This method must be implemented. void matchFoundryId(Id foundryId, boolean match)
Id
for this query to match
availabilities assigned to foundries.foundryId
- the foundry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. void clearFoundryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFoundryQuery()
FoundryQuery
is available. true
if a foundry query is available,
false
otherwisemandatory
- This method must be implemented. FoundryQuery getFoundryQuery()
OR
term.UnimplementedException
- supportsFoundryQuery()
is false
optional
- This method must be implemented if
supportsFoundryQuery()
is true.
void clearFoundryTerms()
mandatory
- This method must be implemented. AvailabilityQueryRecord getAvailabilityQueryRecord(Type availabilityRecordType) throws OperationFailedException
Availability
record Type.
Multiple record
retrievals produce a nested OR
term.availabilityRecordType
- an availability record typeNullArgumentException
- availabilityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(availabilityRecordType)
is false
mandatory
- This method must be implemented.