OSID Logo
OSID Specifications
subscription rules package
Version 3.0.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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis 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.IdpublisherIdthe Id of the Publisher
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTpublisherId is null
CompliancemandatoryThis 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.IdpublisherIdthe Id of the Publisher
Returnosid.id.IdListlist of assignable publisher Ids
ErrorsNULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.IdpublisherIdthe Id of the Publisher
osid.id.IddispatchConstrainerEnablerIdthe Id of the DispatchConstrainerEnabler
Returnosid.id.IdListlist of assignable publisher Ids
ErrorsNULL_ARGUMENTpublisherId or dispatchConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignDispatchConstrainerEnablerToPublisher
Description

Adds an existing DispatchConstrainerEnabler to a Publisher .

Parametersosid.id.IddispatchConstrainerEnablerIdthe Id of the DispatchConstrainerEnabler
osid.id.IdpublisherIdthe Id of the Publisher
ErrorsALREADY_EXISTSdispatchConstrainerEnablerId is already assigned to publisherId
NOT_FOUNDdispatchConstrainerEnablerId or publisherId not found
NULL_ARGUMENTdispatchConstrainerEnablerId or publisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignDispatchConstrainerEnablerFromPublisher
Description

Removes a DispatchConstrainerEnabler from a Publisher .

Parametersosid.id.IddispatchConstrainerEnablerIdthe Id of the DispatchConstraienrEnabler
osid.id.IdpublisherIdthe Id of the Publisher
ErrorsNOT_FOUNDdispatchConstrainerEnablerId or publisherId not found or dispatchConstrainerEnablerId not assigned to publisherId
NULL_ARGUMENTdispatchConstrainerEnablerId or publisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignDispatchConstrainerEnablerToPublisher
Description

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

Parametersosid.id.IddispatchConstrainerEnablerIdthe Id of the DispatchConstrainerEnabler
osid.id.IdfromPublisherIdthe Id of the current Publisher
osid.id.IdtoPublisherIdthe Id of the destination Publisher
ErrorsALREADY_EXISTSdispatchConstrainerEnablerId already assigned to toPublisherId
NOT_FOUNDdispatchConstrainerEnablerId, fromPublisherId , or toPublisherId not found or dispatchConstrainerEnablerId not mapped to fromPublisherId
NULL_ARGUMENTdispatchConstrainerEnablerId, fromPublisherId , or toPublisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.