Interface | osid.room.RoomAdminSession | ||
---|---|---|---|
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 | canCreateRooms | ||
Description |
Tests if this user can create hournal entries. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating a
| ||
Return | boolean | false if Room creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRoomWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | roomRecordTypes | array of room record types |
Return | boolean | true if Room creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | roomRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomFormForCreate | ||
Description |
Gets the room form for creating new entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | floorId | the Id for the floor |
osid.type.Type[] | roomRecordTypes | array of room record types | |
Return | osid.room.RoomForm | the room form | |
Errors | NOT_FOUND | floorId is not found | |
NULL_ARGUMENT | floorId or roomRecordTypes 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 | createRoom | ||
Description |
Creates a new | ||
Parameters | osid.room.RoomForm | roomForm | the form for this Room |
Return | osid.room.Room | the new Room | |
Errors | ILLEGAL_STATE | roomForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | roomForm did not originate from
getRoomFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRooms | ||
Description |
Tests if this user can update rooms. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known updating a | ||
Return | boolean | false if Room modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomFormForUpdate | ||
Description |
Gets the room form for updating an existing room. A new room form should be requested for each update transaction. | ||
Parameters | osid.id.Id | roomId | the Id of the Room |
Return | osid.room.RoomForm | the room form | |
Errors | NOT_FOUND | roomId is not found | |
NULL_ARGUMENT | roomId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRoom | ||
Description |
Updates an existing room. | ||
Parameters | osid.room.RoomForm | roomForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | roomForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | roomForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | roomForm did not originate from
getRoomFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRooms | ||
Description |
Tests if this user can delete rooms. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting an | ||
Return | boolean | false if Room deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRoom | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | roomId | the Id of the Room to remove |
Errors | NOT_FOUND | roomId not found | |
NULL_ARGUMENT | roomId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRoomAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Room aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRoom | ||
Description |
Adds an | ||
Parameters | osid.id.Id | roomId | the Id of a Room |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | roomId not found | ||
NULL_ARGUMENT | roomId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |