OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CommissionForm
Implementsosid.OsidRelationshipForm
Description

This is the form for creating and updating Commissions. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CommissionAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCompetencyMetadata
Description

Gets the metadata for the competency.

Returnosid.Metadatametadata for the competency
CompliancemandatoryThis method must be implemented.
MethodsetCompetency
Description

Sets the competency.

Parametersosid.id.IdcompetencyIdthe new competency
ErrorsINVALID_ARGUMENT competencyId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT competencyId is null
CompliancemandatoryThis method must be implemented.
MethodclearCompetency
Description

Removes the competency.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPercentageMetadata
Description

Gets the metadata for the percentage availability.

Returnosid.Metadatametadata for the percentage availability
CompliancemandatoryThis method must be implemented.
MethodsetPercentage
Description

Sets the percent availability.

Parameterscardinalavailabilitythe new percentage vaailability
ErrorsINVALID_ARGUMENT availability is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearPercentage
Description

Removes the percentage availability.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCommissionFormRecord
Description

Gets the CommissionFormRecord corresponding to the given commission record Type.

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