Interface DispatchConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DispatchConstrainerEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignDispatchConstrainerEnablerToDispatchConstrainer(Id dispatchConstrainerEnablerId, Id dispatchConstrainerId)	Adds an existing DispatchConstrainerEnabler to a DispatchConstrainer.
boolean	canAssignDispatchConstrainerEnablers()	Tests if this user can alter dispatch constrainer enabler/dispatch constrainer mappings.
boolean	canSequenceDispatchConstrainerEnablers()	Tests if this user can order DispatchConstrainerEnablers.
Publisher	getPublisher()	Gets the Publisher associated with this session.
Id	getPublisherId()	Gets the Publisher Id associated with this session.
void	moveDispatchConstrainerEnablerAhead(Id dispatchConstrainerEnablerId, Id dispatchConstrainerId, Id referenceId)	Reorders dispatch constrainer enablers for a dispatch constrainer by moving the specified dispatch constrainer enabler in front of a reference dispatch constrainer enabler.
void	moveDispatchConstrainerEnablerBehind(Id dispatchConstrainerEnablerId, Id dispatchConstrainerId, Id referenceId)	Reorders dispatch constrainer enablers for a dispatch constrainer by moving the specified dispatch constrainer enabler behind a reference dispatch constrainer enabler.
void	orderDispatchConstrainerEnablers(Id[] dispatchConstrainerEnablerIds, Id dispatchConstrainerId)	Reorders a set of dispatch constrainer enablers for a dispatch constrainer.
void	unassignDispatchConstrainerEnablerFromDispatchConstrainer(Id dispatchConstrainerEnablerId, Id dispatchConstrainerId)	Removes an existing DispatchConstrainerEnabler from a DispatchConstrainer.

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.

canAssignDispatchConstrainerEnablers

boolean canAssignDispatchConstrainerEnablers()

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

assignDispatchConstrainerEnablerToDispatchConstrainer

void assignDispatchConstrainerEnablerToDispatchConstrainer(Id dispatchConstrainerEnablerId,
 Id dispatchConstrainerId)
                                                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DispatchConstrainerEnabler to a DispatchConstrainer.

Parameters:

dispatchConstrainerEnablerId - the Id of the DispatchConstrainerEnabler

dispatchConstrainerId - the Id of the DispatchConstrainer

Throws:

AlreadyExistsException - dispatchConstrainerEnablerId already applied to dispatchConstrainerId

NotFoundException - dispatchConstrainerEnablerId or dispatchConstrainerId not found

NullArgumentException - dispatchConstrainerEnablerId or dispatchConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDispatchConstrainerEnablerFromDispatchConstrainer

void unassignDispatchConstrainerEnablerFromDispatchConstrainer(Id dispatchConstrainerEnablerId,
 Id dispatchConstrainerId)
                                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing DispatchConstrainerEnabler from a DispatchConstrainer.

Parameters:

dispatchConstrainerEnablerId - the Id of the DispatchConstrainerEnabler

dispatchConstrainerId - the Id of the DispatchConstrainer

Throws:

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

NullArgumentException - dispatchConstrainerEnablerId or dispatchConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceDispatchConstrainerEnablers

boolean canSequenceDispatchConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveDispatchConstrainerEnablerAhead

void moveDispatchConstrainerEnablerAhead(Id dispatchConstrainerEnablerId,
 Id dispatchConstrainerId,
 Id referenceId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchConstrainerEnablerId - the Id of the DispatchConstrainerEnabler

dispatchConstrainerId - the Id of the DispatchConstrainer

referenceId - the reference dispatch constrainer enabler Id

Throws:

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

NullArgumentException - dispatchConstrainerEnablerId, dispatchConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveDispatchConstrainerEnablerBehind

void moveDispatchConstrainerEnablerBehind(Id dispatchConstrainerEnablerId,
 Id dispatchConstrainerId,
 Id referenceId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchConstrainerEnablerId - the Id of the DispatchConstrainerEnabler

dispatchConstrainerId - the Id of the DispatchConstrainer

referenceId - the reference dispatch constrainer Id

Throws:

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

NullArgumentException - dispatchConstrainerEnablerId, dispatchConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderDispatchConstrainerEnablers

void orderDispatchConstrainerEnablers(Id[] dispatchConstrainerEnablerIds,
 Id dispatchConstrainerId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchConstrainerEnablerIds - the Ids for a set of DispatchConstrainerEnablers

dispatchConstrainerId - the Id of the DispatchConstrainer

Throws:

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

NullArgumentException - dispatchConstrainerEnablerIds or dispatchConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.