Interface | osid.personnel.batch.PositionBatchAdminSession | ||
---|---|---|---|
Implements | osid.personnel.PositionAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getPositionFormsForCreate | ||
Description |
Gets the position forms for creating a bunch of new positions. A form is returned for each supplied organization. | ||
Parameters | osid.id.IdList | organizationIds | a list of organization Ids |
osid.type.Type[] | positionRecordTypes | array of position record types to be included in each create operation or an empty list if none | |
Return | osid.personnel.batch.PositionBatchFormList | the position forms | |
Errors | NOT_FOUND | an organizationId is not found | |
NULL_ARGUMENT | organizationIds or positionRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createPositions | ||
Description |
Creates a new set of | ||
Parameters | osid.personnel.batch.PositionBatchFormList | positionForms | the position forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | positionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPositionFormsForUpdate | ||
Description |
Gets the position forms for updating an existing set of positions. A new position form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | positionIds | the Ids of the Position |
Return | osid.personnel.batch.PositionBatchFormList | the position form | |
Errors | NOT_FOUND | a positionId is not found | |
NULL_ARGUMENT | positionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePositions | ||
Description |
Updates existing positions. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.personnel.batch.PositionBatchFormList | positionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | positionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPositions | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deletePositions | ||
Description |
Deletes positions for the given | ||
Parameters | osid.id.IdList | positionIds | the Ids of the positions to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | positionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deletePositionsForOrganization | ||
Description |
Deletes positions for the given organiation. | ||
Parameters | osid.id.Id | organizationId | the Id of an organization |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | organizationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectivePositionsByDate | ||
Description |
Deletes positions expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasPositions | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |