Interface SubjectHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SubjectHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildSubject(Id subjectId, Id childId)	Adds a child to a subject.
void	addRootSubject(Id subjectId)	Adds a root subject.
boolean	canModifySubjectHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getSubjectHierarchy()	Gets the hierarchy associated with this session.
Id	getSubjectHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildSubject(Id subjectId, Id childId)	Removes a child from a subject.
void	removeChildSubjects(Id subjectId)	Removes all children from a subject.
void	removeRootSubject(Id subjectId)	Removes a root subject.

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

getSubjectHierarchyId

Id getSubjectHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSubjectHierarchy

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

canModifySubjectHierarchy

boolean canModifySubjectHierarchy()

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.

addRootSubject

void addRootSubject(Id subjectId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root subject.

Parameters:

subjectId - the Id of a subject

Throws:

AlreadyExistsException - subjectId is already in hierarchy

NotFoundException - subjectId not found

NullArgumentException - subjectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootSubject

void removeRootSubject(Id subjectId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root subject.

Parameters:

subjectId - the Id of a subject

Throws:

NotFoundException - subjectId not found

NullArgumentException - subjectId is null

OperationFailedException - the root subjects

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildSubject

void addChildSubject(Id subjectId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a subject.

Parameters:

subjectId - the Id of a subject

childId - the Id of the new child

Throws:

AlreadyExistsException - subjectId is already a parent of childId

NotFoundException - subjectId or childId not found

NullArgumentException - subjectId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildSubject

void removeChildSubject(Id subjectId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a subject.

Parameters:

subjectId - the Id of a subject

childId - the Id of the new child

Throws:

NotFoundException - subjectId not a parent of childId

NullArgumentException - subjectId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildSubjects

void removeChildSubjects(Id subjectId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a subject.

Parameters:

subjectId - the Id of a subject

Throws:

NotFoundException - subjectId not found

NullArgumentException - subjectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.