Interface DispatchProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DispatchProcessorEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignDispatchProcessorEnablerToDispatchProcessor(Id dispatchProcessorEnablerId, Id dispatchProcessorId)	Adds an existing DispatchProcessorEnabler to a DispatchProcessor .
boolean	canAssignDispatchProcessorEnablers()	Tests if this user can alter dispatch processor enabler/dispatch processor mappings.
boolean	canSequenceDispatchProcessorEnablers()	Tests if this user can order DispatchProcessorEnablers .
Publisher	getPublisher()	Gets the Publisher associated with this session.
Id	getPublisherId()	Gets the Publisher Id associated with this session.
void	moveDispatchProcessorEnablerAhead(Id dispatchProcessorEnablerId, Id dispatchProcessorId, Id referenceId)	Reorders dispatch processor enablers for a dispatch processor by moving the specified dispatch processor enabler in front of a reference dispatch processor enabler.
void	moveDispatchProcessorEnablerBehind(Id dispatchProcessorEnablerId, Id dispatchProcessorId, Id referenceId)	Reorders dispatch processor enablers for a dispatch processor by moving the specified dispatch processor enabler behind a reference dispatch processor enabler.
void	orderDispatchProcessorEnablers(Id[] dispatchProcessorEnablerIds, Id dispatchProcessorId)	Reorders a set of dispatch processor enablers for a dispatch processor.
void	unassignDispatchProcessorEnablerFromDispatchProcessor(Id dispatchProcessorEnablerId, Id dispatchProcessorId)	Removes an existing DispatchProcessorEnabler from a DispatchProcessor .

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.

canAssignDispatchProcessorEnablers

boolean canAssignDispatchProcessorEnablers()

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

assignDispatchProcessorEnablerToDispatchProcessor

void assignDispatchProcessorEnablerToDispatchProcessor(Id dispatchProcessorEnablerId,
 Id dispatchProcessorId)
                                                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DispatchProcessorEnabler to a DispatchProcessor .

Parameters:

dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler

dispatchProcessorId - the Id of the DispatchProcessor

Throws:

AlreadyExistsException - dispatchProcessorEnablerId already applied to dispatchProcessorId

NotFoundException - dispatchProcessorEnablerId or dispatchProcessorId not found

NullArgumentException - dispatchProcessorEnablerId or dispatchProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDispatchProcessorEnablerFromDispatchProcessor

void unassignDispatchProcessorEnablerFromDispatchProcessor(Id dispatchProcessorEnablerId,
 Id dispatchProcessorId)
                                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing DispatchProcessorEnabler from a DispatchProcessor .

Parameters:

dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler

dispatchProcessorId - the Id of the DispatchProcessor

Throws:

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

NullArgumentException - dispatchProcessorEnablerId or dispatchProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceDispatchProcessorEnablers

boolean canSequenceDispatchProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveDispatchProcessorEnablerAhead

void moveDispatchProcessorEnablerAhead(Id dispatchProcessorEnablerId,
 Id dispatchProcessorId,
 Id referenceId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler

dispatchProcessorId - the Id of the DispatchProcessor

referenceId - the reference dispatch processor enabler Id

Throws:

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

NullArgumentException - dispatchProcessorEnablerId, dispatchProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveDispatchProcessorEnablerBehind

void moveDispatchProcessorEnablerBehind(Id dispatchProcessorEnablerId,
 Id dispatchProcessorId,
 Id referenceId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler

dispatchProcessorId - the Id of the DispatchProcessor

referenceId - the reference dispatch processor Id

Throws:

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

NullArgumentException - dispatchProcessorEnablerId, dispatchProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderDispatchProcessorEnablers

void orderDispatchProcessorEnablers(Id[] dispatchProcessorEnablerIds,
 Id dispatchProcessorId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of dispatch processor enablers for a dispatch processor.

Parameters:

dispatchProcessorEnablerIds - the Ids for a set of DispatchProcessorEnablers

dispatchProcessorId - the Id of the DispatchProcessor

Throws:

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

NullArgumentException - dispatchProcessorEnablerIds or dispatchProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.