OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.OfferingBatchAdminSession
Implementsosid.offering.OfferingAdminSession
Description

This session creates, updates, and deletes Offerings 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 an Offering, an OfferingForm is requested using getOfferingFormsForCreate() specifying the desired canonical unit, time period, and record Types or none if no record Types are needed. Each of the returned OfferingForms 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 an OfferingForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each OfferingForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Offerings in bulk. To unmap an Offering from the current Catalogue, the OfferingCatalogueAssignmentSession should be used. These delete operations attempt to remove the Offering itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetOfferingFormsForCreate
Description

Gets the offeringforms for creating a bunch of new offerings. A new result form is returned for each supplied canonical unit and time period.

Parametersosid.offering.batch.OfferingPeerListpeersa list of canonical unit peers
osid.type.Type[]offeringRecordTypesarray of offering record types to be included in each create operation or an empty list if none
Returnosid.offering.batch.OfferingBatchFormListthe offeringforms
ErrorsNOT_FOUNDa canonicalUnitId or timePeriodId is not found
NULL_ARGUMENT peers or offeringRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateOfferings
Description

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

Parametersosid.offering.batch.OfferingBatchFormListofferingFormsthe offering forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT offeringForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfferingFormsForUpdate
Description

Gets the offering forms for updating an existing set of offerings. A new offeringform should be requested for each update transaction.

Parametersosid.id.IdListofferingIdsthe Ids of the Offering
Returnosid.offering.batch.OfferingBatchFormListthe offering form
ErrorsNOT_FOUNDan offeringId is not found
NULL_ARGUMENT offeringIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOfferings
Description

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

Parametersosid.offering.batch.OfferingBatchFormListofferingFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT offeringForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllOfferings
Description

Deletes all Offerings in this Catalogue .

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

Deletes offerings for the given Ids.

Parametersosid.id.IdListofferingIdsthe Ids of the offerings to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT offeringIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteOfferingsForCanonicalUnit
Description

Deletes all offerings mapped to the given canonical unit.

Parametersosid.id.IdcanonicalUnitIdan Id of a canonical unit
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteOfferingsForTimePeriod
Description

Deletes all offerings mapped to the given time period.

Parametersosid.id.IdtimePeriodIdan Id of a time period
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasOfferings
Description

Adds an Id to an Offering for the purpose of creating compatibility. The primary Id of the Offering is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another offering, it is reassigned to the given offering 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.