OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CommissionQuery
Implementsosid.OsidRelationshipQuery
Description

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.

MethodmatchResourceId
Description

Sets the resource Id for this query.

Parametersosid.id.IdresourceIdthe resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResourceQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodclearResourceTerms
Description

Clears the resource query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWorkId
Description

Sets the work Id for this query.

Parametersosid.id.IdworkIdthe work Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT workId is null
CompliancemandatoryThis method must be implemented.
MethodclearWorkIdTerms
Description

Clears the work Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsWorkQuery
Description

Tests if a WorkQuery is available.

Returnboolean true if a work query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetWorkQuery
Description

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

Returnosid.resourcing.WorkQuerythe work query
ErrorsUNIMPLEMENTED supportsWorkQuery() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() is true.
MethodclearWorkTerms
Description

Clears the work query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCompetencyId
Description

Sets the competency Id for this query.

Parametersosid.id.IdcompetencyIdthe competency Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT competencyId is null
CompliancemandatoryThis method must be implemented.
MethodclearCompetencyIdTerms
Description

Clears the competency Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCompetencyQuery
Description

Tests if a CompetencyQuery is available.

Returnboolean true if a competency query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCompetencyQuery
Description

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

Returnosid.resourcing.CompetencyQuerythe competency query
ErrorsUNIMPLEMENTED supportsCompetencyQuery() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyQuery() is true.
MethodclearCompetencyTerms
Description

Clears the competency query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPercentage
Description

Matches percentages within the given range inclusive.

Parameterscardinallowstart range
cardinalhighend range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearPercentageTerms
Description

Clears the percentage query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFoundryId
Description

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

Parametersosid.id.IdfoundryIdthe foundry Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT foundryId is null
CompliancemandatoryThis method must be implemented.
MethodmatchEffortId
Description

Sets the effort Id for this query.

Parametersosid.id.IdeffortIdthe effort Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT effortId is null
CompliancemandatoryThis method must be implemented.
MethodclearEffortIdTerms
Description

Clears the effort Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEffortQuery
Description

Tests if an EffortQuery is available.

Returnboolean true if an effort query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEffortQuery
Description

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

Returnosid.resourcing.EffortQuerythe effort query
ErrorsUNIMPLEMENTED supportsEffortQuery() is false
ComplianceoptionalThis method must be implemented if supportsEffortQuery() is true.
MethodmatchAnyEffort
Description

Matches commissions with any effort.

Parametersbooleanmatch true to match commissions with any effort, false to match commissions with no effort
CompliancemandatoryThis method must be implemented.
MethodclearEffortTerms
Description

Clears the effort query terms.

CompliancemandatoryThis method must be implemented.
MethodclearFoundryIdTerms
Description

Clears the foundry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFoundryQuery
Description

Tests if a FoundryQuery is available.

Returnboolean true if a foundry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFoundryQuery
Description

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

Returnosid.resourcing.FoundryQuerythe foundry query
ErrorsUNIMPLEMENTED supportsFoundryQuery() is false
ComplianceoptionalThis method must be implemented if supportsFoundryQuery() is true.
MethodclearFoundryTerms
Description

Clears the foundry query terms.

CompliancemandatoryThis method must be implemented.
MethodgetCommissionQueryRecord
Description

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

Parametersosid.type.TypecommissionRecordTypea commission record type
Returnosid.resourcing.records.CommissionQueryRecordthe commission query record
ErrorsNULL_ARGUMENT commissionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commissionRecordType) is false
CompliancemandatoryThis method must be implemented.