Interface EdgeEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EdgeEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply EdgeEnablers to Edges. An Edge with multiple EdgeEnablers means any positive rule evaluation across the enablers result in an effective Edge.

Method Summary

Modifier and Type	Method	Description
void	assignEdgeEnablerToEdge(Id edgeEnablerId, Id edgeId)	Adds an existing EdgeEnabler to an Edge.
boolean	canAssignEdgeEnablers()	Tests if this user can alter edge enabler/edge mappings.
boolean	canSequenceEdgeEnablers()	Tests if this user can order EdgeEnablers.
Graph	getGraph()	Gets the Graph associated with this session.
Id	getGraphId()	Gets the Graph Id associated with this session.
void	moveEdgeEnablerAhead(Id edgeEnablerId, Id edgeId, Id referenceId)	Reorders edge enablers for an edge by moving the specified edge enabler in front of a reference edge enabler.
void	moveEdgeEnablerBehind(Id edgeEnablerId, Id edgeId, Id referenceId)	Reorders edge enablers for an edge by moving the specified edge enabler behind a reference edge enabler.
void	orderEdgeEnablers(Id[] edgeEnablerIds, Id edgeId)	Reorders a set of edge enablers for an edge.
void	unassignEdgeEnablerFromEdge(Id edgeEnablerId, Id edgeId)	Removes an EdgeEnabler from an Edge.

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

getGraphId

Id getGraphId()

Gets the Graph Id associated with this session.

Returns:

the Graph Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraph

Graph getGraph()
        throws OperationFailedException,
PermissionDeniedException

Gets the Graph associated with this session.

Returns:

the graph

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignEdgeEnablers

boolean canAssignEdgeEnablers()

Tests if this user can alter edge enabler/edge 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 lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignEdgeEnablerToEdge

void assignEdgeEnablerToEdge(Id edgeEnablerId,
 Id edgeId)
                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing EdgeEnabler to an Edge.

Parameters:

edgeEnablerId - the Id of the EdgeEnabler

edgeId - the Id of the Edge

Throws:

AlreadyExistsException - edgeEnablerId is already applied to edgeId

NotFoundException - edgeEnablerId or edgeId not found

NullArgumentException - edgeEnablerId or edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignEdgeEnablerFromEdge

void unassignEdgeEnablerFromEdge(Id edgeEnablerId,
 Id edgeId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an EdgeEnabler from an Edge.

Parameters:

edgeEnablerId - the Id of the EdgeEnabler

edgeId - the Id of the Edge

Throws:

NotFoundException - edgeEnablerId or edgeId not found or edgeEnablerId is not applied to edgeId

NullArgumentException - edgeEnablerId or edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceEdgeEnablers

boolean canSequenceEdgeEnablers()

Tests if this user can order EdgeEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if EdgeEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveEdgeEnablerAhead

void moveEdgeEnablerAhead(Id edgeEnablerId,
 Id edgeId,
 Id referenceId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders edge enablers for an edge by moving the specified edge enabler in front of a reference edge enabler.

Parameters:

edgeEnablerId - the Id of an EdgeEnabler

edgeId - the Id of an Edge

referenceId - the reference edge enabler Id

Throws:

NotFoundException - edgeEnablerId, edgeId, or referenceId not found or, edgeEnablerId or referenceId not related to edgeId

NullArgumentException - edgeEnablerId, edgeId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveEdgeEnablerBehind

void moveEdgeEnablerBehind(Id edgeEnablerId,
 Id edgeId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders edge enablers for an edge by moving the specified edge enabler behind a reference edge enabler.

Parameters:

edgeEnablerId - the Id of an EdgeEnabler

edgeId - the Id of an Edge

referenceId - the reference edge enabler Id

Throws:

NotFoundException - edgeEnablerId, edgeId, or referenceId not found or, edgeEnablerId or referenceId not related to edgeId

NullArgumentException - edgeEnablerId, edgeId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderEdgeEnablers

void orderEdgeEnablers(Id[] edgeEnablerIds,
 Id edgeId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of edge enablers for an edge.

Parameters:

edgeEnablerIds - the Ids for a set of EdgeEnablers

edgeId - the Id of an Edge

Throws:

NotFoundException - edgeId not found or, an edgeEnablerId not related to edgeId

NullArgumentException - edgeEnablerIds or edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.