Interface SystemAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

SystemBatchAdminSession

public interface SystemAdminSession
extends OsidSession

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

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

The delete operations delete Systems .

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	aliasSystem(Id systemId, Id aliasId)	Adds an Id to a System for the purpose of creating compatibility.
boolean	canCreateSystems()	Tests if this user can create Systems .
boolean	canCreateSystemWithRecordTypes(Type[] systemRecordTypes)	Tests if this user can create a single System using the desired record types.
boolean	canDeleteSystems()	Tests if this user can delete Systems .
boolean	canManageSystemAliases()	Tests if this user can manage Id aliases for Systems .
boolean	canUpdateSystems()	Tests if this user can update Systems .
System	createSystem(SystemForm systemForm)	Creates a new System .
void	deleteSystem(Id systemId)	Deletes a System .
SystemForm	getSystemFormForCreate(Type[] systemRecordTypes)	Gets the system form for creating new systems.
SystemForm	getSystemFormForUpdate(Id systemId)	Gets the system form for updating an existing system.
void	updateSystem(SystemForm systemForm)	Updates an existing system

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

canCreateSystems

boolean canCreateSystems()

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

Compliance:

mandatory - This method must be implemented.

canCreateSystemWithRecordTypes

boolean canCreateSystemWithRecordTypes(Type[] systemRecordTypes)

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

Parameters:

systemRecordTypes - array of system record types

Returns:

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

Throws:

NullArgumentException - systemRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getSystemFormForCreate

SystemForm getSystemFormForCreate(Type[] systemRecordTypes)
                           throws OperationFailedException,
PermissionDeniedException

Gets the system form for creating new systems. A new form should be requested for each create transaction.

Parameters:

systemRecordTypes - array of system record types

Returns:

the system form

Throws:

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

createSystem

System createSystem(SystemForm systemForm)
             throws OperationFailedException,
PermissionDeniedException

Creates a new System .

Parameters:

systemForm - the form for this System

Returns:

the new System

Throws:

IllegalStateException - systemForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - systemForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - systemForm did not originate from getSystemFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateSystems

boolean canUpdateSystems()

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

Compliance:

mandatory - This method must be implemented.

getSystemFormForUpdate

SystemForm getSystemFormForUpdate(Id systemId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

systemId - the Id of the System

Returns:

the system form

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSystem

void updateSystem(SystemForm systemForm)
           throws OperationFailedException,
PermissionDeniedException

Updates an existing system

Parameters:

systemForm - the form containing the elements to be updated

Throws:

IllegalStateException - systemForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - systemForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - systemForm did not originate from getSystemFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteSystems

boolean canDeleteSystems()

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

Compliance:

mandatory - This method must be implemented.

deleteSystem

void deleteSystem(Id systemId)
           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a System .

Parameters:

systemId - the Id of the System to remove

Throws:

NotFoundException - systemId not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSystemAliases

boolean canManageSystemAliases()

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

Compliance:

mandatory - This method must be implemented.

aliasSystem

void aliasSystem(Id systemId,
 Id aliasId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a System for the purpose of creating compatibility. The primary Id of the System is determined by the provider. The new Id performs as an alias to the primary Id .

Parameters:

systemId - the Id of a System

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - systemId not found

NullArgumentException - systemId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.