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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getQualifierHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getQualifierHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyQualifierHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootQualifier(Id qualifierId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
qualifierId
- the Id
of a qualifierAlreadyExistsException
- qualifierId
is
already in hierarchyNotFoundException
- qualifierId
not
foundNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootQualifier(Id qualifierId) throws NotFoundException, OperationFailedException, PermissionDeniedException
qualifierId
- the Id
of a qualifierNotFoundException
- qualifierId
not a
parent of childId
NullArgumentException
- qualifierId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildQualifier(Id qualifierId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
qualifierId
- the Id
of a qualifierchildId
- the Id
of the new childAlreadyExistsException
- qualifierId
is
already a parent of childId
NotFoundException
- qualifierId
or
childId
not foundNullArgumentException
- qualifierId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildQualifier(Id qualifierId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
qualifierId
- the Id
of a qualifierchildId
- the Id
of the childNotFoundException
- qualifierId
not
parent of childId
NullArgumentException
- qualifierId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildQualifiers(Id qualifierId) throws NotFoundException, OperationFailedException, PermissionDeniedException
qualifierId
- the Id
of a qualifierNotFoundException
- qualifierId
is not
in hierarchyNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.