Interface OublietteHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OublietteHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Oubliette objects. Each node in the hierarchy is a unique Oubliette .

Method Summary

Modifier and Type	Method	Description
void	addChildOubliette(Id oublietteId, Id childId)	Adds a child to an oubliette.
void	addRootOubliette(Id oublietteId)	Adds a root oubliette.
boolean	canModifyOublietteHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getOublietteHierarchy()	Gets the hierarchy associated with this session.
Id	getOublietteHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildOubliette(Id oublietteId, Id childId)	Removes a child from an oubliette.
void	removeChildOubliettes(Id oublietteId)	Removes all children from an oubliette.
void	removeRootOubliette(Id oublietteId)	Removes a root oubliette.

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

getOublietteHierarchyId

Id getOublietteHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOublietteHierarchy

Hierarchy getOublietteHierarchy()
                         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.

canModifyOublietteHierarchy

boolean canModifyOublietteHierarchy()

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.

addRootOubliette

void addRootOubliette(Id oublietteId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root oubliette.

Parameters:

oublietteId - the Id of an oubliette

Throws:

AlreadyExistsException - oublietteId is already in hierarchy

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootOubliette

void removeRootOubliette(Id oublietteId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root oubliette.

Parameters:

oublietteId - the Id of an oubliette

Throws:

NotFoundException - oublietteId is not a root

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildOubliette

void addChildOubliette(Id oublietteId,
 Id childId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an oubliette.

Parameters:

oublietteId - the Id of an oubliette

childId - the Id of the new child

Throws:

AlreadyExistsException - oublietteId is already a parent of childId

NotFoundException - oublietteId or childId not found

NullArgumentException - oublietteId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOubliette

void removeChildOubliette(Id oublietteId,
 Id childId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an oubliette.

Parameters:

oublietteId - the Id of an oubliette

childId - the Id of the new child

Throws:

NotFoundException - oublietteId is not parent of childId

NullArgumentException - oublietteId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOubliettes

void removeChildOubliettes(Id oublietteId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an oubliette.

Parameters:

oublietteId - the Id of an oubliette

Throws:

NotFoundException - oublietteId is not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.