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

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).

MethodcanAssignDispatchConstrainerEnablers
Description

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.

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

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.

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 enabler 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.
MethodgetAssignablePublisherIdsForDispatchConstrainerEnabler
Description

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

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

Adds an existing DispatchConstrainerEnabler to a Publisher.

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

Removes a DispatchConstrainerEnabler from a Publisher.

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

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

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