public interface CatalogHierarchyDesignSession extends OsidSession
This session manages a hierarchy of catalogs. Catalogs
may be organized into a hierarchy for organizing or federating. A parent
Catalog
includes all of the Ids of its children such that a
single root node contains all of the Ids
of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildCatalog(Id catalogId,
Id childId)
Adds a child to a catalog.
|
void |
addRootCatalog(Id catalogId)
Adds a root catalog.
|
boolean |
canModifyCatalogHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getCatalogHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getCatalogHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildCatalog(Id catalogId,
Id childId)
Removes a child from a catalog.
|
void |
removeChildCatalogs(Id catalogId)
Removes all children from a catalog.
|
void |
removeRootCatalog(Id catalogId)
Removes a root catalog.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getCatalogHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- assessment failuremandatory
- This method must be implemented. boolean canModifyCatalogHierarchy()
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 addRootCatalog(Id catalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
catalogId
- the Id
of a catalogAlreadyExistsException
- catalogId
is
already in hierarchyNotFoundException
- catalogId
not foundNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void removeRootCatalog(Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogId
- the Id
of a catalogNotFoundException
- catalogId
is not a
rootNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void addChildCatalog(Id catalogId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
catalogId
- the Id
of a catalogchildId
- the Id
of the new childAlreadyExistsException
- catalogId
is
already a parent of childId
NotFoundException
- catalogId
or
childId
not foundNullArgumentException
- catalogId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void removeChildCatalog(Id catalogId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogId
- the Id
of a catalogchildId
- the Id
of the new childNotFoundException
- catalogId
is not a
parent of childId
NullArgumentException
- catalogId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void removeChildCatalogs(Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogId
- the Id
of a catalogNotFoundException
- catalogId
is not in
hierarchyNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.