public interface OfferingConstrainerEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply
OfferingConstrainerEnablers
to OfferingConstrainers.
An OfferingConstrainer
with multiple
OfferingConstrainerEnablers
means any positive rule evaluation
across the enablers result in an effective OfferingConstrainer.
Modifier and Type | Method and Description |
---|---|
void |
assignOfferingConstrainerEnablerToOfferingConstrainer(Id offeringConstrainerEnablerId,
Id offeringConstrainerId)
Adds an existing
OfferingConstrainerEnabler to an
OfferingConstrainer. |
boolean |
canAssignOfferingConstrainerEnablers()
Tests if this user can alter offering constrainer enabler/offering
constrainer mappings.
|
boolean |
canSequenceOfferingConstrainerEnablers()
Tests if this user can order
OfferingConstrainerEnablers. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
moveOfferingConstrainerEnablerAhead(Id offeringConstrainerEnablerId,
Id offeringConstrainerId,
Id referenceId)
Reorders offering constrainer enablers for an offering constrainer by
moving the specified offering constrainer enabler in front of a
reference offering constrainer enabler.
|
void |
moveOfferingConstrainerEnablerBehind(Id offeringConstrainerEnablerId,
Id offeringConstrainerId,
Id referenceId)
Reorders offering constrainer enablers for a canonical unit by moving
the specified offering constrainer enabler behind a reference offering
constrainer enabler.
|
void |
orderOfferingConstrainerEnablers(Id[] offeringConstrainerEnablerIds,
Id offeringConstrainerId)
Reorders a set of offering constrainer enablers for an offering
constrainer.
|
void |
unassignOfferingConstrainerEnablerFromOfferingConstrainer(Id offeringConstrainerEnablerId,
Id offeringConstrainerId)
Removes an
OfferingConstrainerEnabler from an
OfferingConstrainer. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignOfferingConstrainerEnablers()
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 assignOfferingConstrainerEnablerToOfferingConstrainer(Id offeringConstrainerEnablerId, Id offeringConstrainerId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler
to an
OfferingConstrainer.
offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
offeringConstrainerId
- the Id
of the
OfferingConstrainer
AlreadyExistsException
-
offeringConstrainerEnablerId
already applied to
offeringConstrainerId
NotFoundException
- offeringConstrainerEnablerId
or offeringConstrainerId
not foundNullArgumentException
-
offeringConstrainerEnablerId
or
offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignOfferingConstrainerEnablerFromOfferingConstrainer(Id offeringConstrainerEnablerId, Id offeringConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler
from an
OfferingConstrainer.
offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
offeringConstrainerId
- the Id
of the
OfferingConstrainer
NotFoundException
- offeringConstrainerEnablerId
or offeringConstrainerId
not found or
offeringConstrainerEnablerId
not applied to
offeringConstrainerId
NullArgumentException
-
offeringConstrainerEnablerId
or
offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceOfferingConstrainerEnablers()
OfferingConstrainerEnablers.
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 OfferingConstrainerEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveOfferingConstrainerEnablerAhead(Id offeringConstrainerEnablerId, Id offeringConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerId
- the Id
of an
OfferingConstrainerEnabler
offeringConstrainerId
- the Id
of an
OfferingConstrainer
referenceId
- the reference offering constrainer enabler
Id
NotFoundException
-
offeringConstrainerEnablerId, offeringConstrainerId,
or referenceId
not found or,
offeringConstrainerEnablerId
or referenceId
not related to offeringConstrainerId
NullArgumentException
-
offeringConstrainerEnablerId, offeringConstrainerId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveOfferingConstrainerEnablerBehind(Id offeringConstrainerEnablerId, Id offeringConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerId
- the Id
of an
OfferingConstrainerEnabler
offeringConstrainerId
- the Id
of an
OfferingConstrainer
referenceId
- the reference offering constrainer enabler
Id
NotFoundException
-
offeringConstrainerEnablerId, offeringConstrainerId,
or referenceId
not found or,
offeringConstrainerEnablerId
or referenceId
not related to offeringConstrainerId
NullArgumentException
-
offeringConstrainerEnablerId, offeringConstrainerId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderOfferingConstrainerEnablers(Id[] offeringConstrainerEnablerIds, Id offeringConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerIds
- the Ids
for a set
of OfferingConstrainerEnablers
offeringConstrainerId
- the Id
of an
OfferingConstrainer
NotFoundException
- canonicalUnitConstraienrId
not found or, an offeringConstrainerEnablerId
not related to offeringConstrainerId
NullArgumentException
-
offeringConstrainerEnablerIds
or
offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.