org.osid.sequencing

Interface ChainAntimatroidAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ChainAntimatroidAssignmentSession
extends OsidSession

This session provides methods to re-assign Chains to Antimatroid mappings. A Chain may appear in multiple Antimatroid objects and removing the last reference to a Chain is the equivalent of deleting it. Each Antimatroid may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Chain to another Antimatroid is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignChainToAntimatroid(Id chainId, Id antimatroidId) Adds an existing Chain to a Antimatroid.
boolean	canAssignChains() Tests if this user can alter chain/antimatroid mappings.
boolean	canAssignChainsToAntimatroid(Id antimatroidId) Tests if this user can alter chain/antimatroid mappings.
IdList	getAssignableAntimatroidIds(Id antimatroidId) Gets a list of antimatroids including and under the given antimatroid node in which any chain can be assigned.
IdList	getAssignableAntimatroidIdsForChain(Id antimatroidId, Id chainId) Gets a list of antimatroids including and under the given antimatroid node in which a specific chain can be assigned.
void	unassignChainFromAntimatroid(Id chainId, Id antimatroidId) Removes a Chain from a Antimatroid.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignChains

boolean canAssignChains()

Tests if this user can alter chain/antimatroid mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:

false if chain is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignChainsToAntimatroid

boolean canAssignChainsToAntimatroid(Id antimatroidId)

Tests if this user can alter chain/antimatroid mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parameters:

antimatroidId - the Id of the Antimatroid

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - antimatroidId is null

Compliance:

mandatory - This method must be implemented.

getAssignableAntimatroidIds

IdList getAssignableAntimatroidIds(Id antimatroidId)
                                   throws OperationFailedException

Gets a list of antimatroids including and under the given antimatroid node in which any chain can be assigned.

Parameters:

antimatroidId - the Id of the Antimatroid

Returns:

list of assignable antimatroid Ids

Throws:

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableAntimatroidIdsForChain

IdList getAssignableAntimatroidIdsForChain(Id antimatroidId,
                                         Id chainId)
                                           throws OperationFailedException

Gets a list of antimatroids including and under the given antimatroid node in which a specific chain can be assigned.

Parameters:

antimatroidId - the Id of the Antimatroid

chainId - the Id of the Chain

Returns:

list of assignable antimatroid Ids

Throws:

NullArgumentException - antimatroidId or chainId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignChainToAntimatroid

void assignChainToAntimatroid(Id chainId,
                            Id antimatroidId)
                              throws AlreadyExistsException,
                                     NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Adds an existing Chain to a Antimatroid.

Parameters:

chainId - the Id of the Chain

antimatroidId - the Id of the Antimatroid

Throws:

AlreadyExistsException - chainId is already assigned to antimatroidId

NotFoundException - chainId or antimatroidId not found

NullArgumentException - chainId or antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignChainFromAntimatroid

void unassignChainFromAntimatroid(Id chainId,
                                Id antimatroidId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Removes a Chain from a Antimatroid.

Parameters:

chainId - the Id of the Chain

antimatroidId - the Id of the Antimatroid

Throws:

NotFoundException - chainId or antimatroidId not found or chainId not assigned to antimatroidId

NullArgumentException - chainId or antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.