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