org.osid.sequencing

Interface ElementLookupSession

All Superinterfaces:

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

public interface ElementLookupSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and 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 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

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.