Interface LocationHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LocationHierarchySession
extends OsidSession

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

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 getParentMLocations() or getChildLocations() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessLocationHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildLocationIds(Id locationId)	Gets the child Ids of the given location.
LocationList	getChildLocations(Id locationId)	Gets the children of the given location.
Hierarchy	getLocationHierarchy()	Gets the hierarchy associated with this session.
Id	getLocationHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getLocationNodeIds(Id locationId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given location.
LocationNode	getLocationNodes(Id locationId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given location.
IdList	getParentLocationIds(Id locationId)	Gets the parent Ids of the given location.
LocationList	getParentLocations(Id locationId)	Gets the parents of the given location.
IdList	getRootLocationIds()	Gets the root location Ids in this hierarchy.
LocationList	getRootLocations()	Gets the root location in the location hierarchy.
boolean	hasChildLocations(Id locationId)	Tests if a location has any children.
boolean	hasParentLocations(Id locationId)	Tests if the Location has any parents.
boolean	isAncestorOfLocation(Id id, Id locationId)	Tests if an Id is an ancestor of a location.
boolean	isChildOfLocation(Id id, Id locationId)	Tests if a location is a direct child of another.
boolean	isDescendantOfLocation(Id id, Id locationId)	Tests if an Id is a descendant of a location.
boolean	isParentOfLocation(Id id, Id locationId)	Tests if an Id is a direct parent of location.
void	useComparativeLocationView()	The returns from the location methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryLocationView()	A complete view of the Locations 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

getLocationHierarchyId

Id getLocationHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getLocationHierarchy

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

canAccessLocationHierarchy

boolean canAccessLocationHierarchy()

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.

useComparativeLocationView

void useComparativeLocationView()

The returns from the location 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.

usePlenaryLocationView

void usePlenaryLocationView()

A complete view of the Locations 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.

getRootLocationIds

IdList getRootLocationIds()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root location Ids in this hierarchy.

Returns:

the root location Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootLocations

LocationList getRootLocations()
                       throws OperationFailedException,
PermissionDeniedException

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

Returns:

the root locations

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentLocations

boolean hasParentLocations(Id locationId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Location has any parents.

Parameters:

locationId - a location Id

Returns:

true if the location has parents, f alse otherwise

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfLocation

boolean isParentOfLocation(Id id,
 Id locationId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of location.

Parameters:

id - an Id

locationId - the Id of a location

Returns:

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

Throws:

NotFoundException - locationId is not found

NullArgumentException - id or locationId 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} .

getParentLocationIds

IdList getParentLocationIds(Id locationId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given location.

Parameters:

locationId - a location Id

Returns:

the parent Ids of the location

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentLocations

LocationList getParentLocations(Id locationId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given location.

Parameters:

locationId - a location Id

Returns:

the parents of the location

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfLocation

boolean isAncestorOfLocation(Id id,
 Id locationId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a location.

Parameters:

id - an Id

locationId - the Id of a location

Returns:

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

Throws:

NotFoundException - locationId is not found

NullArgumentException - id or locationId 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} .

hasChildLocations

boolean hasChildLocations(Id locationId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a location has any children.

Parameters:

locationId - a location Id

Returns:

true if the locationId has children, false otherwise

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfLocation

boolean isChildOfLocation(Id id,
 Id locationId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a location is a direct child of another.

Parameters:

id - an Id

locationId - a location Id

Returns:

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

Throws:

NotFoundException - locationId is not found

NullArgumentException - id or locationId 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} .

getChildLocationIds

IdList getChildLocationIds(Id locationId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given location.

Parameters:

locationId - a location Id

Returns:

the children of the location

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildLocations

LocationList getChildLocations(Id locationId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given location.

Parameters:

locationId - a location Id

Returns:

the children of the location

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfLocation

boolean isDescendantOfLocation(Id id,
 Id locationId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a location.

Parameters:

id - an Id

locationId - the Id of a location

Returns:

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

Throws:

NotFoundException - locationId not found

NullArgumentException - id or locationId 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} .

getLocationNodeIds

Node getLocationNodeIds(Id locationId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given location.

Parameters:

locationId - the Id to query

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

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

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

Returns:

a location node

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLocationNodes

LocationNode getLocationNodes(Id locationId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given location.

Parameters:

locationId - the Id to query

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

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

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

Returns:

a location node

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.