public interface CanonicalUnitProcessorRuleApplicationSession extends OsidSession
This session provides methods to apply CanonicalUnitProcessors
to CanonicalUnits.
Modifier and Type | Method and Description |
---|---|
void |
assignCanonicalUnitProcessorToCanonicalUnit(Id canonicalUnitProcessorId,
Id canonicalUnitId)
Adds an existing
CanonicalUnitProcessor to a
CanonicalUnit. |
boolean |
canAssignCanonicalUnitProcessors()
Tests if this user can alter canonical unit processor/canonical unit
mappings.
|
boolean |
canSequenceCanonicalUnitProcessors()
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 |
moveCanonicalUnitProcessorAhead(Id canonicalUnitProcessorId,
Id canonicalUnitId,
Id referenceId)
Reorders canonical unit processors for a canonical unit by moving the
specified canonical unit processor in front of a reference canonical
unit processor.
|
void |
moveCanonicalUnitProcessorBehind(Id canonicalUnitProcessorId,
Id canonicalUnitId,
Id referenceId)
Reorders canonical unit processors for a canonical unit by moving the
specified canonical unit processor behind a reference canonical unit
processor.
|
void |
orderCanonicalUnitProcessors(Id[] canonicalUnitProcessorIds,
Id canonicalUnitId)
Reorders a set of canonical unit processors for a canonical unit.
|
void |
unassignCanonicalUnitProcessorFromCanonicalUnit(Id canonicalUnitProcessorId,
Id canonicalUnitId)
Removes a
CanonicalUnitProcessor from a
CanonicalUnit. |
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 canAssignCanonicalUnitProcessors()
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 assignCanonicalUnitProcessorToCanonicalUnit(Id canonicalUnitProcessorId, Id canonicalUnitId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor
to a
CanonicalUnit.
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
canonicalUnitId
- the Id
of the
CanonicalUnit
AlreadyExistsException
-
canonicalUnitProcessorId
already applied to
canonicalUnitId
NotFoundException
- canonicalUnitProcessorId
or canonicalUnitId
not foundNullArgumentException
- canonicalUnitProcessorId
or canonicalUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCanonicalUnitProcessorFromCanonicalUnit(Id canonicalUnitProcessorId, Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor
from a
CanonicalUnit.
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
canonicalUnitId
- the Id
of the
CanonicalUnit
NotFoundException
- canonicalUnitProcessorId
or canonicalUnitId
not found or
canonicalUnitProcessorId
not applied to
canonicalUnitId
NullArgumentException
- canonicalUnitProcessorId
or canonicalUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceCanonicalUnitProcessors()
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 CanonicalUnitProcessor
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveCanonicalUnitProcessorAhead(Id canonicalUnitProcessorId, Id canonicalUnitId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorId
- the Id
of a
CanonicalUnitProcessor
canonicalUnitId
- the Id
of a
CanonicalUnit
referenceId
- the reference canonical unit processor Id
NotFoundException
- canonicalUnitProcessorId,
canonicalUnitId,
or referenceId
not
found or, canonicalUnitProcessorId
or
referenceId
not related to canonicalUnitId
NullArgumentException
-
canonicalUnitProcessorId, canonicalUnitId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveCanonicalUnitProcessorBehind(Id canonicalUnitProcessorId, Id canonicalUnitId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorId
- the Id
of a
CanonicalUnitProcessor
canonicalUnitId
- the Id
of a
CanonicalUnit
referenceId
- the reference canonical unit processor Id
NotFoundException
- canonicalUnitProcessorId,
canonicalUnitId,
or referenceId
not
found or, canonicalUnitProcessorId
or
referenceId
not related to canonicalUnitId
NullArgumentException
-
canonicalUnitProcessorId, canonicalUnitId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderCanonicalUnitProcessors(Id[] canonicalUnitProcessorIds, Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorIds
- the Ids
for a set of
CanonicalUnitProcessors
canonicalUnitId
- the Id
of a
CanonicalUnit
NotFoundException
- canonicalUnitId
not
found or, a canonicalUnitProcessorId
not
related to canonicalUnitId
NullArgumentException
-
canonicalUnitProcessorIds
or canonicalUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.