Interface EngineHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EngineHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of engines. Engines may be organized into a hierarchy for organizing or federating. A parent Engine includes all of the search of its children such that a single root node contains all of the search of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildEngine(Id engineId, Id childId)	Adds a child to an engine.
void	addRootEngine(Id engineId)	Adds a root engine.
boolean	canModifyEngineHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getEngineHierarchy()	Gets the hierarchy associated with this session.
Id	getEngineHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildEngine(Id engineId, Id childId)	Removes a child from an engine.
void	removeChildEngines(Id engineId)	Removes all children from an engine.
void	removeRootEngine(Id engineId)	Removes a root engine.

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

getEngineHierarchyId

Id getEngineHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEngineHierarchy

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

canModifyEngineHierarchy

boolean canModifyEngineHierarchy()

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.

addRootEngine

void addRootEngine(Id engineId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root engine.

Parameters:

engineId - the Id of an engine

Throws:

AlreadyExistsException - engineId is already in hierarchy

NotFoundException - engineId not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootEngine

void removeRootEngine(Id engineId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root engine.

Parameters:

engineId - the Id of an engine

Throws:

NotFoundException - engineId not a root

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildEngine

void addChildEngine(Id engineId,
 Id childId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an engine.

Parameters:

engineId - the Id of an engine

childId - the Id of the new child

Throws:

AlreadyExistsException - engineId is already a parent of childId

NotFoundException - engineId or childId not found

NullArgumentException - engineId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildEngine

void removeChildEngine(Id engineId,
 Id childId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an engine.

Parameters:

engineId - the Id of an engine

childId - the Id of the new child

Throws:

NotFoundException - engineId not a parent of childId

NullArgumentException - engineId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildEngines

void removeChildEngines(Id engineId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an engine.

Parameters:

engineId - the Id of an engine

Throws:

NotFoundException - engineId not in hierarchy

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.