public interface CanonicalUnitProcessorEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply
CanonicalUnitProcessorEnablers
to CanonicalUnitProcessors.
A CanonicalUnitProcessor
with multiple
CanonicalUnitProcessorEnablers
means any positive rule evaluation
across the enablers result in an effective CanonicalUnitProcessor.
Modifier and Type | Method and Description |
---|---|
void |
assignCanonicalUnitProcessorEnablerToCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId,
Id canonicalUnitProcessorId)
Adds an existing
CanonicalUnitProcessorEnabler to a
CanonicalUnitProcessor. |
boolean |
canAssignCanonicalUnitProcessorEnablers()
Tests if this user can alter canonical unit processor
enabler/canonical unit processor mappings.
|
boolean |
canSequenceCanonicalUnitProcessorEnablers()
Tests if this user can order
CanonicalUnitProcessors. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
moveCanonicalUnitProcessorEnablerAhead(Id canonicalUnitProcessorEnablerId,
Id canonicalUnitProcessorId,
Id referenceId)
Reorders canonical unit processor enablers for a canonical unit
processor by moving the specified canonical unit processor enabler in
front of a reference canonical unit processor enabler.
|
void |
moveCanonicalUnitProcessorEnablerBehind(Id canonicalUnitProcessorEnablerId,
Id canonicalUnitProcessorId,
Id referenceId)
Reorders canonical unit processor enablers for a canonical unit
processor by moving the specified canonical unit processor enabler
behind a reference canonical unit processor enabler.
|
void |
orderCanonicalUnitProcessorEnablers(Id[] canonicalUnitProcessorEnablerIds,
Id canonicalUnitProcessorId)
Reorders a set of canonical unit processor enablers for a canonical
unit processor.
|
void |
unassignCanonicalUnitProcessorEnablerFromCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId,
Id canonicalUnitProcessorId)
Removes a
CanonicalUnitProcessorEnabler from a
CanonicalUnitProcessor. |
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 canAssignCanonicalUnitProcessorEnablers()
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 assignCanonicalUnitProcessorEnablerToCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler
to a
CanonicalUnitProcessor.
canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
AlreadyExistsException
-
canonicalUnitProcessorEnablerId
already applied to
canonicalUnitProcessorId
NotFoundException
-
canonicalUnitProcessorEnablerId
or
canonicalUnitProcessorId
not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
or
canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCanonicalUnitProcessorEnablerFromCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler
from a
CanonicalUnitProcessor.
canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
NotFoundException
-
canonicalUnitProcessorEnablerId
or
canonicalUnitProcessorId
not found or not mappedNullArgumentException
-
canonicalUnitProcessorEnablerId
or
canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceCanonicalUnitProcessorEnablers()
CanonicalUnitProcessors.
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 CanonicalUnitProcessorEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveCanonicalUnitProcessorEnablerAhead(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorEnablerId
- the Id
of a
CanonicalUnitProcessorEnabler
canonicalUnitProcessorId
- the Id
of a
CanonicalUnitProcessor
referenceId
- the reference canonical unit processor Id
NotFoundException
-
canonicalUnitProcessorEnablerId, canonicalUnitProcesorId,
or referenceId
not found or,
canonicalUnitProcessorEnablerId
or referenceId
not related to canonicalUnitProcessorId
NullArgumentException
-
canonicalUnitProcessorEnablerId, canonicalUnitProcessorId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveCanonicalUnitProcessorEnablerBehind(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorEnablerId
- the Id
of a
CanonicalUnitProcessorEnabler
canonicalUnitProcessorId
- the Id
of a
CanonicalUnitProcessor
referenceId
- the reference canonical unit processor Id
NotFoundException
-
canonicalUnitProcessorEnablerId, canonicalUnitProcesorId,
or referenceId
not found or,
canonicalUnitProcessorEnablerId
or referenceId
not related to canonicalUnitProcessorId
NullArgumentException
-
canonicalUnitProcessorEnablerId, canonicalUnitProcessorId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderCanonicalUnitProcessorEnablers(Id[] canonicalUnitProcessorEnablerIds, Id canonicalUnitProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorEnablerIds
- the Ids
for a
set of CanonicalUnitProcessorEnablers
canonicalUnitProcessorId
- the Id
of a
CanonicalUnitProcessor
NotFoundException
- canonicalUnitProcessorId
not found or, a canonicalUnitProcessorEnablerId
not related to canonicalUnitProcessorId
NullArgumentException
-
canonicalUnitProcessorEnablerIds
or
canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.