org.osid.ontology

Interface SubjectHierarchyDesignSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.