Interface LogHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LogHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of logs. Logs may be organized into a hierarchy for organizing or federating. A parent Log includes all of the Ids of its children such that a single root node contains all of the Ids of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildLog(Id logId, Id childId)	Adds a child to a log.
void	addRootLog(Id logId)	Adds a root log.
boolean	canModifyLogHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getLogHierarchy()	Gets the hierarchy associated with this session.
Id	getLogHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildLog(Id logId, Id childId)	Removes a child from a log.
void	removeChildLogs(Id logId)	Removes all children from a log.
void	removeRootLog(Id logId)	Removes a root log.

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

getLogHierarchyId

Id getLogHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getLogHierarchy

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

canModifyLogHierarchy

boolean canModifyLogHierarchy()

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.

addRootLog

void addRootLog(Id logId)
         throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root log.

Parameters:

logId - the Id of a log

Throws:

AlreadyExistsException - logId is already in hierarchy

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootLog

void removeRootLog(Id logId)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root log.

Parameters:

logId - the Id of a log

Throws:

NotFoundException - logId is not a root

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildLog

void addChildLog(Id logId,
 Id childId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a log.

Parameters:

logId - the Id of a log

childId - the Id of the new child

Throws:

AlreadyExistsException - logId is already a parent of childId

NotFoundException - logId or childId not found

NullArgumentException - logId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildLog

void removeChildLog(Id logId,
 Id childId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a log.

Parameters:

logId - the Id of a log

childId - the Id of the new child

Throws:

NotFoundException - logId not a parent of childId

NullArgumentException - logId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildLogs

void removeChildLogs(Id logId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a log.

Parameters:

logId - the Id of a log

Throws:

NotFoundException - logId not in hierarchy

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.