public interface CourseOfferingAdminSession extends OsidSession
This session creates, updates, and deletes CourseOfferings.
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
CourseOffering,
a CourseOfferingForm
is requested
using getCourseOfferingFormForCreate()
specifying the
desired course, term, and record Types
or none if no record
Types
are needed. The returned CourseOfferingForm
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
the CourseOfferingForm
is submiited to a create operation,
it cannot be reused with another create operation unless the first
operation was unsuccessful. Each CourseOfferingForm
corresponds to an attempted transaction.
For updates, CourseOfferingForms
are requested to the
CourseOffering
Id
that is to be updated
using getCourseOfferingFormForUpdate().
Similarly, the
CourseOfferingForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
CourseOfferingForm
can only be used once for a successful
update and cannot be reused.
The delete operations delete CourseOfferings.
To unmap
a CourseOffering
from the current CourseCatalog,
the CourseOfferingCourseCatalogAssignmentSession
should be used. These delete operations attempt to remove the
CourseOffering
itself thus removing it from all known
CourseCatalog
catalogs.
This session includes an Id
aliasing mechanism to
assign an external Id
to an internally assigned Id.
Modifier and Type | Method and Description |
---|---|
void |
aliasCourseOffering(Id courseOfferingId,
Id aliasId)
Adds an
Id to a CourseOffering for the
purpose of creating compatibility. |
boolean |
canCreateCourseOfferings()
Tests if this user can create
CourseOfferings. |
boolean |
canCreateCourseOfferingWithRecordTypes(Type[] courseOfferingRecordTypes)
Tests if this user can create a single
CourseOffering
using the desired record types. |
boolean |
canDeleteCourseOfferings()
Tests if this user can delete
CourseOfferings. |
boolean |
canManageCourseOfferingAliases()
Tests if this user can manage
Id aliases for
CourseOfferings. |
boolean |
canUpdateCourseOfferings()
Tests if this user can update
CourseOfferings. |
CourseOffering |
createCourseOffering(CourseOfferingForm courseOfferingForm)
Creates a new
CourseOffering. |
void |
deleteCourseOffering(Id courseOfferingId)
Deletes a
CourseOffering. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CourseOfferingForm |
getCourseOfferingFormForCreate(Id courseId,
Id termId,
Type[] courseOfferingRecordTypes)
Gets the course form for creating new course offerings.
|
CourseOfferingForm |
getCourseOfferingFormForUpdate(Id courseOfferingId)
Gets the course offering form for updating an existing course
offering.
|
void |
updateCourseOffering(CourseOfferingForm courseOfferingForm)
Updates an existing course offering.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateCourseOfferings()
CourseOfferings.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known creating a CourseOffering
will result in a PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer create operations
to an unauthorized user. false
if CourseOffering
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateCourseOfferingWithRecordTypes(Type[] courseOfferingRecordTypes)
CourseOffering
using the desired record types. While
CourseManager.getCourseOfferingRecordTypes()
can be used to
examine which records are supported, this method tests which record(s)
are required for creating a specific CourseOffering.
Providing an empty array tests if a CourseOffering
can
be created with no records.courseOfferingRecordTypes
- array of course offering record
types true
if CourseOffering
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
courseOfferingRecordTypes
is null
mandatory
- This method must be implemented. CourseOfferingForm getCourseOfferingFormForCreate(Id courseId, Id termId, Type[] courseOfferingRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
courseId
- the Id of the associated CoursetermId
- the Id of the associated TermcourseOfferingRecordTypes
- array of course offering record
typesNotFoundException
- courseId
or
termId
not foundNullArgumentException
- courseId, termId
or courseOfferingRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. CourseOffering createCourseOffering(CourseOfferingForm courseOfferingForm) throws OperationFailedException, PermissionDeniedException
CourseOffering.
courseOfferingForm
- the form for this CourseOffering
CourseOffering
IllegalStateException
- courseOfferingForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- courseOfferingForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- activityForm did not
originate from getCourseOfferingFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateCourseOfferings()
CourseOfferings.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known updating a CourseOffering
will result in a PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer update operations
to an unauthorized user. false
if CourseOffering
modification is not authorized, true
otherwisemandatory
- This method must be implemented. CourseOfferingForm getCourseOfferingFormForUpdate(Id courseOfferingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
courseOfferingId
- the Id
of the
CourseOffering
NotFoundException
- courseOfferingId
is
not foundNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateCourseOffering(CourseOfferingForm courseOfferingForm) throws OperationFailedException, PermissionDeniedException
courseOfferingForm
- the form containing the elements to be
updatedIllegalStateException
- courseOfferingForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- courseOfferingForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- activityForm did not
originate from getCourseOfferingFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteCourseOfferings()
CourseOfferings.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known deleting a CourseOffering
will result in a PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer delete operations
to an unauthorized user. false
if CourseOffering
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteCourseOffering(Id courseOfferingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseOffering.
courseOfferingId
- the Id
of the
CourseOffering
to removeNotFoundException
- courseOfferingId
not
foundNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageCourseOfferingAliases()
Id
aliases for
CourseOfferings.
A return of true does not guarantee
successful authorization. A return of false indicates that it is known
changing an alias will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not to offer
alias operations to an unauthorized user. false
if CourseOffering
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasCourseOffering(Id courseOfferingId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a CourseOffering
for the
purpose of creating compatibility. The primary Id
of
the Course
is determined by the provider. The new
Id
performs as an alias to the primary Id.
If the alias is a pointer to another course offering, it is
reassigned to the given course offering Id.
courseOfferingId
- the Id
of a
CourseOffering
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is in
use as a primary Id
NotFoundException
- courseOfferingId
not
foundNullArgumentException
- courseOfferingId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.