Interface DispatchConstrainerEnablerPublisherAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DispatchConstrainerEnablerPublisherAssignmentSession
extends OsidSession

This session provides methods to re-assign DispatchConstrainerEnabler to Publisher mappings. A DispatchConstrainerEnabler may appear in multiple Publisher catalogs and removing the last reference to a DispatchConstrainerEnabler is the equivalent of deleting it. Each Publisher may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a DispatchConstrainerEnabler to another Publisher is n ot a copy operation (eg: does not change its Id ).

Method Summary

Modifier and Type	Method	Description
void	assignDispatchConstrainerEnablerToPublisher(Id dispatchConstrainerEnablerId, Id publisherId)	Adds an existing DispatchConstrainerEnabler to a Publisher .
boolean	canAssignDispatchConstrainerEnablers()	Tests if this user can alter dispatch constrainer enabler/publisher mappings.
boolean	canAssignDispatchConstrainerEnablerToPublisher(Id publisherId)	Tests if this user can alter dispatch constrainer enabler/publisher mappings.
IdList	getAssignablePublisherIds(Id publisherId)	Gets a list of publishers including and under the given publisher node in which any dispatch constrainer enabler can be assigned.
IdList	getAssignablePublisherIdsForDispatchConstrainerEnabler(Id publisherId, Id dispatchConstrainerEnablerId)	Gets a list of publishers including and under the given publisher node in which a specific dispatch constrainer enabler can be assigned.
void	reassignDispatchConstrainerEnablerToPublisher(Id dispatchConstrainerEnablerId, Id fromPublisherId, Id toPublisherId)	Moves a DispatchConstrainerEnabler from one Publisher to another.
void	unassignDispatchConstrainerEnablerFromPublisher(Id dispatchConstrainerEnablerId, Id publisherId)	Removes a DispatchConstrainerEnabler from a Publisher .

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

canAssignDispatchConstrainerEnablers

boolean canAssignDispatchConstrainerEnablers()

Tests if this user can alter dispatch constrainer enabler/publisher 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignDispatchConstrainerEnablerToPublisher

boolean canAssignDispatchConstrainerEnablerToPublisher(Id publisherId)

Tests if this user can alter dispatch constrainer enabler/publisher 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parameters:

publisherId - the Id of the Publisher

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - publisherId is null

Compliance:

mandatory - This method must be implemented.

getAssignablePublisherIds

IdList getAssignablePublisherIds(Id publisherId)
                          throws OperationFailedException

Gets a list of publishers including and under the given publisher node in which any dispatch constrainer enabler can be assigned.

Parameters:

publisherId - the Id of the Publisher

Returns:

list of assignable publisher Ids

Throws:

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignablePublisherIdsForDispatchConstrainerEnabler

IdList getAssignablePublisherIdsForDispatchConstrainerEnabler(Id publisherId,
 Id dispatchConstrainerEnablerId)
                                                       throws OperationFailedException

Gets a list of publishers including and under the given publisher node in which a specific dispatch constrainer enabler can be assigned.

Parameters:

publisherId - the Id of the Publisher

dispatchConstrainerEnablerId - the Id of the DispatchConstrainerEnabler

Returns:

list of assignable publisher Ids

Throws:

NullArgumentException - publisherId or dispatchConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignDispatchConstrainerEnablerToPublisher

void assignDispatchConstrainerEnablerToPublisher(Id dispatchConstrainerEnablerId,
 Id publisherId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DispatchConstrainerEnabler to a Publisher .

Parameters:

dispatchConstrainerEnablerId - the Id of the DispatchConstrainerEnabler

publisherId - the Id of the Publisher

Throws:

AlreadyExistsException - dispatchConstrainerEnablerId is already assigned to publisherId

NotFoundException - dispatchConstrainerEnablerId or publisherId not found

NullArgumentException - dispatchConstrainerEnablerId or publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDispatchConstrainerEnablerFromPublisher

void unassignDispatchConstrainerEnablerFromPublisher(Id dispatchConstrainerEnablerId,
 Id publisherId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a DispatchConstrainerEnabler from a Publisher .

Parameters:

dispatchConstrainerEnablerId - the Id of the DispatchConstraienrEnabler

publisherId - the Id of the Publisher

Throws:

NotFoundException - dispatchConstrainerEnablerId or publisherId not found or dispatchConstrainerEnablerId not assigned to publisherId

NullArgumentException - dispatchConstrainerEnablerId or publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignDispatchConstrainerEnablerToPublisher

void reassignDispatchConstrainerEnablerToPublisher(Id dispatchConstrainerEnablerId,
 Id fromPublisherId,
 Id toPublisherId)
                                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves a DispatchConstrainerEnabler from one Publisher to another. Mappings to other Publishers are unaffected.

Parameters:

dispatchConstrainerEnablerId - the Id of the DispatchConstrainerEnabler

fromPublisherId - the Id of the current Publisher

toPublisherId - the Id of the destination Publisher

Throws:

AlreadyExistsException - dispatchConstrainerEnablerId already assigned to toPublisherId

NotFoundException - dispatchConstrainerEnablerId, fromPublisherId , or toPublisherId not found or dispatchConstrainerEnablerId not mapped to fromPublisherId

NullArgumentException - dispatchConstrainerEnablerId, fromPublisherId , or toPublisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.