Interface ChainAntimatroidSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ChainAntimatroidSession
extends OsidSession

This session provides methods to retrieve Chain to Antimatroid chains. A Chain may appear in multiple Antimatroid objects. Each antimatroid may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupChainAntimatroidChains()	Tests if this user can perform lookups of chain/antimatroid mappings.
IdList	getAntimatroidIdsByChain(Id chainId)	Gets the Antimatroid Ids mapped to a Chain .
AntimatroidList	getAntimatroidsByChain(Id chainId)	Gets the Antimatroids mapped to a Chain .
IdList	getChainIdsByAntimatroid(Id antimatroidId)	Gets the list of Chain Ids associated with a Antimatroid .
IdList	getChainIdsByAntimatroids(IdList antimatroidIds)	Gets the list of Chain Ids corresponding to a list of Antimatroids .
ChainList	getChainsByAntimatroid(Id antimatroidId)	Gets the list of Chains associated with a Antimatroid .
ChainList	getChainsByAntimatroids(IdList antimatroidIds)	Gets the list of Chains corresponding to a list of Antimatroids .
void	useComparativeChainAntimatroidView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryChainAntimatroidView()	A complete view of the Chain and Antimatroid returns is desired.

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

canLookupChainAntimatroidChains

boolean canLookupChainAntimatroidChains()

Tests if this user can perform lookups of chain/antimatroid mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up chains is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeChainAntimatroidView

void useComparativeChainAntimatroidView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryChainAntimatroidView

void usePlenaryChainAntimatroidView()

A complete view of the Chain and Antimatroid returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getChainIdsByAntimatroid

IdList getChainIdsByAntimatroid(Id antimatroidId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Chain Ids associated with a Antimatroid .

Parameters:

antimatroidId - Id of the Antimatroid

Returns:

list of related chain Ids

Throws:

NotFoundException - antimatroidId is not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChainsByAntimatroid

ChainList getChainsByAntimatroid(Id antimatroidId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Chains associated with a Antimatroid .

Parameters:

antimatroidId - Id of the Antimatroid

Returns:

list of related chains

Throws:

NotFoundException - antimatroidId is not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChainIdsByAntimatroids

IdList getChainIdsByAntimatroids(IdList antimatroidIds)
                          throws OperationFailedException,
PermissionDeniedException

Gets the list of Chain Ids corresponding to a list of Antimatroids .

Parameters:

antimatroidIds - list of antimatroid Ids

Returns:

list of chain Ids

Throws:

NullArgumentException - antimatroidIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChainsByAntimatroids

ChainList getChainsByAntimatroids(IdList antimatroidIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Chains corresponding to a list of Antimatroids .

Parameters:

antimatroidIds - list of antimatroid Ids

Returns:

list of chains

Throws:

NullArgumentException - antimatroidIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAntimatroidIdsByChain

IdList getAntimatroidIdsByChain(Id chainId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Antimatroid Ids mapped to a Chain .

Parameters:

chainId - Id of a Chain

Returns:

list of antimatroids

Throws:

NotFoundException - chainId is not found

NullArgumentException - chainId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAntimatroidsByChain

AntimatroidList getAntimatroidsByChain(Id chainId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Antimatroids mapped to a Chain .

Parameters:

chainId - Id of a Chain

Returns:

list of antimatroids

Throws:

NotFoundException - chainId is not found

NullArgumentException - chainId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.