Interface JournalHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JournalHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildJournal(Id journalId, Id childId)	Adds a child to a journal.
void	addRootJournal(Id journalId)	Adds a root journal.
boolean	canModifyJournalHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getJournalHierarchy()	Gets the hierarchy associated with this session.
Id	getJournalHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildJournal(Id journalId, Id childId)	Removes a child from a journal.
void	removeChildJournals(Id journalId)	Removes all children from a journal.
void	removeRootJournal(Id journalId)	Removes a root journal.

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

getJournalHierarchyId

Id getJournalHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getJournalHierarchy

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

canModifyJournalHierarchy

boolean canModifyJournalHierarchy()

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.

addRootJournal

void addRootJournal(Id journalId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root journal.

Parameters:

journalId - the Id of a journal

Throws:

AlreadyExistsException - journalId is already in hierarchy

NotFoundException - journalId is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootJournal

void removeRootJournal(Id journalId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root journal.

Parameters:

journalId - the Id of a journal

Throws:

NotFoundException - journalId is not a root

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildJournal

void addChildJournal(Id journalId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a journal.

Parameters:

journalId - the Id of a journal

childId - the Id of the new child

Throws:

AlreadyExistsException - journalId is already a parent of childId

NotFoundException - journalId or childId not found

NullArgumentException - journalId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildJournal

void removeChildJournal(Id journalId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a journal.

Parameters:

journalId - the Id of a journal

childId - the Id of the new child

Throws:

NotFoundException - journalId not a parent of childId

NullArgumentException - journalId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildJournals

void removeChildJournals(Id journalId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a journal.

Parameters:

journalId - the Id of a journal

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.