public interface SubscriptionEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply SubscriptionEnablers
to Subscriptions.
A Subscription
with multiple SubscriptionEnablers
means any positive rule
evaluation across the enablers result in an effective Subscription.
Modifier and Type | Method and Description |
---|---|
void |
assignSubscriptionEnablerToSubscription(Id subscriptionEnablerId,
Id subscriptionId)
Adds an existing
SubscriptionEnabler to a
Subscription. |
boolean |
canAssignSubscriptionEnablers()
Tests if this user can alter subscription enabler/subscription
mappings.
|
boolean |
canSequenceSubscriptionEnablers()
Tests if this user can order
SubscriptionEnablers. |
Publisher |
getPublisher()
Gets the
Publisher associated with this session. |
Id |
getPublisherId()
Gets the
Publisher Id associated with
this session. |
void |
moveSubscriptionEnablerAhead(Id subscriptionEnablerId,
Id subscriptionId,
Id referenceId)
Reorders subscription enablers for a subscription by moving the
specified subscription enabler in front of a reference subscription
enabler.
|
void |
moveSubscriptionEnablerBehind(Id subscriptionEnablerId,
Id subscriptionId,
Id referenceId)
Reorders subscription enablers for a subscription by moving the
specified subscription enabler behind a reference subscription
enabler.
|
void |
orderSubscriptionEnablers(Id[] subscriptionEnablerIds,
Id subscriptionId)
Reorders a set of subscription enablers for a subscription.
|
void |
unassignSubscriptionEnablerFromSubscription(Id subscriptionEnablerId,
Id subscriptionId)
Removes a
SubscriptionEnabler from a
Subscription. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPublisherId()
Publisher
Id
associated with
this session. Publisher Id
associated with this sessionmandatory
- This method must be implemented. Publisher getPublisher() throws OperationFailedException, PermissionDeniedException
Publisher
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. 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. void assignSubscriptionEnablerToSubscription(Id subscriptionEnablerId, Id subscriptionId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler
to a
Subscription.
subscriptionEnablerId
- the Id
of the
SubscriptionEnabler
subscriptionId
- the Id
of the
Subscription
AlreadyExistsException
- subscriptionEnablerId
is already applied to subscriptionId
NotFoundException
- subscriptionEnablerId
or subscriptionId
not foundNullArgumentException
- subscriptionEnablerId
or subscriptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSubscriptionEnablerFromSubscription(Id subscriptionEnablerId, Id subscriptionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler
from a
Subscription.
subscriptionEnablerId
- the Id
of the
SubscriptionEnabler
subscriptionId
- the Id
of the
Subscription
NotFoundException
- subscriptionEnablerId
or subscriptionId
not found or
subscriptionEnablerId
not applied to
subscriptionId
NullArgumentException
- subscriptionEnablerId
or subscriptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceSubscriptionEnablers()
SubscriptionEnablers.
A
return of true does not guarantee successful authorization. A return
of false indicates that it is known sequencing operations will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer sequencing operations to an
unauthorized user. false
if SubscriptionEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveSubscriptionEnablerAhead(Id subscriptionEnablerId, Id subscriptionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
subscriptionEnablerId
- the Id
of a
SubscriptionEnabler
subscriptionId
- the Id
of a Subscription
referenceId
- the reference subscription enabler Id
NotFoundException
- subscriptionEnablerId,
subscriptionId,
or referenceId
not
found or, subscriptionEnabelrId
or
referenceId
not related to subscriptionId
NullArgumentException
- subscriptionEnablerId,
subscriptionId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveSubscriptionEnablerBehind(Id subscriptionEnablerId, Id subscriptionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
subscriptionEnablerId
- the Id
of a
SubscriptionEnabler
subscriptionId
- the Id
of a Subscription
referenceId
- the reference subscription enabler Id
NotFoundException
- subscriptionEnablerId,
subscriptionId,
or referenceId
not
found or, subscriptionEnabelrId
or
referenceId
not related to subscriptionId
NullArgumentException
- subscriptionEnablerId,
subscriptionId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderSubscriptionEnablers(Id[] subscriptionEnablerIds, Id subscriptionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
subscriptionEnablerIds
- the Ids
for a set of
SubscriptionEnablers
subscriptionId
- the Id
of a Subscription
NotFoundException
- subscriptionId
not
found or, an subscriptionEnabelrId
not related
to subscriptionId
NullArgumentException
- subscriptionEnablerIds
or subscriptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.