org.osid.room.construction.batch

Interface ProjectBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasProjects(AliasRequestList aliasRequests) Adds an Id to a Project for the purpose of creating compatibility.
CreateResponseList	createProjects(ProjectBatchFormList projectForms) Creates a new set of Projects.
DeleteResponseList	deleteAllProjects() Deletes all Projects in this Campus .
DeleteResponseList	deleteIneffectiveProjectsByDate(DateTime date) Deletes projects expired before the given date.
DeleteResponseList	deleteProjects(IdList projectIds) Deletes projects for the given Ids.
DeleteResponseList	deleteProjectsForBuilding(Id buildingId) Deletes all projects for a building.
ProjectBatchFormList	getProjectFormsForCreate(IdList buildingIds, Type[] projectRecordTypes) Gets the project forms for creating a bunch of new projects.
ProjectBatchFormList	getProjectFormsForUpdate(IdList projectIds) Gets the project forms for updating an existing set of projects.
UpdateResponseList	updateProjects(ProjectBatchFormList projectForms) Updates existing projects.

Methods inherited from interface org.osid.room.construction.ProjectAdminSession

aliasProject, canCreateProjects, canCreateProjectWithRecordTypes, canDeleteProjects, canManageProjectAliases, canUpdateProjects, createProject, deleteProject, getCampus, getCampusId, getProjectFormForCreate, getProjectFormForUpdate, updateProject

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getProjectFormsForCreate

ProjectBatchFormList getProjectFormsForCreate(IdList buildingIds,
                                            Type[] projectRecordTypes)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the project forms for creating a bunch of new projects. A project form is returned for each supplied building.

Parameters:

buildingIds - a list of building Ids

projectRecordTypes - array of project record types to be included in each create operation or an empty list if none

Returns:

the project forms

Throws:

NotFoundException - a buildingId is not found

NullArgumentException - buildingid or projectRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createProjects

CreateResponseList createProjects(ProjectBatchFormList projectForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

projectForms - the project forms

Returns:

the create responses

Throws:

NullArgumentException - projectForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProjectFormsForUpdate

ProjectBatchFormList getProjectFormsForUpdate(IdList projectIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

projectIds - the Ids of the Project

Returns:

the project form

Throws:

NotFoundException - a projectId is not found

NullArgumentException - projectIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProjects

UpdateResponseList updateProjects(ProjectBatchFormList projectForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Updates existing projects. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

projectForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - projectForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProjects

DeleteResponseList deleteAllProjects()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Projects in this Campus .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProjects

DeleteResponseList deleteProjects(IdList projectIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes projects for the given Ids.

Parameters:

projectIds - the Ids of the projects to delete

Returns:

the delete responses

Throws:

NullArgumentException - projectIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProjectsForBuilding

DeleteResponseList deleteProjectsForBuilding(Id buildingId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes all projects for a building.

Parameters:

buildingId - a building Id

Returns:

the delete responses

Throws:

NullArgumentException - buildingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveProjectsByDate

DeleteResponseList deleteIneffectiveProjectsByDate(DateTime date)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes projects expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasProjects

AliasResponseList aliasProjects(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.