OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.DispatchConstrainerPublisherAssignmentSession
Implementsosid.OsidSession
Used Byosid.subscription.rules.SubscriptionRulesManager
osid.subscription.rules.SubscriptionRulesProxyManager
Description

This session provides methods to re-assign DispatchConstrainer to Publisher mappings. A DispatchConstrainer may appear in multiple Publisher catalogs and removing the last reference to a DispatchConstrainer 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 DispatchConstrainer to another Publisher is n ot a copy operation (eg: does not change its Id).

MethodcanAssignDispatchConstrainers
Description

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

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignDispatchConstrainerToPublisher
Description

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

Parametersosid.id.IdpublisherId the Id of the Publisher
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT publisherId is null
Compliancemandatory This method must be implemented.
MethodgetAssignablePublisherIds
Description

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

Parametersosid.id.IdpublisherId the Id of the Publisher
Returnosid.id.IdList list of assignable publisher Ids
ErrorsNULL_ARGUMENT publisherId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignablePublisherIdsForDispatchConstrainer
Description

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

Parametersosid.id.IdpublisherId the Id of the Publisher
osid.id.IddispatchConstrainerId the Id of the DispatchConstrainer
Returnosid.id.IdList list of assignable publisher Ids
ErrorsNULL_ARGUMENT publisherId or dispatchConstrainerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignDispatchConstrainerToPublisher
Description

Adds an existing DispatchConstrainer to a Publisher.

Parametersosid.id.IddispatchConstrainerId the Id of the DispatchConstrainer
osid.id.IdpublisherId the Id of the Publisher
ErrorsALREADY_EXISTS dispatchConstrainerId is already assigned to publisherId
NOT_FOUND dispatchConstrainerId or publisherId not found
NULL_ARGUMENT dispatchConstrainerId or publisherId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignDispatchConstrainerFromPublisher
Description

Removes a DispatchConstrainer from a Publisher.

Parametersosid.id.IddispatchConstrainerId the Id of the DispatchConstraienr
osid.id.IdpublisherId the Id of the Publisher
ErrorsNOT_FOUND dispatchConstrainerId or publisherId not found or dispatchConstrainerId not assigned to publisherId
NULL_ARGUMENT dispatchConstrainerId or publisherId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignDispatchConstrainerToPublisher
Description

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

Parametersosid.id.IddispatchConstrainerId the Id of the DispatchConstrainer
osid.id.IdfromPublisherId the Id of the current Publisher
osid.id.IdtoPublisherId the Id of the destination Publisher
ErrorsALREADY_EXISTS dispatchConstrainerId already assigned to toPublisherId
NOT_FOUND dispatchConstrainerId, fromPublisherId, or toPublisherId not found or dispatchConstrainerId not mapped to fromPublisherId
NULL_ARGUMENT dispatchConstrainerId, fromPublisherId, or toPublisherId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.