Interface | osid.resource.ResourceAdminSession | ||
---|---|---|---|
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 | getBinId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bin Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBin | ||
Description |
Gets the | ||
Return | osid.resource.Bin | the Bin associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateResources | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Resource creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateResourceWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | resourceRecordTypes | array of resource record types |
Return | boolean | true if Resource creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | resourceRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceFormForCreate | ||
Description |
Gets the resource form for creating new resources. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | resourceRecordTypes | array of resource record types |
Return | osid.resource.ResourceForm | the resource form | |
Errors | NULL_ARGUMENT | resourceRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createResource | ||
Description |
Creates a new | ||
Parameters | osid.resource.ResourceForm | resourceForm | the form for this Resource |
Return | osid.resource.Resource | the new Resource | |
Errors | ILLEGAL_STATE | resourceForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | resourceForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | resourceForm did not originate from
getResourceFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateResources | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Resource modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceFormForUpdate | ||
Description |
Gets the resource form for updating an existing resource. A new resource form should be requested for each update transaction. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource |
Return | osid.resource.ResourceForm | the resource form | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateResource | ||
Description |
Updates an existing resource. | ||
Parameters | osid.resource.ResourceForm | resourceForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | resourceForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | resourceForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | resourceForm did not originate from
getResourceFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteResources | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Resource deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteResource | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to remove |
Errors | NOT_FOUND | resourceId not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageResourceAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Resource aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasResource | ||
Description |
Adds an | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | resourceId not found | ||
NULL_ARGUMENT | aliasId or resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |