OSID Logo
OSID Specifications
room construction batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.batch.RenovationBatchAdminSession
Implementsosid.room.construction.RenovationAdminSession
Description

This session creates, updates, and deletes Renovations 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 Renovation, a RenovationForm is requested using getRenovationFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned RenovationForms 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 RenovationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RenovationForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Renovations in bulk. To unmap a Renovation from the current Campus, the RenovationCampusAssignmentSession should be used. These delete operations attempt to remove the Renovation itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetRenovationFormsForCreate
Description

Gets the renovation forms for creating a bunch of new renovations.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]renovationRecordTypesarray of renovation record types to be included in each create operation or an empty list if none
Returnosid.room.construction.batch.RenovationBatchFormListthe renovation forms
ErrorsNULL_ARGUMENT renovationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRenovations
Description

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

Parametersosid.room.construction.batch.RenovationBatchFormListrenovationFormsthe renovation forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT renovationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationFormsForUpdate
Description

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

Parametersosid.id.IdListrenovationIdsthe Ids of the Renovation
Returnosid.room.construction.batch.RenovationBatchFormListthe renovation form
ErrorsNOT_FOUNDa renovationId is not found
NULL_ARGUMENT renovationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRenovations
Description

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

Parametersosid.room.construction.batch.RenovationBatchFormListrenovationFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT renovationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRenovations
Description

Deletes all Renovations in this Campus .

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

Deletes renovations for the given Ids.

Parametersosid.id.IdListrenovationIdsthe Ids of the renovations to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT renovationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveRenovationsByDate
Description

Deletes renovations 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.
MethodaliasRenovations
Description

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