OSID Logo
OSID Specifications
room batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.batch.BuildingBatchAdminSession
Implementsosid.room.BuildingAdminSession
Description

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

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

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

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

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

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

MethodgetBuildingFormsForCreate
Description

Gets the building forms for creating a bunch of new buildings.

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

Creates a new set of Buildings. 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.BuildingBatchFormListbuildingFormsthe building forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT buildingForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBuildingFormsForUpdate
Description

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

Parametersosid.id.IdListbuildingIdsthe Ids of the Building
Returnosid.room.batch.BuildingBatchFormListthe building form
ErrorsNOT_FOUNDa buildingId is not found
NULL_ARGUMENT buildingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBuildings
Description

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

Deletes all Buildings in this Campus .

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

Deletes buildings for the given Ids.

Parametersosid.id.IdListbuildingIdsthe Ids of the buildings to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT buildingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveBuildingsByDate
Description

Deletes buildings 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.
MethodaliasBuildings
Description

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