Interface AcademyAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

AcademyBatchAdminSession

public interface AcademyAdminSession
extends OsidSession

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

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

The delete operations delete Academies .

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	aliasAcademy(Id academyId, Id aliasId)	Adds an Id to an Academy for the purpose of creating compatibility.
boolean	canCreateAcademies()	Tests if this user can create Academies .
boolean	canCreateAcademyWithRecordTypes(Type[] academyRecordTypes)	Tests if this user can create a single Academy using the desired record types.
boolean	canDeleteAcademies()	Tests if this user can delete Academies A return of true does not guarantee successful authorization.
boolean	canManageAcademyAliases()	Tests if this user can manage Id aliases for Academies .
boolean	canUpdateAcademies()	Tests if this user can update Academies .
Academy	createAcademy(AcademyForm academyForm)	Creates a new Academy .
void	deleteAcademy(Id academyId)	Deletes an Academy .
AcademyForm	getAcademyFormForCreate(Type[] academyRecordTypes)	Gets the academy form for creating new academies.
AcademyForm	getAcademyFormForUpdate(Id academyId)	Gets the academy form for updating an existing academy.
void	updateAcademy(AcademyForm academyForm)	Updates an existing academy.

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

canCreateAcademies

boolean canCreateAcademies()

Tests if this user can create Academies . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Academy will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.

Returns:

false if Academy creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateAcademyWithRecordTypes

boolean canCreateAcademyWithRecordTypes(Type[] academyRecordTypes)

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

Parameters:

academyRecordTypes - array of academy types

Returns:

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

Throws:

NullArgumentException - academyRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getAcademyFormForCreate

AcademyForm getAcademyFormForCreate(Type[] academyRecordTypes)
                             throws OperationFailedException,
PermissionDeniedException

Gets the academy form for creating new academies. A new form should be requested for each create transaction.

Parameters:

academyRecordTypes - array of academy types

Returns:

the academy form

Throws:

NullArgumentException - academyRecordTypes 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.

createAcademy

Academy createAcademy(AcademyForm academyForm)
               throws OperationFailedException,
PermissionDeniedException

Creates a new Academy .

Parameters:

academyForm - the form for this Academy

Returns:

the new Academy

Throws:

IllegalStateException - academyForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - academyForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - academyForm did not originate from getAcademyFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateAcademies

boolean canUpdateAcademies()

Tests if this user can update Academies . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Academy will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.

Returns:

false if Academy modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAcademyFormForUpdate

AcademyForm getAcademyFormForUpdate(Id academyId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

academyId - the Id of the Academy

Returns:

the academy form

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAcademy

void updateAcademy(AcademyForm academyForm)
            throws OperationFailedException,
PermissionDeniedException

Updates an existing academy.

Parameters:

academyForm - the form containing the elements to be updated

Throws:

IllegalStateException - academyForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - academyForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - academyForm did not originate from getAcademyFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteAcademies

boolean canDeleteAcademies()

Tests if this user can delete Academies A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Academy will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.

Returns:

false if Academy deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteAcademy

void deleteAcademy(Id academyId)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes an Academy .

Parameters:

academyId - the Id of the Academy to remove

Throws:

NotFoundException - academyId not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageAcademyAliases

boolean canManageAcademyAliases()

Tests if this user can manage Id aliases for Academies . 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 Academy aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasAcademy

void aliasAcademy(Id academyId,
 Id aliasId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to an Academy for the purpose of creating compatibility. The primary Id of the Academy is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another academy, it is reassigned to the given academy Id .

Parameters:

academyId - the Id of an Academy

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - academyId not found

NullArgumentException - academyId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.