public interface PublisherHierarchyDesignSession extends OsidSession
This session manages a hierarchy of publishers. Publishers may be
organized into a hierarchy for organizing or federating. A parent
Publisher
includes all of the subscriptions of its children such
that a single root node contains all of the subscriptions of the
federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildPublisher(Id publisherId,
Id childId)
Adds a child to a publisher.
|
void |
addRootPublisher(Id publisherId)
Adds a root publisher.
|
boolean |
canModifyPublisherHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getPublisherHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getPublisherHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildPublisher(Id publisherId,
Id childId)
Removes a child from a publisher.
|
void |
removeChildPublishers(Id publisherId)
Removes all children from a publisher.
|
void |
removeRootPublisher(Id publisherId)
Removes a root publisher.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPublisherHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getPublisherHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyPublisherHierarchy()
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 addRootPublisher(Id publisherId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
publisherId
- the Id
of a publisherAlreadyExistsException
- publisherId
is
already in hierarchyNotFoundException
- publisherId
is not
foundNullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
publisherId
- the Id
of a publisherNotFoundException
- publisherId
is not a
rootNullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildPublisher(Id publisherId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
publisherId
- the Id
of a publisherchildId
- the Id
of the new childAlreadyExistsException
- publisherId
is
already a parent of childId
NotFoundException
- publisherId
or
childId
not foundNullArgumentException
- publisherId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildPublisher(Id publisherId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
publisherId
- the Id
of a publisherchildId
- the Id
of the new childNotFoundException
- publisherId
not a
parent of childId
NullArgumentException
- publisherId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildPublishers(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
publisherId
- the Id
of a publisherNotFoundException
- publisherId
not
foundNullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.