Interface ProjectBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProjectAdminSession
public interface ProjectBatchAdminSession extends ProjectAdminSession

This session creates, updates, and deletes Projects 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 a Project , a ProjectForm is requested using getProjectFormsForCreate() specifying the building and desired record Types or none if no record Types are needed. Each of the returned ProjectForms 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 a ProjectForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProjectForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Projects in bulk. To unmap a Project from the current Campus , the ProjectCampusAssignmentSession should be used. These delete operations attempt to remove the Project itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses .