Interface | osid.room.BuildingAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getCampusId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Campus Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampus | ||
Description |
Gets the | ||
Return | osid.room.Campus | the campus | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBuildings | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Building creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBuildingWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | buildingRecordTypes | array of building record types |
Return | boolean | true if Building creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | buildingRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingFormForCreate | ||
Description |
Gets the building form for creating new buildings. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | buildingRecordTypes | array of building record types |
Return | osid.room.BuildingForm | the building form | |
Errors | NULL_ARGUMENT | buildingRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get from for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBuilding | ||
Description |
Creates a new | ||
Parameters | osid.room.BuildingForm | buildingForm | the form for this Building |
Return | osid.room.Building | the new Building | |
Errors | ILLEGAL_STATE | buildingForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | buildingForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | buildingForm did not originate from
getBuildingFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBuildings | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Building modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingFormForUpdate | ||
Description |
Gets the building form for updating an existing building. A new building form should be requested for each update transaction. | ||
Parameters | osid.id.Id | buildingId | the Id of the Building |
Return | osid.room.BuildingForm | the building form | |
Errors | NOT_FOUND | buildingId is not found | |
NULL_ARGUMENT | buildingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBuilding | ||
Description |
Updates an existing building. | ||
Parameters | osid.room.BuildingForm | buildingForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | buildingForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | buildingForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | buildingForm did not originate from
getBuildingFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBuildings | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Building deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBuilding | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | buildingId | the Id of the Building to remove |
Errors | NOT_FOUND | buildingId not found | |
NULL_ARGUMENT | buildingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBuildingAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Building aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBuilding | ||
Description |
Adds an | ||
Parameters | osid.id.Id | buildingId | the Id of a Building |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | buildingId not found | ||
NULL_ARGUMENT | buildingId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |