Interface | osid.personnel.batch.OrganizationBatchAdminSession | ||
---|---|---|---|
Implements | osid.personnel.OrganizationAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getOrganizationFormsForCreate | ||
Description |
Gets the organization forms for creating a bunch of new organizations. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | organizationRecordTypes | array of organization record types to be included in each create operation or an empty list if none | |
Return | osid.personnel.batch.OrganizationBatchFormList | the organization forms | |
Errors | NULL_ARGUMENT | organizationRecordTypes 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 | createOrganizations | ||
Description |
Creates a new set of | ||
Parameters | osid.personnel.batch.OrganizationBatchFormList | organizationForms | the organization forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | organizationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationFormsForUpdate | ||
Description |
Gets the organization forms for updating an existing set of organizations. A new organization form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | organizationIds | the Ids of the Organization |
Return | osid.personnel.batch.OrganizationBatchFormList | the organization form | |
Errors | NOT_FOUND | an organizationId is not found | |
NULL_ARGUMENT | organizationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateOrganizations | ||
Description |
Updates existing organizations. 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.OrganizationBatchFormList | organizationForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | organizationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllOrganizations | ||
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 | deleteOrganizations | ||
Description |
Deletes organizations for the given | ||
Parameters | osid.id.IdList | organizationIds | the Ids of the organizations to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | organizationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteOrganizationsForResource | ||
Description |
Deletes all organizations for the given resource. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveOrganizationsByDate | ||
Description |
Deletes organizations 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 | aliasOrganizations | ||
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. |