Interface ResourceAgentAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ResourceAgentAssignmentSession
extends OsidSession

This session provides methods to re-assign Resource to Agents . A Resource may be associated with multiple Agents . An Agent may map to only one Resource .

Method Summary

Modifier and Type	Method	Description
void	assignAgentToResource(Id agentId, Id resourceId)	Adds an existing Agent to a Resource .
boolean	canAssignAgents()	Tests if this user can alter resource/agent mappings.
boolean	canAssignAgentsToResource(Id resourceId)	Tests if this user can alter resource/agent mappings.
Bin	getBin()	Gets the Bin associated with this session.
Id	getBinId()	Gets the Bin Id associated with this session.
void	reassignAgentToResource(Id agentId, Id fromResourceId, Id toResourceId)	Moves an Agent from one Resource to another.
void	unassignAgentFromResource(Id agentId, Id resourceId)	Removes an Agent from a Resource .

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

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.

canAssignAgents

boolean canAssignAgents()

Tests if this user can alter resource/agent 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignAgentsToResource

boolean canAssignAgentsToResource(Id resourceId)

Tests if this user can alter resource/agent mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known location 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:

resourceId - the Id of the Resource

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

assignAgentToResource

void assignAgentToResource(Id agentId,
 Id resourceId)
                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Agent to a Resource .

Parameters:

agentId - the Id of the Agent

resourceId - the Id of the Resource

Throws:

AlreadyExistsException - agentId is already assigned to resourceId

NotFoundException - agentId or resourceId not found

NullArgumentException - agentId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAgentFromResource

void unassignAgentFromResource(Id agentId,
 Id resourceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Agent from a Resource .

Parameters:

agentId - the Id of the Agent

resourceId - the Id of the Resource

Throws:

NotFoundException - agentId or resourceId not found or agentId not assigned to resourceId

NullArgumentException - agentId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignAgentToResource

void reassignAgentToResource(Id agentId,
 Id fromResourceId,
 Id toResourceId)
                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an Agent from one Resource to another.

Parameters:

agentId - the Id of the Agent

fromResourceId - the Id of the current Resource

toResourceId - the Id of the destination Resource

Throws:

AlreadyExistsException - agentId already assigned to toBinId

NotFoundException - agentId, fromResourceId , or toResourceId not found or agentId not mapped to fromResourceId

NullArgumentException - agentId, fromResourceId , or toResourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.