OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.CommissionBatchAdminSession
Implementsosid.resourcing.CommissionAdminSession
Description

This session creates, updates, and deletes Commissions in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Commission, a CommissionForm is requested using getCommissionFormsForCreate() specifying the desired work, resource, and record Types or none if no record Types are needed. Each of the returned CommissionForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a CommissionForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CommissionForm corresponds to an attempted transaction.

The CommissionForms returned from getCommissionFormsForCreate() may be linked to the originating request through the peer Ids of the CommissionForm. In the case where there may be duplicates, any CommissionForm of the same peer Ids may be used for a create operation.

Once a batch of CommissionForms are submitted for create, a CreateResponse is returned for each CommissionForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createCommissions(), errors specific to an individual CommissionForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating CommissionForm through the CommissionForm Id .

For updates, CommissionForms are requested to the Commission Id that is to be updated using getCommissionFormsForUpdate() where the reference Id in the CommissionForm may be used to link the request. Similarly, the CommissionForm has metadata about the data that can be updated and it can perform validation before submitting the update. The CommissionForm can only be used once for a successful update and cannot be reused.

Once a batch of CommissionForms are submitted for update, an UpdateResponse is returned for each CommissionForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateCommissions(), errors specific to an individual CommissionForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating CommissionForm through the CommissionForm Id.

The delete operations delete Commissions in bulk. To unmap a Commission from the current Foundry, the CommissionFoundryAssignmentSession should be used. These delete operations attempt to remove the Commission itself thus removing it from all known Foundry catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetCommissionFormsForCreate
Description

Gets the commission forms for creating a bunch of new commissions. A form is returned for each work and resource pair.

Parametersosid.resourcing.batch.CommissionPeerListpeersthe relationship peers
osid.type.Type[]commissionRecordTypesarray of commission record types to be included in each create operation or an empty list if none
Returnosid.resourcing.batch.CommissionBatchFormListthe commission forms
ErrorsNOT_FOUNDa workId or resourceId is not found
NULL_ARGUMENT peers or commissionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateCommissions
Description

Creates a new set of Commissions. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.resourcing.batch.CommissionBatchFormListcommissionFormsthe commission forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT commissionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionFormsForUpdate
Description

Gets the commission forms for updating an existing set of commissions. A new commission form should be requested for each update transaction.

Parametersosid.id.IdListcommissionIdsthe Ids of the Commission
Returnosid.resourcing.batch.CommissionBatchFormListthe commission form
ErrorsNOT_FOUNDa commissionId is not found
NULL_ARGUMENT commissionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCommissions
Description

Updates existing commissions. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.resourcing.batch.CommissionBatchFormListcommissionFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT commissionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCommissions
Description

Deletes all Commissions in this Foundry .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCommissions
Description

Deletes commissions for the given Ids.

Parametersosid.id.IdListcommissionIdsthe Ids of the commissions to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT commissionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCommissionsForResource
Description

Deletes commissions for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCommissionsForWork
Description

Deletes commissions for the given work.

Parametersosid.id.IdworkIdthe Id of a work
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveCommissionsByDate
Description

Deletes commissions expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCommissions
Description

Adds an Id to a Commission for the purpose of creating compatibility. The primary Id of the Commission is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another commission, it is reassigned to the given commission Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.