Interface DictionaryHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DictionaryHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of dictionaries. Dictionaries may be organized into a hierarchy for organizing or federating. A parent Dictionary includes all of the entries of its children such that a single root node contains all of the entries of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildDictionary(Id dictionaryId, Id childId)	Adds a child to a dictionary.
void	addRootDictionary(Id dictionaryId)	Adds a root dictionary.
boolean	canModifyDictionaryHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getDictionaryHierarchy()	Gets the hierarchy associated with this session.
Id	getDictionaryHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildDictionaries(Id dictionaryId)	Removes all children from a dictionary.
void	removeChildDictionary(Id dictionaryId, Id childId)	Removes a child from a dictionary.
void	removeRootDictionary(Id dictionaryId)	Removes a root dictionary.

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

getDictionaryHierarchyId

Id getDictionaryHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDictionaryHierarchy

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

canModifyDictionaryHierarchy

boolean canModifyDictionaryHierarchy()

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.

addRootDictionary

void addRootDictionary(Id dictionaryId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root dictionary.

Parameters:

dictionaryId - the Id of a dicrtionary

Throws:

AlreadyExistsException - dictionaryId is already in hierarchy

NotFoundException - dictionaryId not found

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootDictionary

void removeRootDictionary(Id dictionaryId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root dictionary.

Parameters:

dictionaryId - the Id of a dicrtionary

Throws:

NotFoundException - dictionaryId is not a root

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildDictionary

void addChildDictionary(Id dictionaryId,
 Id childId)
                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a dictionary.

Parameters:

dictionaryId - the Id of a dictionary

childId - the Id of the new child

Throws:

AlreadyExistsException - dictionaryId is already a parent of childId

NotFoundException - dictionaryId or childId not found

NullArgumentException - dictionaryId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildDictionary

void removeChildDictionary(Id dictionaryId,
 Id childId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a dictionary.

Parameters:

dictionaryId - the Id of a dictionary

childId - the Id of the new child

Throws:

NotFoundException - dictionaryId not a parent of childId

NullArgumentException - dictionaryId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildDictionaries

void removeChildDictionaries(Id dictionaryId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a dictionary.

Parameters:

dictionaryId - the Id of a dictionary

Throws:

NotFoundException - dictionaryId is not in hierarchy

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.