Interface DispatchProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DispatchProcessorRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignDispatchProcessorToDispatch(Id dispatchProcessorId, Id dispatchId)	Adds an existing DispatchProcessor to a Dispatch.
boolean	canAssignDispatchProcessors()	Tests if this user can alter dispatch processor/dispatch mappings.
boolean	canSequenceDispatchProcessors()	Tests if this user can order DispatchProcessors.
Publisher	getPublisher()	Gets the Publisher associated with this session.
Id	getPublisherId()	Gets the Publisher Id associated with this session.
void	moveDispatchProcessorAhead(Id dispatchProcessorId, Id dispatchId, Id referenceId)	Reorders dispatch processors for a dispatch by moving the specified dispatch processor in front of a reference dispatch processor.
void	moveDispatchProcessorBehind(Id dispatchProcessorId, Id dispatchId, Id referenceId)	Reorders dispatch processors for a dispatch by moving the specified dispatch processor behind a reference dispatch processor.
void	orderDispatchProcessors(Id[] dispatchProcessorIds, Id dispatchId)	Reorders a set of dispatch processors for a dispatch.
void	unassignDispatchProcessorFromDispatch(Id dispatchProcessorId, Id dispatchId)	Removes an existing DispatchProcessor 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.

canAssignDispatchProcessors

boolean canAssignDispatchProcessors()

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

assignDispatchProcessorToDispatch

void assignDispatchProcessorToDispatch(Id dispatchProcessorId,
 Id dispatchId)
                                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DispatchProcessor to a Dispatch.

Parameters:

dispatchProcessorId - the Id of the DispatchProcessor

dispatchId - the Id of the Dispatch

Throws:

AlreadyExistsException - dispatchProcessorId already applied to dispatchId

NotFoundException - dispatchProcessorId or dispatchId not found

NullArgumentException - dispatchProcessorId or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDispatchProcessorFromDispatch

void unassignDispatchProcessorFromDispatch(Id dispatchProcessorId,
 Id dispatchId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing DispatchProcessor from a Dispatch.

Parameters:

dispatchProcessorId - the Id of the DispatchProcessor

dispatchId - the Id of the Dispatch

Throws:

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

NullArgumentException - dispatchProcessorId or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceDispatchProcessors

boolean canSequenceDispatchProcessors()

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

Compliance:

mandatory - This method must be implemented.

moveDispatchProcessorAhead

void moveDispatchProcessorAhead(Id dispatchProcessorId,
 Id dispatchId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders dispatch processors for a dispatch by moving the specified dispatch processor in front of a reference dispatch processor.

Parameters:

dispatchProcessorId - the Id of the DispatchProcessor

dispatchId - the Id of the Dispatch

referenceId - the reference dispatch processor Id

Throws:

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

NullArgumentException - dispatchProcessorId, dispatchId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveDispatchProcessorBehind

void moveDispatchProcessorBehind(Id dispatchProcessorId,
 Id dispatchId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders dispatch processors for a dispatch by moving the specified dispatch processor behind a reference dispatch processor.

Parameters:

dispatchProcessorId - the Id of the DispatchProcessor

dispatchId - the Id of the Dispatch

referenceId - the reference dispatch processor Id

Throws:

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

NullArgumentException - dispatchProcessorId, dispatchId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderDispatchProcessors

void orderDispatchProcessors(Id[] dispatchProcessorIds,
 Id dispatchId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of dispatch processors for a dispatch.

Parameters:

dispatchProcessorIds - the Ids for a set of DispatchProcessors

dispatchId - the Id of the Dispatch

Throws:

NotFoundException - dispatchId not found or, a dispatchProcessorId not related to dispatchId

NullArgumentException - dispatchProcessorIds or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.