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.
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.
|
aliasProject, canCreateProjects, canCreateProjectWithRecordTypes, canDeleteProjects, canManageProjectAliases, canUpdateProjects, createProject, deleteProject, getCampus, getCampusId, getProjectFormForCreate, getProjectFormForUpdate, updateProject
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProjectBatchFormList getProjectFormsForCreate(IdList buildingIds, Type[] projectRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
buildingIds
- a list of building Ids
projectRecordTypes
- array of project record types to be
included in each create operation or an empty list if noneNotFoundException
- a buildingId
is not
foundNullArgumentException
- buildingid
or
projectRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createProjects(ProjectBatchFormList projectForms) throws OperationFailedException, PermissionDeniedException
Projects.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.projectForms
- the project formsNullArgumentException
- projectForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProjectBatchFormList getProjectFormsForUpdate(IdList projectIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
projectIds
- the Ids
of the Project
NotFoundException
- a projectId
is not
foundNullArgumentException
- projectIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateProjects(ProjectBatchFormList projectForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.projectForms
- the form containing the elements to be updatedNullArgumentException
- projectForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllProjects() throws OperationFailedException, PermissionDeniedException
Projects
in this Campus
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProjects(IdList projectIds) throws OperationFailedException, PermissionDeniedException
Ids.
projectIds
- the Ids
of the projects to deleteNullArgumentException
- projectIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProjectsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
buildingId
- a building Id
NullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveProjectsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasProjects(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.