Interface AntimatroidHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 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

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.