Interface | osid.room.construction.ProjectAdminSession | ||
---|---|---|---|
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 | canCreateProjects | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Project creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProjectWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | projectRecordTypes | array of project record types |
Return | boolean | true if Project creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | projectRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProjectFormForCreate | ||
Description |
Gets the project form for creating new projects. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | buildingId | the Id of the building |
osid.type.Type[] | projectRecordTypes | array of project record types | |
Return | osid.room.construction.ProjectForm | the project form | |
Errors | NOT_FOUND | buildngId is not found | |
NULL_ARGUMENT | buildngId or projectRecordTypes 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 | createProject | ||
Description |
Creates a new | ||
Parameters | osid.room.construction.ProjectForm | projectForm | the form for this Project |
Return | osid.room.construction.Project | the new Project | |
Errors | ILLEGAL_STATE | projectForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | projectForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | projectForm did not originate from
getProjectFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProjects | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Project modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProjectFormForUpdate | ||
Description |
Gets the project form for updating an existing project. A new project form should be requested for each update transaction. | ||
Parameters | osid.id.Id | projectId | the Id of the Project |
Return | osid.room.construction.ProjectForm | the project form | |
Errors | NOT_FOUND | projectId is not found | |
NULL_ARGUMENT | projectId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProject | ||
Description |
Updates an existing project. | ||
Parameters | osid.room.construction.ProjectForm | projectForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | projectForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | projectForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | projectForm did not originate from
getProjectFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProjects | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Project deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteProject | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | projectId | the Id of the Project to remove |
Errors | NOT_FOUND | projectId not found | |
NULL_ARGUMENT | projectId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageProjectAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Project aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasProject | ||
Description |
Adds an | ||
Parameters | osid.id.Id | projectId | the Id of a Project |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | projectId not found | ||
NULL_ARGUMENT | projectId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |