Interface InquestHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InquestHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildInquest(Id inquestId, Id childId)	Adds a child to an inquest.
void	addRootInquest(Id inquestId)	Adds a root inquest.
boolean	canModifyInquestHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getInquestHierarchy()	Gets the hierarchy associated with this session.
Id	getInquestHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildInquest(Id inquestId, Id childId)	Removes a child from an inquest.
void	removeChildInquests(Id inquestId)	Removes all children from an inquest.
void	removeRootInquest(Id inquestId)	Removes a root inquest.

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

getInquestHierarchyId

Id getInquestHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getInquestHierarchy

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

canModifyInquestHierarchy

boolean canModifyInquestHierarchy()

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.

addRootInquest

void addRootInquest(Id inquestId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root inquest.

Parameters:

inquestId - the Id of an inquest

Throws:

AlreadyExistsException - inquestId is already in hierarchy

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootInquest

void removeRootInquest(Id inquestId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root inquest.

Parameters:

inquestId - the Id of an inquest

Throws:

NotFoundException - inquestId is not a root

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildInquest

void addChildInquest(Id inquestId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an inquest.

Parameters:

inquestId - the Id of an inquest

childId - the Id of the new child

Throws:

AlreadyExistsException - inquestId is already a parent of childId

NotFoundException - inquestId or childId not found

NullArgumentException - inquestId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildInquest

void removeChildInquest(Id inquestId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an inquest.

Parameters:

inquestId - the Id of an inquest

childId - the Id of the new child

Throws:

NotFoundException - inquestId is not parent of childId

NullArgumentException - inquestId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildInquests

void removeChildInquests(Id inquestId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an inquest.

Parameters:

inquestId - the Id of an inquest

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.