public interface CatalogueHierarchyDesignSession extends OsidSession
This session manages a hierarchy of catalogues. Catalogues may be
organized into a hierarchy for organizing or federating. A parent
Catalogue
includes all of the canonical units of its children such
that a single root node contains all of the canonical units of the
federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildCatalogue(Id catalogueId,
Id childId)
Adds a child to a catalogue.
|
void |
addRootCatalogue(Id catalogueId)
Adds a root catalogue.
|
boolean |
canModifyCatalogueHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getCatalogueHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getCatalogueHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildCatalogue(Id catalogueId,
Id childId)
Removes a child from a catalogue.
|
void |
removeChildCatalogues(Id catalogueId)
Removes all children from a catalogue.
|
void |
removeRootCatalogue(Id catalogueId)
Removes a root catalogue.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getCatalogueHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyCatalogueHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootCatalogue(Id catalogueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
catalogueId
- the Id
of a catalogueAlreadyExistsException
- catalogueId
is
already in hierarchyNotFoundException
- catalogueId
is not
foundNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogueId
- the Id
of a catalogueNotFoundException
- catalogueId
is not
foundNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildCatalogue(Id catalogueId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
catalogueId
- the Id
of a cataloguechildId
- the Id
of the new childAlreadyExistsException
- catalogueId
is
already a parent of childId
NotFoundException
- catalogueId
or
childId
not foundNullArgumentException
- catalogueId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCatalogue(Id catalogueId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogueId
- the Id
of a cataloguechildId
- the Id
of the new childNotFoundException
- catalogueId
not a
parent of childId
NullArgumentException
- catalogueId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCatalogues(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogueId
- the Id
of a catalogueNotFoundException
- catalogueId
is not
foundNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.