OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.CommissionEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching commission enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledCommissionId
Description

Matches mapped to a commission.

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

Clears the commission Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledCommissionQuery
Description

Tests if an CommissionQuery is available.

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

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

Returnosid.resourcing.CommissionQuerythe commission query
ErrorsUNIMPLEMENTED supportsRuledCommissionQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledCommissionQuery() is true.
MethodmatchAnyRuledCommission
Description

Matches mapped to any commission.

Parametersbooleanmatch true for mapped to any commission, false to match mapped to no commissions
CompliancemandatoryThis method must be implemented.
MethodclearRuledCommissionTerms
Description

Clears the commission query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFoundryId
Description

Matches mapped to the foundry.

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.
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.
MethodgetCommissionEnablerQueryRecord
Description

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

Parametersosid.type.TypecommissionEnablerRecordTypean commission enabler record type
Returnosid.resourcing.rules.records.CommissionEnablerQueryRecordthe commission enabler query record
ErrorsNULL_ARGUMENT commissionEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commissionEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.