public interface SubscriptionEnablerPublisherAssignmentSession extends OsidSession
This session provides methods to re-assign SubscriptionEnabler
to Publisher
mappings. A SubscriptionEnabler
may appear in multiple Publisher
objects and
removing the last reference to a SubscriptionEnabler
is the
equivalent of deleting it. Each Subscription
may have its
own authorizations governing who is allowed to operate on it.
Adding a reference of a SubscriptionEnabler
to another
Publisher
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSubscriptionEnablerToPublisher(Id subscriptionEnablerId,
Id publisherId)
Adds an existing
SubscriptionEnabler to a
Publisher. |
boolean |
canAssignSubscriptionEnablers()
Tests if this user can alter subscription enabler/publisher mappings.
|
boolean |
canAssignSubscriptionEnablersToPublisher(Id publisherId)
Tests if this user can alter subscription enabler/publisher mappings.
|
IdList |
getAssignablePublisherIds(Id publisherId)
Gets a list of publishers including and under the given publisher node
in which any publisher enabler can be assigned.
|
IdList |
getAssignablePublisherIdsForSubscriptionEnabler(Id publisherId,
Id subscriptionEnablerId)
Gets a list of publishers including and under the given publisher node
in which a specific publisher enabler can be assigned.
|
void |
reassignSubscriptionEnablerToPublisher(Id subscriptionEnablerId,
Id fromPublisherId,
Id toPublisherId)
Moves a
SubscriptionEnabler from one Publisher
to another. |
void |
unassignSubscriptionEnablerFromPublisher(Id subscriptionEnablerId,
Id publisherId)
Removes a
SubscriptionEnabler from a Publisher. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignSubscriptionEnablers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignSubscriptionEnablersToPublisher(Id publisherId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.publisherId
- the Id
of the Publisher
false
if mapping is not authorized, true
otherwiseNullArgumentException
- publisherId
is
null
mandatory
- This method must be implemented. IdList getAssignablePublisherIds(Id publisherId) throws OperationFailedException
publisherId
- the Id
of the Publisher
Ids
NullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignablePublisherIdsForSubscriptionEnabler(Id publisherId, Id subscriptionEnablerId) throws OperationFailedException
publisherId
- the Id
of the Publisher
subscriptionEnablerId
- the Id
of the
SubscriptionEnabler
Ids
NullArgumentException
- publisherId
or
subscriptionEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSubscriptionEnablerToPublisher(Id subscriptionEnablerId, Id publisherId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler
to a
Publisher.
subscriptionEnablerId
- the Id
of the
SubscriptionEnabler
publisherId
- the Id
of the Publisher
AlreadyExistsException
- subscriptionEnablerId
is already assigned to publisherId
NotFoundException
- subscriptionEnablerId
or publisherId
not foundNullArgumentException
- subscriptionEnablerId
or publisherId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSubscriptionEnablerFromPublisher(Id subscriptionEnablerId, Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler
from a Publisher.
subscriptionEnablerId
- the Id
of the
SubscriptionEnabler
publisherId
- the Id
of the Publisher
NotFoundException
- subscriptionEnablerId
or publisherId
not found or
subscriptionEnablerId
not assigned to
publisherId
NullArgumentException
- subscriptionEnablerId
or publisherId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignSubscriptionEnablerToPublisher(Id subscriptionEnablerId, Id fromPublisherId, Id toPublisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler
from one Publisher
to another. Mappings to other Publishers
are
unaffected.subscriptionEnablerId
- the Id
of the
SubscriptionEnabler
fromPublisherId
- the Id
of the current
Publisher
toPublisherId
- the Id
of the destination
Publisher
NotFoundException
- subscriptionEnablerId,
fromPublisherId,
or toPublisherId
not
found or subscriptionEnablerId
not mapped to
fromPublisherId
NullArgumentException
- subscriptionEnablerId,
fromPublisherId,
or toPublisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.