public interface CommissionQuery extends OsidRelationshipQuery
This is the query for searching commissions. 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 |
clearEffortIdTerms()
Clears the effort
Id query terms. |
void |
clearEffortTerms()
Clears the effort query terms.
|
void |
clearFoundryIdTerms()
Clears the foundry
Id query terms. |
void |
clearFoundryTerms()
Clears the foundry query terms.
|
void |
clearPercentageTerms()
Clears the percentage query terms.
|
void |
clearResourceIdTerms()
Clears the resource
Id query terms. |
void |
clearResourceTerms()
Clears the resource query terms.
|
void |
clearWorkIdTerms()
Clears the work
Id query terms. |
void |
clearWorkTerms()
Clears the work query terms.
|
CommissionQueryRecord |
getCommissionQueryRecord(Type commissionRecordType)
Gets the commission query record corresponding to the given
Commission record Type. |
CompetencyQuery |
getCompetencyQuery()
Gets the query for a competency.
|
EffortQuery |
getEffortQuery()
Gets the query for an effort.
|
FoundryQuery |
getFoundryQuery()
Gets the query for a foundry.
|
ResourceQuery |
getResourceQuery()
Gets the query for a resource.
|
WorkQuery |
getWorkQuery()
Gets the query for a work.
|
void |
matchAnyEffort(boolean match)
Matches commissions with any effort.
|
void |
matchCompetencyId(Id competencyId,
boolean match)
Sets the competency
Id for this query. |
void |
matchEffortId(Id effortId,
boolean match)
Sets the effort
Id for this query. |
void |
matchFoundryId(Id foundryId,
boolean match)
Sets the foundry
Id for this query to match commissions
assigned to foundries. |
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. |
void |
matchWorkId(Id workId,
boolean match)
Sets the work
Id for this query. |
boolean |
supportsCompetencyQuery()
Tests if a
CompetencyQuery is available. |
boolean |
supportsEffortQuery()
Tests if an
EffortQuery is available. |
boolean |
supportsFoundryQuery()
Tests if a
FoundryQuery is available. |
boolean |
supportsResourceQuery()
Tests if a
ResourceQuery is available. |
boolean |
supportsWorkQuery()
Tests if a
WorkQuery 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 matchWorkId(Id workId, boolean match)
Id
for this query.workId
- the work Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- workId
is
null
mandatory
- This method must be implemented. void clearWorkIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsWorkQuery()
WorkQuery
is available. true
if a work query is available, false
otherwisemandatory
- This method must be implemented. WorkQuery getWorkQuery()
OR
term.UnimplementedException
- supportsWorkQuery()
is false
optional
- This method must be implemented if
supportsWorkQuery()
is true.
void clearWorkTerms()
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 commissions
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 matchEffortId(Id effortId, boolean match)
Id
for this query.effortId
- the effort Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- effortId
is
null
mandatory
- This method must be implemented. void clearEffortIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsEffortQuery()
EffortQuery
is available. true
if an effort query is available,
false
otherwisemandatory
- This method must be implemented. EffortQuery getEffortQuery()
OR
term.UnimplementedException
- supportsEffortQuery()
is false
optional
- This method must be implemented if
supportsEffortQuery()
is true.
void matchAnyEffort(boolean match)
match
- true
to match commissions with any
effort, false
to match commissions with no
effortmandatory
- This method must be implemented. void clearEffortTerms()
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. CommissionQueryRecord getCommissionQueryRecord(Type commissionRecordType) throws OperationFailedException
Commission
record Type.
Multiple record
retrievals produce a nested OR
term.commissionRecordType
- a commission record typeNullArgumentException
- commissionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commissionRecordType)
is false
mandatory
- This method must be implemented.