public interface ProgramBatchAdminSession extends ProgramAdminSession
This session creates, updates, and deletes Programs
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
Program,
a ProgramForm
is requested using
getProgramFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned ProgramForms
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 ProgramForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
ProgramForm
corresponds to an attempted transaction.
The ProgramForms
returned from
getProgramFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ProgramForm.
In the case where there may be duplicates, any ProgramForm
of the same peer Ids
may be used for a create
operation.
Once a batch of ProgramForms
are submitted for create,
a CreateResponse
is returned for each ProgramForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createPrograms(),
errors specific to an individual ProgramForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
ProgramForm
through the ProgramForm
Id
.
For updates, ProgramForms
are requested to the
Program
Id
that is to be updated using
getProgramFormsForUpdate()
where the reference Id
in the ProgramForm
may be used to link the request.
Similarly, the ProgramForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The ProgramForm
can only be used once for a successful
update and cannot be reused.
Once a batch of ProgramForms
are submitted for update,
an UpdateResponse
is returned for each ProgramForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updatePrograms(),
errors specific to an individual ProgramForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
ProgramForm
through the ProgramForm
Id.
The delete operations delete Programs
in bulk. To unmap
a Program
from the current CourseCatalog,
the ProgramCourseCatalogAssignmentSession
should be used.
These delete operations attempt to remove the Program
itself thus removing it from all known CourseCatalog
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasPrograms(AliasRequestList aliasRequests)
Adds an
Id to a Program for the purpose
of creating compatibility. |
CreateResponseList |
createPrograms(ProgramBatchFormList programForms)
Creates a new set of
Programs. |
DeleteResponseList |
deleteAllPrograms()
Deletes all
Programs in this CourseCatalog
. |
DeleteResponseList |
deletePrograms(IdList programIds)
Deletes programs for the given
Ids. |
ProgramBatchFormList |
getProgramFormsForCreate(long number,
Type[] programRecordTypes)
Gets the program forms for creating a bunch of new programs.
|
ProgramBatchFormList |
getProgramFormsForUpdate(IdList programIds)
Gets the program forms for updating an existing set of programs.
|
UpdateResponseList |
updatePrograms(ProgramBatchFormList programForms)
Updates existing programs.
|
aliasProgram, canCreatePrograms, canCreateProgramWithRecordTypes, canDeletePrograms, canManageProgramAliases, canUpdatePrograms, createProgram, deleteProgram, getCourseCatalog, getCourseCatalogId, getProgramFormForCreate, getProgramFormForUpdate, updateProgram
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProgramBatchFormList getProgramFormsForCreate(long number, Type[] programRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveprogramRecordTypes
- array of program record types to be
included in each create operation or an empty list if noneNullArgumentException
- programRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createPrograms(ProgramBatchFormList programForms) throws OperationFailedException, PermissionDeniedException
Programs.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.programForms
- the program formsNullArgumentException
- programForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramBatchFormList getProgramFormsForUpdate(IdList programIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
programIds
- the Ids
of the Program
NotFoundException
- a programId
is not
foundNullArgumentException
- programIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updatePrograms(ProgramBatchFormList programForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.programForms
- the form containing the elements to be updatedNullArgumentException
- programForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllPrograms() throws OperationFailedException, PermissionDeniedException
Programs
in this CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePrograms(IdList programIds) throws OperationFailedException, PermissionDeniedException
Ids.
programIds
- the Ids
of the programs to deleteNullArgumentException
- programIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasPrograms(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Program
for the purpose
of creating compatibility. The primary Id
of the
Program
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another program, it is reassigned to the given program
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.