org.osid.resource

Interface ResourceAgentSession

All Superinterfaces:

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

public interface ResourceAgentSession
extends OsidSession

This session provides methods to retrieve Resource to Agent mappings. An Agent may map to only one Resource while a Resource may map to multiple Agents.

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

Methods

Modifier and Type	Method and Description
boolean	canLookupResourceAgentMappings() Tests if this user can perform lookups of resource/agent mappings.
IdList	getAgentIdsByResource(Id resourceId) Gets the list of Agent Ids mapped to a Resource.
AgentList	getAgentsByResource(Id resourceId) Gets the list of Agents mapped to a Resource.
Bin	getBin() Gets the Bin associated with this session.
Id	getBinId() Gets the Bin Id associated with this session.
Resource	getResourceByAgent(Id agentId) Gets the Resource associated with the given agent.
Id	getResourceIdByAgent(Id agentId) Gets the Resource Id associated with the given agent.
void	useComparativeAgentView() 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	useFederatedBinView() Federates the view for methods in this session.
void	useIsolatedBinView() Isolates the view for methods in this session.
void	usePlenaryAgentView() A complete view of the Agent returns is desired.

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

getBinId

Id getBinId()

Gets the Bin Id associated with this session.

Returns:

the Bin Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBin

Bin getBin()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Bin associated with this session.

Returns:

the Bin associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupResourceAgentMappings

boolean canLookupResourceAgentMappings()

Tests if this user can perform lookups of resource/agent 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 mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAgentView

void useComparativeAgentView()

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.

usePlenaryAgentView

void usePlenaryAgentView()

A complete view of the Agent 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.

useFederatedBinView

void useFederatedBinView()

Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBinView

void useIsolatedBinView()

Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.

Compliance:

mandatory - This method is must be implemented.

getResourceIdByAgent

Id getResourceIdByAgent(Id agentId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Gets the Resource Id associated with the given agent.

Parameters:

agentId - Id of the Agent

Returns:

associated resource

Throws:

NotFoundException - agentId is not found

NullArgumentException - agentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResourceByAgent

Resource getResourceByAgent(Id agentId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the Resource associated with the given agent.

Parameters:

agentId - Id of the Agent

Returns:

associated resource

Throws:

NotFoundException - agentId is not found

NullArgumentException - agentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgentIdsByResource

IdList getAgentIdsByResource(Id resourceId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the list of Agent Ids mapped to a Resource.

Parameters:

resourceId - Id of a Resource

Returns:

list of agent Ids

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgentsByResource

AgentList getAgentsByResource(Id resourceId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the list of Agents mapped to a Resource.

Parameters:

resourceId - Id of a Resource

Returns:

list of agents

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.