public interface CanonicalUnitProcessorCatalogueAssignmentSession extends OsidSession
This session provides methods to re-assign
CanonicalUnitProcessor
to Catalogue
mappings. A
CanonicalUnitProcessor
may appear in multiple
Catalogue
objects and removing the last reference to a
CanonicalUnitProcessor
is the equivalent of deleting it. Each
Catalogue
may have its own authorizations governing who is
allowed to operate on it.
Adding a reference of a CanonicalUnitProcessor
to
another Catalogue
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignCanonicalUnitProcessorToCatalogue(Id canonicalUnitProcessorId,
Id catalogueId)
Adds an existing
CanonicalUnitProcessor to an
Catalogue. |
boolean |
canAssignCanonicalUnitProcessors()
Tests if this user can alter canonical unit processor/catalogue
mappings.
|
boolean |
canAssignCanonicalUnitProcessorsToCatalogue(Id catalogueId)
Tests if this user can alter canonical unit processor/catalogue
mappings.
|
IdList |
getAssignableCatalogueIds(Id catalogueId)
Gets a list of catalogues including and under the given catalogue node
in which any canonical unit processor can be assigned.
|
IdList |
getAssignableCatalogueIdsForCanonicalUnitProcessor(Id catalogueId,
Id canonicalUnitProcessorId)
Gets a list of catalogues including and under the given catalogue node
in which a specific canonical unit processor can be assigned.
|
void |
reassignCanonicalUnitProcessorToCatalogue(Id canonicalUnitProcessorId,
Id fromCatalogueId,
Id toCatalogueId)
Moves a
CanonicalUnitProcessor from one
Catalogue to another. |
void |
unassignCanonicalUnitProcessorFromCatalogue(Id canonicalUnitProcessorId,
Id catalogueId)
Removes a
CanonicalUnitProcessor from a
Catalogue. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignCanonicalUnitProcessorsToCatalogue(Id catalogueId)
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users.catalogueId
- the Id
of the Catalogue
false
if mapping is not authorized, true
otherwiseNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. IdList getAssignableCatalogueIds(Id catalogueId) throws OperationFailedException
catalogueId
- the Id
of the Catalogue
Ids
NullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableCatalogueIdsForCanonicalUnitProcessor(Id catalogueId, Id canonicalUnitProcessorId) throws OperationFailedException
catalogueId
- the Id
of the Catalogue
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
Ids
NullArgumentException
- catalogueId
or
canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignCanonicalUnitProcessorToCatalogue(Id canonicalUnitProcessorId, Id catalogueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor
to an
Catalogue.
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
catalogueId
- the Id
of the Catalogue
AlreadyExistsException
-
canonicalUnitProcessorId
already assigned to
catalogueId
NotFoundException
- canonicalUnitProcessorId
or catalogueId
not foundNullArgumentException
- canonicalUnitProcessorId
or catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCanonicalUnitProcessorFromCatalogue(Id canonicalUnitProcessorId, Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor
from a
Catalogue.
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
catalogueId
- the Id
of the Catalogue
NotFoundException
- canonicalUnitProcessorId
or catalogueId
not found or
canonicalUnitProcessorId
not assigned to
catalogueId
NullArgumentException
- canonicalUnitProcessorId
or catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignCanonicalUnitProcessorToCatalogue(Id canonicalUnitProcessorId, Id fromCatalogueId, Id toCatalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor
from one
Catalogue
to another. Mappings to other Catalogues
are unaffected.canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
fromCatalogueId
- the Id
of the current
Catalogue
toCatalogueId
- the Id
of the destination
Catalogue
NotFoundException
- canonicalUnitProcessorId,
fromCatalogueId,
or toCatalogueId
not
found or canonicalUnitProcessorId,
not mapped
to fromCatalogueId
NullArgumentException
-
canonicalUnitProcessorId, fromCatalogueId,
or
toCatalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.