Interface MapHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MapHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildMap(Id mapId, Id childId)	Adds a child to a map.
void	addRootMap(Id mapId)	Adds a root map.
boolean	canModifyMapHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getMapHierarchy()	Gets the hierarchy associated with this session.
Id	getMapHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildMap(Id mapId, Id childId)	Removes a child from a map.
void	removeChildMaps(Id mapId)	Removes all children from a map.
void	removeRootMap(Id mapId)	Removes a root map.

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

getMapHierarchyId

Id getMapHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMapHierarchy

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

canModifyMapHierarchy

boolean canModifyMapHierarchy()

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.

addRootMap

void addRootMap(Id mapId)
         throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root map.

Parameters:

mapId - the Id of a map

Throws:

AlreadyExistsException - mapId is already in hierarchy

NotFoundException - mapId not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootMap

void removeRootMap(Id mapId)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root map.

Parameters:

mapId - the Id of a map

Throws:

NotFoundException - mapId is not a root

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildMap

void addChildMap(Id mapId,
 Id childId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a map.

Parameters:

mapId - the Id of a map

childId - the Id of the new child

Throws:

AlreadyExistsException - mapId is already a parent of childId

NotFoundException - mapId or childId not found

NullArgumentException - mapId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildMap

void removeChildMap(Id mapId,
 Id childId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a map.

Parameters:

mapId - the Id of a map

childId - the Id of the new child

Throws:

NotFoundException - mapId is not parent of childId

NullArgumentException - mapId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildMaps

void removeChildMaps(Id mapId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a map.

Parameters:

mapId - the Id of a map

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.