Interface AntimatroidHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AntimatroidHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Antimatroid objects. Each node in the hierarchy is a unique Antimatroid . The hierarchy may be traversed recursively to establish the tree structure through getParentAntimatroids() and getChildAntimatroids() . To relate these Ids to another OSID, getAntimatroidNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Antimatroid available in the Sequencing OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root antimatroid or a child of another antimatroid.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentAntimatroids() or getChildAntimatroids() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized featureways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative antimatroid view: antimatroid elements may be silently omitted or re-ordered
• plenary antimatroid view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessAntimatroidHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getAntimatroidHierarchy()	Gets the hierarchy associated with this session.
Id	getAntimatroidHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getAntimatroidNodeIds(Id antimatroidId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given antimatroid.
AntimatroidNode	getAntimatroidNodes(Id antimatroidId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given antimatroid.
IdList	getChildAntimatroidIds(Id antimatroidId)	Gets the child Ids of the given antimatroid.
AntimatroidList	getChildAntimatroids(Id antimatroidId)	Gets the children of the given antimatroid.
IdList	getParentAntimatroidIds(Id antimatroidId)	Gets the parent Ids of the given antimatroid.
AntimatroidList	getParentAntimatroids(Id antimatroidId)	Gets the parents of the given antimatroid.
IdList	getRootAntimatroidIds()	Gets the root antimatroid Ids in this hierarchy.
AntimatroidList	getRootAntimatroids()	Gets the root antimatroid in the antimatroid hierarchy.
boolean	hasChildAntimatroids(Id antimatroidId)	Tests if an antimatroid has any children.
boolean	hasParentAntimatroids(Id antimatroidId)	Tests if the Antimatroid has any parents.
boolean	isAncestorOfAntimatroid(Id id, Id antimatroidId)	Tests if an Id is an ancestor of an antimatroid.
boolean	isChildOfAntimatroid(Id id, Id antimatroidId)	Tests if an antimatroid is a direct child of another.
boolean	isDescendantOfAntimatroid(Id id, Id antimatroidId)	Tests if an Id is a descendant of an antimatroid.
boolean	isParentOfAntimatroid(Id id, Id antimatroidId)	Tests if an Id is a direct parent of antimatroid.
void	useComparativeAntimatroidView()	The returns from the antimatroid methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryAntimatroidView()	A complete view of the Antimatroids returns is desired.

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.

canAccessAntimatroidHierarchy

boolean canAccessAntimatroidHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAntimatroidView

void useComparativeAntimatroidView()

The returns from the antimatroid methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryAntimatroidView

void usePlenaryAntimatroidView()

A complete view of the Antimatroids returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootAntimatroidIds

IdList getRootAntimatroidIds()
                      throws OperationFailedException,
PermissionDeniedException

Gets the root antimatroid Ids in this hierarchy.

Returns:

the root antimatroid Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootAntimatroids

AntimatroidList getRootAntimatroids()
                             throws OperationFailedException,
PermissionDeniedException

Gets the root antimatroid in the antimatroid hierarchy. an antimatroid with no parents is an orphan. While all antimatroid Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root antimatroid or child of another antimatroid.

Returns:

the root antimatroids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentAntimatroids

boolean hasParentAntimatroids(Id antimatroidId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Antimatroid has any parents.

Parameters:

antimatroidId - an antimatroid Id

Returns:

true if the antimatroid has parents, f alse otherwise

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.

isParentOfAntimatroid

boolean isParentOfAntimatroid(Id id,
 Id antimatroidId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of antimatroid.

Parameters:

id - an Id

antimatroidId - the Id of an antimatroid

Returns:

true if this id is a parent of antimatroidId , f alse otherwise

Throws:

NotFoundException - antimatroidId is not found

NullArgumentException - id or antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentAntimatroidIds

IdList getParentAntimatroidIds(Id antimatroidId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given antimatroid.

Parameters:

antimatroidId - an antimatroid Id

Returns:

the parent Ids of the 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.

getParentAntimatroids

AntimatroidList getParentAntimatroids(Id antimatroidId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given antimatroid.

Parameters:

antimatroidId - the Id to query

Returns:

the parents of the antimatroid

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfAntimatroid

boolean isAncestorOfAntimatroid(Id id,
 Id antimatroidId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an antimatroid.

Parameters:

id - an Id

antimatroidId - the Id of an antimatroid

Returns:

true if this id is an ancestor of antimatroidId , false otherwise

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildAntimatroids

boolean hasChildAntimatroids(Id antimatroidId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an antimatroid has any children.

Parameters:

antimatroidId - an antimatroid Id

Returns:

true if the antimatroidId has children, false otherwise

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfAntimatroid

boolean isChildOfAntimatroid(Id id,
 Id antimatroidId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an antimatroid is a direct child of another.

Parameters:

id - an Id

antimatroidId - the Id of an antimatroid

Returns:

true if the id is a child of antimatroidId , false otherwise

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - id or antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildAntimatroidIds

IdList getChildAntimatroidIds(Id antimatroidId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given antimatroid.

Parameters:

antimatroidId - the Id to query

Returns:

the children of the antimatroid

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildAntimatroids

AntimatroidList getChildAntimatroids(Id antimatroidId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given antimatroid.

Parameters:

antimatroidId - the Id to query

Returns:

the children of the antimatroid

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfAntimatroid

boolean isDescendantOfAntimatroid(Id id,
 Id antimatroidId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an antimatroid.

Parameters:

id - an Id

antimatroidId - the Id of an antimatroid

Returns:

true if the id is a descendant of the antimatroidId , false otherwise

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - id or antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getAntimatroidNodeIds

Node getAntimatroidNodeIds(Id antimatroidId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given antimatroid.

Parameters:

antimatroidId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the antimatroid.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the antimatroid.

includeSiblings - true to include the siblings of the given antimatroid, false to omit the siblings

Returns:

an antimatroid node

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAntimatroidNodes

AntimatroidNode getAntimatroidNodes(Id antimatroidId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given antimatroid.

Parameters:

antimatroidId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the hierarchy.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the hierarchy.

includeSiblings - true to include the siblings of the given antimatroid, false to omit the siblings

Returns:

an antimatroid node

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.