OSID Logo
OSID Specifications
room batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.batch.FloorBatchAdminSession
Implementsosid.room.FloorAdminSession
Description

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

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

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

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

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

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

MethodgetFloorFormsForCreate
Description

Gets the floor forms for creating a bunch of new floors. A FloorForm is returned for each building Id.

Parametersosid.id.IdListbuildingIdsan Id of a building
osid.type.Type[]floorRecordTypesarray of floor record types to be included in each create operation or an empty list if none
Returnosid.room.batch.FloorBatchFormListthe floor forms
ErrorsNOT_FOUNDa buildingId is not found
NULL_ARGUMENT buildingId or floorRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateFloors
Description

Creates a new set of Floors. 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.batch.FloorBatchFormListfloorFormsthe floor forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT floorForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorFormsForUpdate
Description

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

Parametersosid.id.IdListfloorIdsthe Ids of the Floor
Returnosid.room.batch.FloorBatchFormListthe floor form
ErrorsNOT_FOUNDa floorId is not found
NULL_ARGUMENT floorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateFloors
Description

Updates existing floors. 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.batch.FloorBatchFormListfloorFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT floorForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllFloors
Description

Deletes all Floors in this Campus .

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

Deletes floors for the given Ids.

Parametersosid.id.IdListfloorIdsthe Ids of the floors to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT floorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteFloorsForBuilding
Description

Deletes all floors for the given building.

Parametersosid.id.IdbuildingIdan Id of a building
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveFloorsByDate
Description

Deletes floors 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.
MethodaliasFloors
Description

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