Interface ElementAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ElementAdminSession
extends OsidSession

This session provides methods to add and remove elements from a chain.

Method Summary

Modifier and Type	Method	Description
void	addElement(Id chainId, Id id)	Adds an element to a chain,
void	addElements(Id chainId, IdList ids)	Adds a list of ordered elements to a chain.
boolean	canManageElements()	Tests if this user can add and remove eleemnts to a chain.
Antimatroid	getAntimatroid()	Gets the Antimatroid associated with this session.
Id	getAntimatroidId()	Gets the Antimatroid Id associated with this session.
void	removeElement(Id chainId, Id id)	Removes an element from a chain.

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

getAntimatroidId

Id getAntimatroidId()

Gets the Antimatroid Id associated with this session.

Returns:

the Antimatroid Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAntimatroid

Antimatroid getAntimatroid()
                    throws OperationFailedException,
PermissionDeniedException

Gets the Antimatroid associated with this session.

Returns:

the antimatroid

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageElements

boolean canManageElements()

Tests if this user can add and remove eleemnts to a chain. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if managing elements is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addElement

void addElement(Id chainId,
 Id id)
         throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an element to a chain,

Parameters:

chainId - the Id of the chain

id - the Id of the element to add

Throws:

AlreadyExistsException - id already in chainId

NotFoundException - chainId or id not found

NullArgumentException - chainId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addElements

void addElements(Id chainId,
 IdList ids)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a list of ordered elements to a chain.

Parameters:

chainId - the Id of the chain

ids - the Ids of the elements to add

Throws:

AlreadyExistsException - an id already in chainId

NotFoundException - chainId or an id not found

NullArgumentException - chainIds or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeElement

void removeElement(Id chainId,
 Id id)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an element from a chain.

Parameters:

chainId - the Id of the chain

id - the Id of the element to remove

Throws:

NotFoundException - chainId or id not found, or id is not in chainId

NullArgumentException - chainId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.