Interface DispatchConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DispatchConstrainerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignDispatchConstrainerToDispatch(Id dispatchConstrainerId, Id dispatchId)	Adds an existing DispatchConstrainer to a Dispatch.
boolean	canAssignDispatchConstrainers()	Tests if this user can alter dispatch constrainer/dispatch mappings.
boolean	canSequenceDispatchConstrainers()	Tests if this user can order DispatchConstrainers.
Publisher	getPublisher()	Gets the Publisher associated with this session.
Id	getPublisherId()	Gets the Publisher Id associated with this session.
void	moveDispatchConstrainerAhead(Id dispatchConstrainerId, Id dispatchId, Id referenceId)	Reorders dispatch constrainers for a dispatch by moving the specified dispatch constrainer in front of a reference dispatch constrainer.
void	moveDispatchConstrainerBehind(Id dispatchConstrainerId, Id dispatchId, Id referenceId)	Reorders dispatch constrainers for a dispatch by moving the specified dispatch constrainer behind a reference dispatch constrainer.
void	orderDispatchConstrainers(Id[] dispatchConstrainerIds, Id dispatchId)	Reorders a set of dispatch constrainers for a dispatch.
void	unassignDispatchConstrainerFromDispatch(Id dispatchConstrainerId, Id dispatchId)	Removes an existing DispatchConstrainer 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.

canAssignDispatchConstrainers

boolean canAssignDispatchConstrainers()

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

assignDispatchConstrainerToDispatch

void assignDispatchConstrainerToDispatch(Id dispatchConstrainerId,
 Id dispatchId)
                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DispatchConstrainer to a Dispatch.

Parameters:

dispatchConstrainerId - the Id of the DispatchConstrainer

dispatchId - the Id of the Dispatch

Throws:

AlreadyExistsException - dispatchConstrainerId already applied to dispatchId

NotFoundException - dispatchConstrainerId or dispatchId not found

NullArgumentException - dispatchConstrainerId or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDispatchConstrainerFromDispatch

void unassignDispatchConstrainerFromDispatch(Id dispatchConstrainerId,
 Id dispatchId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing DispatchConstrainer from a Dispatch.

Parameters:

dispatchConstrainerId - the Id of the DispatchConstrainer

dispatchId - the Id of the Dispatch

Throws:

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

NullArgumentException - dispatchConstrainerId or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceDispatchConstrainers

boolean canSequenceDispatchConstrainers()

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

Compliance:

mandatory - This method must be implemented.

moveDispatchConstrainerAhead

void moveDispatchConstrainerAhead(Id dispatchConstrainerId,
 Id dispatchId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders dispatch constrainers for a dispatch by moving the specified dispatch constrainer in front of a reference dispatch constrainer.

Parameters:

dispatchConstrainerId - the Id of the DispatchConstrainer

dispatchId - the Id of the Dispatch

referenceId - the reference dispatch constrainer Id

Throws:

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

NullArgumentException - dispatchConstrainerId, dispatchId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveDispatchConstrainerBehind

void moveDispatchConstrainerBehind(Id dispatchConstrainerId,
 Id dispatchId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders dispatch constrainers for a dispatch by moving the specified dispatch constrainer behind a reference dispatch constrainer.

Parameters:

dispatchConstrainerId - the Id of the DispatchConstrainer

dispatchId - the Id of the Dispatch

referenceId - the reference dispatch constrainer Id

Throws:

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

NullArgumentException - dispatchConstrainerId, dispatchId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderDispatchConstrainers

void orderDispatchConstrainers(Id[] dispatchConstrainerIds,
 Id dispatchId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of dispatch constrainers for a dispatch.

Parameters:

dispatchConstrainerIds - the Ids for a set of DispatchConstrainers

dispatchId - the Id of the Dispatch

Throws:

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

NullArgumentException - dispatchConstrainerIds or dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.