public interface CanonicalUnitProcessorEnablerCatalogueAssignmentSession extends OsidSession
This session provides methods to re-assign
CanonicalUnitProcessorEnabler
to Catalogue
mappings. A CanonicalUnitProcessorEnabler
may appear in
multiple Catalogue
objects and removing the last reference
to a CanonicalUnitProcessorEnabler
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 CanonicalUnitProcessorEnabler
to another Catalogue
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId,
Id catalogueId)
Adds an existing
CanonicalUnitProcessorEnabler to a
Catalogue. |
boolean |
canAssignCanonicalUnitProcessorEnablers()
Tests if this user can alter canonical unit processor
enabler/catalogue mappings.
|
boolean |
canAssignCanonicalUnitProcessorEnablersToCatalogue(Id catalogueId)
Tests if this user can alter canonical unit processor
enabler/catalogue mappings.
|
IdList |
getAssignableCatalogueIds(Id catalogueId)
Gets a list of catalogues including and under the given catalogue node
in which any canonical unit processor enabler can be assigned.
|
IdList |
getAssignableCatalogueIdsForCanonicalUnitProcessorEnabler(Id catalogueId,
Id canonicalUnitProcessorEnablerId)
Gets a list of catalogues including and under the given catalogue node
in which a specific canonical unit processor enabler can be assigned.
|
void |
reassignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId,
Id fromCatalogueId,
Id toCatalogueId)
Moves a
CanonicalUnitProcessorEnabler from one
Catalogue to another. |
void |
unassignCanonicalUnitProcessorEnablerFromCatalogue(Id canonicalUnitProcessorEnablerId,
Id catalogueId)
Removes a
CanonicalUnitProcessorEnabler from a
Catalogue. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignCanonicalUnitProcessorEnablersToCatalogue(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 getAssignableCatalogueIdsForCanonicalUnitProcessorEnabler(Id catalogueId, Id canonicalUnitProcessorEnablerId) throws OperationFailedException
catalogueId
- the Id
of the Catalogue
canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
Ids
NullArgumentException
- catalogueId
or
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId, Id catalogueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler
to a
Catalogue.
canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
catalogueId
- the Id
of the Catalogue
AlreadyExistsException
-
canonicalUnitProcessorEnablerId
already assigned to
catalogueId
NotFoundException
-
canonicalUnitProcessorEnablerId
or catalogueId
not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
or catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCanonicalUnitProcessorEnablerFromCatalogue(Id canonicalUnitProcessorEnablerId, Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler
from a
Catalogue.
canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
catalogueId
- the Id
of the Catalogue
NotFoundException
-
canonicalUnitProcessorEnablerId
or catalogueId
not found or canonicalUnitProcessorEnablerId
not assigned to catalogueId
NullArgumentException
-
canonicalUnitProcessorEnablerId
or catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId, Id fromCatalogueId, Id toCatalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler
from one
Catalogue
to another. Mappings to other Catalogues
are unaffected.canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
fromCatalogueId
- the Id
of the current
Catalogue
toCatalogueId
- the Id
of the destination
Catalogue
NotFoundException
-
canonicalUnitProcessorEnablerId, fromCatalogueId,
or
toCatalogueId
not found or
canonicalUnitProcessorEnablerId,
not mapped to
fromCatalogueId
NullArgumentException
-
canonicalUnitProcessorEnablerId, fromCatalogueId,
or
toCatalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.