OSID Logo
OSID Specifications
personnel batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.batch.OrganizationBatchAdminSession
Implementsosid.personnel.OrganizationAdminSession
Description

This session creates, updates, and deletes Organizations in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an Organization, an OrganizationForm is requested using getOrganizationFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned OrganizationForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once an OrganizationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each OrganizationForm corresponds to an attempted transaction.

The OrganizationForms returned from getOrganizationFormsForCreate() may be linked to the originating request through the peer Ids of the OrganizationForm. In the case where there may be duplicates, any OrganizationForm of the same peer Ids may be used for a create operation.

Once a batch of OrganizationForms are submitted for create, a CreateResponse is returned for each OrganizationForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createOrganizations(), errors specific to an individual OrganizationForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating OrganizationForm through the OrganizationForm Id .

For updates, OrganizationForms are requested to the Organization Id that is to be updated using getOrganizationFormsForUpdate() where the reference Id in the OrganizationForm may be used to link the request. Similarly, the OrganizationForm has metadata about the data that can be updated and it can perform validation before submitting the update. The OrganizationForm can only be used once for a successful update and cannot be reused.

Once a batch of OrganizationForms are submitted for update, an UpdateResponse is returned for each OrganizationForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateOrganizations(), errors specific to an individual OrganizationForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating OrganizationForm through the OrganizationForm Id.

The delete operations delete Organizations in bulk. To unmap an Organization from the current Realm, the OrganizationRealmAssignmentSession should be used. These delete operations attempt to remove the Organization itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetOrganizationFormsForCreate
Description

Gets the organization forms for creating a bunch of new organizations.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]organizationRecordTypesarray of organization record types to be included in each create operation or an empty list if none
Returnosid.personnel.batch.OrganizationBatchFormListthe organization forms
ErrorsNULL_ARGUMENT organizationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateOrganizations
Description

Creates a new set of Organizations. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.personnel.batch.OrganizationBatchFormListorganizationFormsthe organization forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT organizationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationFormsForUpdate
Description

Gets the organization forms for updating an existing set of organizations. A new organization form should be requested for each update transaction.

Parametersosid.id.IdListorganizationIdsthe Ids of the Organization
Returnosid.personnel.batch.OrganizationBatchFormListthe organization form
ErrorsNOT_FOUNDan organizationId is not found
NULL_ARGUMENT organizationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOrganizations
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 BatchCreateResponse .

Parametersosid.personnel.batch.OrganizationBatchFormListorganizationFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT organizationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllOrganizations
Description

Deletes all Organizations in this Realm .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteOrganizations
Description

Deletes organizations for the given Ids.

Parametersosid.id.IdListorganizationIdsthe Ids of the organizations to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT organizationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteOrganizationsForResource
Description

Deletes all organizations for the given resource.

Parametersosid.id.IdresourceIdan Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveOrganizationsByDate
Description

Deletes organizations expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasOrganizations
Description

Adds an Id to an Organization for the purpose of creating compatibility. The primary Id of the Organization is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another organization, it is reassigned to the given organization Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.