Interface | osid.personnel.PositionAdminSession | ||
---|---|---|---|
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 | getRealmId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Realm Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealm | ||
Description |
Gets the | ||
Return | osid.personnel.Realm | the realm | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePositions | ||
Description |
Tests if this user can create positions. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known creating a | ||
Return | boolean | false if Position creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePositionWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | positionRecordTypes | array of position record types |
Return | boolean | true if Position creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | positionRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPositionFormForCreate | ||
Description |
Gets the position form for creating new positions. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | organizationId | the organization Id to which this position belongs |
osid.type.Type[] | positionRecordTypes | array of position record types to be included in the create operation or an empty list if none | |
Return | osid.personnel.PositionForm | the position form | |
Errors | NOT_FOUND | organizationId is not found | |
NULL_ARGUMENT | organizationId or positionRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cannot get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createPosition | ||
Description |
Creates a new | ||
Parameters | osid.personnel.PositionForm | positionForm | the form for this Position |
Return | osid.personnel.Position | the new Position | |
Errors | ILLEGAL_STATE | positionForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | positionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | positionForm did not originate from
getPositionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdatePositions | ||
Description |
Tests if this user can update positions. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known updating a | ||
Return | boolean | false if Position modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPositionFormForUpdate | ||
Description |
Gets the position form for updating an existing position. A new position form should be requested for each update transaction. | ||
Parameters | osid.id.Id | positionId | the Id of the Position |
Return | osid.personnel.PositionForm | the position form | |
Errors | NOT_FOUND | positionId is not found | |
NULL_ARGUMENT | positionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePosition | ||
Description |
Updates an existing position. | ||
Parameters | osid.personnel.PositionForm | positionForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | positionForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | positionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | positionForm did not originate from
getPositionFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeletePositions | ||
Description |
Tests if this user can delete positions. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting an | ||
Return | boolean | false if Position deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deletePosition | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | positionId | the Id of the Position to remove |
Errors | NOT_FOUND | positionId not found | |
NULL_ARGUMENT | positionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManagePositionAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Position aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasPosition | ||
Description |
Adds an | ||
Parameters | osid.id.Id | positionId | the Id of a Position |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | positionId not found | ||
NULL_ARGUMENT | positionId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |