Interface ElementLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ElementLookupSession
extends OsidSession

This session provides methods to get the sequence of elements in a Chain .

Method Summary

Modifier and Type	Method	Description
boolean	canLookupElements()	Tests if this user can lookup eleemnts to a chain.
Antimatroid	getAntimatroid()	Gets the Antimatroid associated with this session.
Id	getAntimatroidId()	Gets the Antimatroid Id associated with this session.
void	getElements(Id chainId)	Gets the ordered list of elements 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.

canLookupElements

boolean canLookupElements()

Tests if this user can lookup 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 looking up elements is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getElements

void getElements(Id chainId)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the ordered list of elements from a Chain .

Parameters:

chainId - the Id of the chain

Throws:

NotFoundException - chainId not found

NullArgumentException - chainId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.