Interface RegistrationAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

RegistrationBatchAdminSession

public interface RegistrationAdminSession
extends OsidSession

This session creates, updates, and deletes Registrations . 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 Registration , a RegistrationForm is requested using getRegistrationFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned RegistrationForm 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 RegistrationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RegistrationForm corresponds to an attempted transaction.

For updates, RegistrationForms are requested to the RegistrationForm Id that is to be updated using getRegistrationFormForUpdate() . Similarly, the RegistrationForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RegistrationForm can only be used once for a successful update and cannot be reused.

The delete operations delete Registrations . To unmap a Registration from the current CourseCatalog , the RegistrationCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the RegistrationForm 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.

Method Summary

Modifier and Type	Method	Description
void	aliasRegistration(Id registrationId, Id aliasId)	Adds an Id to a Registration for the purpose of creating compatibility.
boolean	canCreateRegistrations()	Tests if this user can create Registrations .
boolean	canCreateRegistrationWithRecordTypes(Type[] registrationRecordTypes)	Tests if this user can create a single Registration using the desired record types.
boolean	canDeleteRegistrations()	Tests if this user can delete Registrations .
boolean	canManageRegistrationAliases()	Tests if this user can manage Id aliases for Registrations .
boolean	canUpdateRegistrations()	Tests if this user can update Registrations .
Registration	createRegistration(RegistrationForm registrationForm)	Creates a new Registration .
void	deleteRegistration(Id registrationId)	Deletes a Registration .
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
RegistrationForm	getRegistrationFormForCreate(Id courseRegistrationId, Id registrationTargetId, Id resourceId, Type[] registrationRecordTypes)	Gets the registration form for creating new registrations.
RegistrationForm	getRegistrationFormForUpdate(Id registrationId)	Gets the registration form for updating an existing registration.
void	updateRegistration(RegistrationForm registrationForm)	Updates an existing registration.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                        throws OperationFailedException,
PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateRegistrations

boolean canCreateRegistrations()

Tests if this user can create Registrations . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Registration 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.

Returns:

false if Registration creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateRegistrationWithRecordTypes

boolean canCreateRegistrationWithRecordTypes(Type[] registrationRecordTypes)

Tests if this user can create a single Registration using the desired record types. While CourseRegistrationManager.getRegistrationRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Registration . Providing an empty array tests if a Registration can be created with no records.

Parameters:

registrationRecordTypes - array of registration record types

Returns:

true if Registration creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - registrationRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getRegistrationFormForCreate

RegistrationForm getRegistrationFormForCreate(Id courseRegistrationId,
 Id registrationTargetId,
 Id resourceId,
 Type[] registrationRecordTypes)
                                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the registration form for creating new registrations. A new form should be requested for each create transaction.

Parameters:

courseRegistrationId - the Id of the course registration

registrationTargetId - the Id of the registration target

resourceId - the Id of the student

registrationRecordTypes - array of registration record types

Returns:

the registration form

Throws:

NotFoundException - courseRegistrationId, registrationTargetId , or resourceId not found

NullArgumentException - courseRegistrationId, registrationTargetId , resourceId , or registrationRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createRegistration

Registration createRegistration(RegistrationForm registrationForm)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Creates a new Registration .

Parameters:

registrationForm - the form for this Registration

Returns:

the new Registration

Throws:

IllegalStateException - registrationForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NotFoundException - registrationForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - registrationForm did not originate from getRegistrationFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateRegistrations

boolean canUpdateRegistrations()

Tests if this user can update Registrations . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Registration 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.

Returns:

false if Registration modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRegistrationFormForUpdate

RegistrationForm getRegistrationFormForUpdate(Id registrationId)
                                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the registration form for updating an existing registration. A new registration form should be requested for each update transaction.

Parameters:

registrationId - the Id of the Registration

Returns:

the registration form

Throws:

NotFoundException - registrationId is not found

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRegistration

void updateRegistration(RegistrationForm registrationForm)
                 throws OperationFailedException,
PermissionDeniedException

Updates an existing registration.

Parameters:

registrationForm - the form containing the elements to be updated

Throws:

IllegalStateException - registrationForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - registrationForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - registrationForm did not originate from getRegistrationFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteRegistrations

boolean canDeleteRegistrations()

Tests if this user can delete Registrations . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Registration 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.

Returns:

false if Registration deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteRegistration

void deleteRegistration(Id registrationId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Registration .

Parameters:

registrationId - the Id of the Registration to remove

Throws:

NotFoundException - registrationId not found

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageRegistrationAliases

boolean canManageRegistrationAliases()

Tests if this user can manage Id aliases for Registrations . 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.

Returns:

false if Registration aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasRegistration

void aliasRegistration(Id registrationId,
 Id aliasId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Registration 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 registration, it is reassigned to the given registration Id .

Parameters:

registrationId - the Id of a Registration

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is in use as a primary Id

NotFoundException - registrationId not found

NullArgumentException - registrationId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.