org.osid.sequencing

Interface AntimatroidHierarchyDesignSession

All Superinterfaces:

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

public interface AntimatroidHierarchyDesignSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildAntimatroid(Id antimatroidId, Id childId) Adds a child to an antimatroid.
void	addRootAntimatroid(Id antimatroidId) Adds a root antimatroid.
boolean	canModifyAntimatroidHierarchy() Tests if this user can change the hierarchy.
Hierarchy	getAntimatroidHierarchy() Gets the hierarchy associated with this session.
Id	getAntimatroidHierarchyId() Gets the hierarchy Id associated with this session.
void	removeChildAntimatroid(Id antimatroidId, Id childId) Removes a child from an antimatroid.
void	removeChildAntimatroids(Id antimatroidId) Removes all children from an antimatroid.
void	removeRootAntimatroid(Id antimatroidId) Removes a root antimatroid.

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

getAntimatroidHierarchyId

Id getAntimatroidHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAntimatroidHierarchy

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

canModifyAntimatroidHierarchy

boolean canModifyAntimatroidHierarchy()

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.

addRootAntimatroid

void addRootAntimatroid(Id antimatroidId)
                        throws AlreadyExistsException,
                               NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Adds a root antimatroid.

Parameters:

antimatroidId - the Id of an antimatroid

Throws:

AlreadyExistsException - antimatroidId is already in hierarchy

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootAntimatroid

void removeRootAntimatroid(Id antimatroidId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Removes a root antimatroid.

Parameters:

antimatroidId - the Id of an antimatroid

Throws:

NotFoundException - antimatroidId is not a root

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildAntimatroid

void addChildAntimatroid(Id antimatroidId,
                       Id childId)
                         throws AlreadyExistsException,
                                NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Adds a child to an antimatroid.

Parameters:

antimatroidId - the Id of an antimatroid

childId - the Id of the new child

Throws:

AlreadyExistsException - antimatroidId is already a parent of childId

NotFoundException - antimatroidId or childId not found

NullArgumentException - antimatroidId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAntimatroid

void removeChildAntimatroid(Id antimatroidId,
                          Id childId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Removes a child from an antimatroid.

Parameters:

antimatroidId - the Id of an antimatroid

childId - the Id of the new child

Throws:

NotFoundException - antimatroidId is not parent of childId

NullArgumentException - antimatroidId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAntimatroids

void removeChildAntimatroids(Id antimatroidId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Removes all children from an antimatroid.

Parameters:

antimatroidId - the Id of an antimatroid

Throws:

NotFoundException - antimatroidId is not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.