OSID Logo
OSID Specifications
room construction batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.batch.ProjectBatchAdminSession
Implementsosid.room.construction.ProjectAdminSession
Description

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.

MethodgetProjectFormsForCreate
Description

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

Parametersosid.id.IdListbuildingIdsa list of building Ids
osid.type.Type[]projectRecordTypesarray of project record types to be included in each create operation or an empty list if none
Returnosid.room.construction.batch.ProjectBatchFormListthe project forms
ErrorsNOT_FOUNDa buildingId is not found
NULL_ARGUMENT buildingid or projectRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateProjects
Description

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 .

Parametersosid.room.construction.batch.ProjectBatchFormListprojectFormsthe project forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT projectForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProjectFormsForUpdate
Description

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

Parametersosid.id.IdListprojectIdsthe Ids of the Project
Returnosid.room.construction.batch.ProjectBatchFormListthe project form
ErrorsNOT_FOUNDa projectId is not found
NULL_ARGUMENT projectIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProjects
Description

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 .

Parametersosid.room.construction.batch.ProjectBatchFormListprojectFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT projectForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllProjects
Description

Deletes all Projects in this Campus .

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

Deletes projects for the given Ids.

Parametersosid.id.IdListprojectIdsthe Ids of the projects to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT projectIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProjectsForBuilding
Description

Deletes all projects for a building.

Parametersosid.id.IdbuildingIda building Id
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveProjectsByDate
Description

Deletes projects 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.
MethodaliasProjects
Description

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.

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.