org.osid.resourcing

Interface CommissionQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchResourceId

void matchResourceId(Id resourceId,
                   boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - the resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

Gets the query for a resource. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

optional - This method must be implemented if supportsResourceQuery() is true.

clearResourceTerms

void clearResourceTerms()

Clears the resource query terms.

Compliance:

mandatory - This method must be implemented.

matchWorkId

void matchWorkId(Id workId,
               boolean match)

Sets the work Id for this query.

Parameters:

workId - the work Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - workId is null

Compliance:

mandatory - This method must be implemented.

clearWorkIdTerms

void clearWorkIdTerms()

Clears the work Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsWorkQuery

boolean supportsWorkQuery()

Tests if a WorkQuery is available.

Returns:

true if a work query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getWorkQuery

WorkQuery getWorkQuery()

Gets the query for a work. Multiple retrievals produce a nested OR term.

Returns:

the work query

Throws:

UnimplementedException - supportsWorkQuery() is false

Compliance:

optional - This method must be implemented if supportsWorkQuery() is true.

clearWorkTerms

void clearWorkTerms()

Clears the work query terms.

Compliance:

mandatory - This method must be implemented.

matchCompetencyId

void matchCompetencyId(Id competencyId,
                     boolean match)

Sets the competency Id for this query.

Parameters:

competencyId - the competency Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - competencyId is null

Compliance:

mandatory - This method must be implemented.

clearCompetencyIdTerms

void clearCompetencyIdTerms()

Clears the competency Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCompetencyQuery

boolean supportsCompetencyQuery()

Tests if a CompetencyQuery is available.

Returns:

true if a competency query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCompetencyQuery

CompetencyQuery getCompetencyQuery()

Gets the query for a competency. Multiple retrievals produce a nested OR term.

Returns:

the competency query

Throws:

UnimplementedException - supportsCompetencyQuery() is false

Compliance:

optional - This method must be implemented if supportsCompetencyQuery() is true.

clearCompetencyTerms

void clearCompetencyTerms()

Clears the competency query terms.

Compliance:

mandatory - This method must be implemented.

matchPercentage

void matchPercentage(long low,
                   long high,
                   boolean match)

Matches percentages within the given range inclusive.

Parameters:

low - start range

high - end range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearPercentageTerms

void clearPercentageTerms()

Clears the percentage query terms.

Compliance:

mandatory - This method must be implemented.

matchFoundryId

void matchFoundryId(Id foundryId,
                  boolean match)

Sets the foundry Id for this query to match commissions assigned to foundries.

Parameters:

foundryId - the foundry Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

matchEffortId

void matchEffortId(Id effortId,
                 boolean match)

Sets the effort Id for this query.

Parameters:

effortId - the effort Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - effortId is null

Compliance:

mandatory - This method must be implemented.

clearEffortIdTerms

void clearEffortIdTerms()

Clears the effort Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsEffortQuery

boolean supportsEffortQuery()

Tests if an EffortQuery is available.

Returns:

true if an effort query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEffortQuery

EffortQuery getEffortQuery()

Gets the query for an effort. Multiple retrievals produce a nested OR term.

Returns:

the effort query

Throws:

UnimplementedException - supportsEffortQuery() is false

Compliance:

optional - This method must be implemented if supportsEffortQuery() is true.

matchAnyEffort

void matchAnyEffort(boolean match)

Matches commissions with any effort.

Parameters:

match - true to match commissions with any effort, false to match commissions with no effort

Compliance:

mandatory - This method must be implemented.

clearEffortTerms

void clearEffortTerms()

Clears the effort query terms.

Compliance:

mandatory - This method must be implemented.

clearFoundryIdTerms

void clearFoundryIdTerms()

Clears the foundry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFoundryQuery

boolean supportsFoundryQuery()

Tests if a FoundryQuery is available.

Returns:

true if a foundry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFoundryQuery

FoundryQuery getFoundryQuery()

Gets the query for a foundry. Multiple retrievals produce a nested OR term.

Returns:

the foundry query

Throws:

UnimplementedException - supportsFoundryQuery() is false

Compliance:

optional - This method must be implemented if supportsFoundryQuery() is true.

clearFoundryTerms

void clearFoundryTerms()

Clears the foundry query terms.

Compliance:

mandatory - This method must be implemented.

getCommissionQueryRecord

CommissionQueryRecord getCommissionQueryRecord(Type commissionRecordType)
                                               throws OperationFailedException

Gets the commission query record corresponding to the given Commission record Type. Multiple record retrievals produce a nested OR term.

Parameters:

commissionRecordType - a commission record type

Returns:

the commission query record

Throws:

NullArgumentException - commissionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commissionRecordType) is false

Compliance:

mandatory - This method must be implemented.