public interface BuildingBatchAdminSession extends BuildingAdminSession
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.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasBuildings(AliasRequestList aliasRequests)
Adds an
Id to a Building for the purpose
of creating compatibility. |
CreateResponseList |
createBuildings(BuildingBatchFormList buildingForms)
Creates a new set of
Buildings. |
DeleteResponseList |
deleteAllBuildings()
Deletes all
Buildings in this Campus . |
DeleteResponseList |
deleteBuildings(IdList buildingIds)
Deletes buildings for the given
Ids. |
DeleteResponseList |
deleteIneffectiveBuildingsByDate(DateTime date)
Deletes buildings expired before the given date.
|
BuildingBatchFormList |
getBuildingFormsForCreate(long number,
Type[] buildingRecordTypes)
Gets the building forms for creating a bunch of new buildings.
|
BuildingBatchFormList |
getBuildingFormsForUpdate(IdList buildingIds)
Gets the building forms for updating an existing set of buildings.
|
UpdateResponseList |
updateBuildings(BuildingBatchFormList buildingForms)
Updates existing buildings.
|
aliasBuilding, canCreateBuildings, canCreateBuildingWithRecordTypes, canDeleteBuildings, canManageBuildingAliases, canUpdateBuildings, createBuilding, deleteBuilding, getBuildingFormForCreate, getBuildingFormForUpdate, getCampus, getCampusId, updateBuilding
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BuildingBatchFormList getBuildingFormsForCreate(long number, Type[] buildingRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievebuildingRecordTypes
- array of building record types to be
included in each create operation or an empty list if noneNullArgumentException
- buildingRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createBuildings(BuildingBatchFormList buildingForms) throws OperationFailedException, PermissionDeniedException
Buildings.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.buildingForms
- the building formsNullArgumentException
- buildingForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BuildingBatchFormList getBuildingFormsForUpdate(IdList buildingIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
buildingIds
- the Ids
of the Building
NotFoundException
- a buildingId
is not
foundNullArgumentException
- buildingIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateBuildings(BuildingBatchFormList buildingForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.buildingForms
- the form containing the elements to be updatedNullArgumentException
- buildingForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllBuildings() throws OperationFailedException, PermissionDeniedException
Buildings
in this Campus
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBuildings(IdList buildingIds) throws OperationFailedException, PermissionDeniedException
Ids.
buildingIds
- the Ids
of the buildings to deleteNullArgumentException
- buildingIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveBuildingsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasBuildings(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.