public interface ProgramOfferingBatchAdminSession extends ProgramAdminSession
This session creates, updates, and deletes ProgramOfferings
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
ProgramOffering,
a ProgramOfferingForm
is requested
using getProgramOfferingFormsForCreate()
specifying the
desired program, term, and 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 ProgramOfferingForm
is submiited to a
create operation, it cannot be reused with another create operation unless
the first operation was unsuccessful. Each ProgramOfferingForm
corresponds to an attempted transaction.
The ProgramForms
returned from
getProgramOfferingFormsForCreate()
may be linked to the
originating request through the peer Ids
of the
ProgramOfferingForm.
In the case where there may be duplicates,
any ProgramOfferingForm
of the same peer Ids
may be used for a create operation.
Once a batch of ProgramOfferingForms
are submitted for
create, a CreateResponse
is returned for each
ProgramOfferingForm,
although the ordering is not defined. Only
errors that pertain to the entire create operation are returned from
createProgramOfferings(),
errors specific to an individual
ProgramForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating ProgramOfferingForm
through the
ProgramOfferingForm
Id
.
For updates, ProgramOfferingForms
are requested to the
ProgramOffering
Id
that is to be updated
using getProgramOfferingFormsForUpdate()
where the
reference Id
in the ProgramOfferingForm
may
be used to link the request. Similarly, the ProgramOfferingForm
has metadata about the data that can be updated and it can perform
validation before submitting the update. The ProgramOfferingForm
can only be used once for a successful update and cannot be
reused.
Once a batch of ProgramOfferingForm
are submitted for
update, an UpdateResponse
is returned for each
ProgramOfferingForm,
although the ordering is not defined. Only
errors that pertain to the entire update operation are returned from
updateProgramOfferings(),
errors specific to an individual
ProgramOfferingForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be
linked to the originating ProgramOfferingForm
through the
ProgramOfferingForm
Id.
The delete operations delete ProgramOfferings
in bulk.
To unmap a ProgramOffering
from the current
CourseCatalog,
the
ProgramOfferingCourseCatalogAssignmentSession
should be used.
These delete operations attempt to remove the ProgramOffering
itself thus removing it from all known CourseCatalog
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasProgramOfferings(AliasRequestList aliasRequests)
Adds an
Id to a ProgramOffering for the
purpose of creating compatibility. |
CreateResponseList |
createProgramOfferings(ProgramOfferingBatchFormList programOfferingForms)
Creates a new set of
ProgramOfferings. |
DeleteResponseList |
deleteAllProgramOfferings()
Deletes all
ProgramOfferings in this
CourseCatalog . |
DeleteResponseList |
deleteProgramOffeingsForProgram(Id programId)
Deletes program offerings for the given program.
|
DeleteResponseList |
deleteProgramOfferings(IdList programOfferingIds)
Deletes program offerings for the given
Ids. |
DeleteResponseList |
deleteProgramOfferingsForTerm(Id termId)
Deletes programs for the given term.
|
ProgramOfferingBatchFormList |
getProgramOfferingFormsForCreate(ProgramOfferingPeerList peers,
Type[] programOfferingRecordTypes)
Gets the program offering forms for creating a bunch of new program
offerings.
|
ProgramOfferingBatchFormList |
getProgramOfferingFormsForUpdate(IdList programOfferingIds)
Gets the program offering forms for updating an existing set of
program offerings.
|
UpdateResponseList |
updateProgramOfferings(ProgramOfferingBatchFormList programOfferingForms)
Updates existing program offerings.
|
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
ProgramOfferingBatchFormList getProgramOfferingFormsForCreate(ProgramOfferingPeerList peers, Type[] programOfferingRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- a list of course offering peersprogramOfferingRecordTypes
- array of program record types to be
included in each create operation or an empty list if noneNotFoundException
- a programId
or
termId
is not foundNullArgumentException
- peers
or
programRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createProgramOfferings(ProgramOfferingBatchFormList programOfferingForms) throws OperationFailedException, PermissionDeniedException
ProgramOfferings.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.programOfferingForms
- the program offering formsNullArgumentException
- programOfferingForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramOfferingBatchFormList getProgramOfferingFormsForUpdate(IdList programOfferingIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
programOfferingIds
- the Ids
of the
ProgramOffering
NotFoundException
- a programOfferingId
is not foundNullArgumentException
- programOfferingIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateProgramOfferings(ProgramOfferingBatchFormList programOfferingForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.programOfferingForms
- the form containing the elements to be
updatedNullArgumentException
- programOfferingForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllProgramOfferings() throws OperationFailedException, PermissionDeniedException
ProgramOfferings
in this
CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProgramOfferings(IdList programOfferingIds) throws OperationFailedException, PermissionDeniedException
Ids.
programOfferingIds
- the Ids
of the program
offerings to deleteNullArgumentException
- programOfferingIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProgramOffeingsForProgram(Id programId) throws OperationFailedException, PermissionDeniedException
programId
- the Id
of a programNullArgumentException
- programId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProgramOfferingsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
termId
- the Id
of a termNullArgumentException
- termId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasProgramOfferings(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a ProgramOffering
for the
purpose of creating compatibility. The primary Id
of
the ProgramOffering
is determined by the provider. The
new Id
is an alias to the primary Id.
If
the alias is a pointer to another program offering, 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.