Interface PublisherHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getPublisherHierarchyId

Id getPublisherHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPublisherHierarchy

Hierarchy getPublisherHierarchy()
                         throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyPublisherHierarchy

boolean canModifyPublisherHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootPublisher

void addRootPublisher(Id publisherId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root publisher.

Parameters:

publisherId - the Id of a publisher

Throws:

AlreadyExistsException - publisherId is already in hierarchy

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootPublisher

void removeRootPublisher(Id publisherId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root publisher.

Parameters:

publisherId - the Id of a publisher

Throws:

NotFoundException - publisherId is not a root

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildPublisher

void addChildPublisher(Id publisherId,
 Id childId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a publisher.

Parameters:

publisherId - the Id of a publisher

childId - the Id of the new child

Throws:

AlreadyExistsException - publisherId is already a parent of childId

NotFoundException - publisherId or childId not found

NullArgumentException - publisherId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildPublisher

void removeChildPublisher(Id publisherId,
 Id childId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a publisher.

Parameters:

publisherId - the Id of a publisher

childId - the Id of the new child

Throws:

NotFoundException - publisherId not a parent of childId

NullArgumentException - publisherId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildPublishers

void removeChildPublishers(Id publisherId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a publisher.

Parameters:

publisherId - the Id of a publisher

Throws:

NotFoundException - publisherId not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.