Interface | osid.room.construction.RenovationAdminSession | ||
---|---|---|---|
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 | canCreateRenovations | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Renovation creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRenovationWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | renovationRecordTypes | array of renovation record types |
Return | boolean | true if Renovation creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | renovationRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationFormForCreate | ||
Description |
Gets the renovation form for creating new renovations. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | renovationRecordTypes | array of renovation record types |
Return | osid.room.construction.RenovationForm | the renovation form | |
Errors | NULL_ARGUMENT | renovationRecordTypes 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 | createRenovation | ||
Description |
Creates a new | ||
Parameters | osid.room.construction.RenovationForm | renovationForm | the form for this Renovation |
Return | osid.room.construction.Renovation | the new Renovation | |
Errors | ILLEGAL_STATE | renovationForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | renovationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | renovationForm did not originate from
getRenovationFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRenovations | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Renovation modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationFormForUpdate | ||
Description |
Gets the renovation form for updating an existing renovation. A new renovation form should be requested for each update transaction. | ||
Parameters | osid.id.Id | renovationId | the Id of the Renovation |
Return | osid.room.construction.RenovationForm | the renovation form | |
Errors | NOT_FOUND | renovationId is not found | |
NULL_ARGUMENT | renovationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRenovation | ||
Description |
Updates an existing renovation. | ||
Parameters | osid.room.construction.RenovationForm | renovationForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | renovationForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | renovationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | renovationForm did not originate from
getRenovationFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRenovations | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Renovation deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRenovation | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | renovationId | the Id of the Renovation to remove |
Errors | NOT_FOUND | renovationId not found | |
NULL_ARGUMENT | renovationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRenovationAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Renovation aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRenovation | ||
Description |
Adds an | ||
Parameters | osid.id.Id | renovationId | the Id of a Renovation |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | renovationId not found | ||
NULL_ARGUMENT | renovationId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |