Interface DispatchEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DispatchEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply DispatchEnablers to Dispatches . Multiple DispatchEnablers applied to an Dispatch may be sequenced such that the first positive evaluation results in the DispatchEnablers used.

Method Summary

Modifier and Type	Method	Description
void	assignDispatchEnablerToDispatch(Id dispatchEnablerId, Id dispatchId)	Adds an existing DispatchEnabler to a Dispatch .
boolean	canAssignDispatchEnablers()	Tests if this user can alter dispatch enabler/dispatch mappings.
boolean	canSequenceDispatchEnablers()	Tests if this user can order DispatchEnablers .
Publisher	getPublisher()	Gets the Publisher associated with this session.
Id	getPublisherId()	Gets the Publisher Id associated with this session.
void	moveDispatchEnablerAhead(Id dispatchEnablerId, Id dispatchId, Id referenceId)	Reorders dispatch enablers for a dispatch by moving the specified dispatch enabler in front of a reference dispatch enabler.
void	moveDispatchEnablerBehind(Id dispatchEnablerId, Id dispatchId, Id referenceId)	Reorders dispatch enablers for a dispatch by moving the specified dispatch enabler behind a reference dispatch enabler.
void	orderDispatchEnablers(Id[] dispatchEnablerIds, Id dispatchId)	Reorders a set of dispatch enablers for a dispatch.
void	unassignDispatchEnablerFromDispatch(Id dispatchEnablerId, Id dispatchId)	Removes an existing DispatchEnabler from a Dispatch .

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

getPublisherId

Id getPublisherId()

Gets the Publisher Id associated with this session.

Returns:

the Publisher Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPublisher

Publisher getPublisher()
                throws OperationFailedException,
PermissionDeniedException

Gets the Publisher associated with this session.

Returns:

the publisher

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignDispatchEnablers

boolean canAssignDispatchEnablers()

Tests if this user can alter dispatch enabler/dispatch 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.

assignDispatchEnablerToDispatch

void assignDispatchEnablerToDispatch(Id dispatchEnablerId,
 Id dispatchId)
                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DispatchEnabler to a Dispatch .

Parameters:

dispatchEnablerId - the Id of the DispatchEnabler

dispatchId - the Id of the Dispatch

Throws:

AlreadyExistsException - dispatchEnablerId already applied to dispatchId

NotFoundException - dispatchEnablerId or dispatchId not found

NullArgumentException - dispatchEnablerId or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDispatchEnablerFromDispatch

void unassignDispatchEnablerFromDispatch(Id dispatchEnablerId,
 Id dispatchId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing DispatchEnabler from a Dispatch .

Parameters:

dispatchEnablerId - the Id of the DispatchEnabler

dispatchId - the Id of the Dispatch

Throws:

NotFoundException - dispatchEnablerId or dispatchId not found or dispatchEnablerId already applied to dispatchId

NullArgumentException - dispatchEnablerId or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceDispatchEnablers

boolean canSequenceDispatchEnablers()

Tests if this user can order DispatchEnablers . 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 DispatchEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveDispatchEnablerAhead

void moveDispatchEnablerAhead(Id dispatchEnablerId,
 Id dispatchId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchEnablerId - the Id of the DispatchEnabler

dispatchId - the Id of the Dispatch

referenceId - the reference dispatch enabler Id

Throws:

NotFoundException - dispatchEnablerId, dispatchId , or referenceId not found or, dispatchEnablerId or referenceId not related to dispatchId

NullArgumentException - dispatchEnablerId, dispatchId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveDispatchEnablerBehind

void moveDispatchEnablerBehind(Id dispatchEnablerId,
 Id dispatchId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchEnablerId - the Id of the DispatchEnabler

dispatchId - the Id of the Dispatch

referenceId - the reference dispatch enabler Id

Throws:

NotFoundException - dispatchEnablerId, dispatchId , or referenceId not found or, dispatchEnablerId or referenceId not related to dispatchId

NullArgumentException - dispatchEnablerId, dispatchId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderDispatchEnablers

void orderDispatchEnablers(Id[] dispatchEnablerIds,
 Id dispatchId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of dispatch enablers for a dispatch.

Parameters:

dispatchEnablerIds - the Ids for a set of DispatchEnablers

dispatchId - the Id of the Dispatch

Throws:

NotFoundException - dispatchEnablerId, dispatchId , or referenceId not found or, dispatchEnablerId or referenceId not related to dispatchId

NullArgumentException - dispatchEnablerIds, dispatchId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.