org.osid.authorization

Interface QualifierHierarchyDesignSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface QualifierHierarchyDesignSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildQualifier(Id qualifierId, Id childId) Adds a child to a qualifier.
void	addRootQualifier(Id qualifierId) Adds a root qualifier.
boolean	canModifyQualifierHierarchy() Tests if this user can change the hierarchy.
Hierarchy	getQualifierHierarchy() Gets the hierarchy associated with this session.
Id	getQualifierHierarchyId() Gets the hierarchy Id associated with this session.
void	removeChildQualifier(Id qualifierId, Id childId) Removes a child from a qualifier.
void	removeChildQualifiers(Id qualifierId) Removes all children from a qualifier.
void	removeRootQualifier(Id qualifierId) Removes a root qualifier from this hierarchy.

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

getQualifierHierarchyId

Id getQualifierHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getQualifierHierarchy

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

canModifyQualifierHierarchy

boolean canModifyQualifierHierarchy()

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.

addRootQualifier

void addRootQualifier(Id qualifierId)
                      throws AlreadyExistsException,
                             NotFoundException,
                             OperationFailedException,
                             PermissionDeniedException

Adds a root qualifier.

Parameters:

qualifierId - the Id of a qualifier

Throws:

AlreadyExistsException - qualifierId is already in hierarchy

NotFoundException - qualifierId not found

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootQualifier

void removeRootQualifier(Id qualifierId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Removes a root qualifier from this hierarchy.

Parameters:

qualifierId - the Id of a qualifier

Throws:

NotFoundException - qualifierId not a parent of childId

NullArgumentException - qualifierId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildQualifier

void addChildQualifier(Id qualifierId,
                     Id childId)
                       throws AlreadyExistsException,
                              NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Adds a child to a qualifier.

Parameters:

qualifierId - the Id of a qualifier

childId - the Id of the new child

Throws:

AlreadyExistsException - qualifierId is already a parent of childId

NotFoundException - qualifierId or childId not found

NullArgumentException - qualifierId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildQualifier

void removeChildQualifier(Id qualifierId,
                        Id childId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Removes a child from a qualifier.

Parameters:

qualifierId - the Id of a qualifier

childId - the Id of the child

Throws:

NotFoundException - qualifierId not parent of childId

NullArgumentException - qualifierId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildQualifiers

void removeChildQualifiers(Id qualifierId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Removes all children from a qualifier.

Parameters:

qualifierId - the Id of a qualifier

Throws:

NotFoundException - qualifierId is not in hierarchy

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.