Interface ProfileHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProfileHierarchySession
extends OsidSession

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

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 getParentProfiles() or getChildProfiles() 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 view: profile elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessProfileHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildProfileIds(Id profileId)	Gets the child Ids of the given profile.
ProfileList	getChildProfiles(Id profileId)	Gets the children of the given profile.
IdList	getParentProfileIds(Id profileId)	Gets the parent Ids of the given profile.
ProfileList	getParentProfiles(Id profileId)	Gets the parents of the given profile.
Hierarchy	getProfileHierarchy()	Gets the hierarchy associated with this session.
Id	getProfileHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getProfileNodeIds(Id profileId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given profile.
ProfileNode	getProfileNodes(Id profileId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given profile.
IdList	getRootProfileIds()	Gets the root profile Ids in this hierarchy.
ProfileList	getRootProfiles()	Gets the root profiles in this profile hierarchy.
boolean	hasChildProfiles(Id profileId)	Tests if a profile has any children.
boolean	hasParentProfiles(Id profileId)	Tests if the Profile has any parents.
boolean	isAncestorOfProfile(Id id, Id profileId)	Tests if an Id is an ancestor of a profile.
boolean	isChildOfProfile(Id id, Id profileId)	Tests if a profile is a direct child of another.
boolean	isDescendantOfProfile(Id id, Id profileId)	Tests if an Id is a descendant of a profile.
boolean	isParentOfProfile(Id id, Id profileId)	Tests if an Id is a direct parent of a profile.
void	useComparativeProfileView()	The returns from the profile methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryProfileView()	A complete view of the Hierarchy 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

getProfileHierarchyId

Id getProfileHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getProfileHierarchy

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

canAccessProfileHierarchy

boolean canAccessProfileHierarchy()

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.

useComparativeProfileView

void useComparativeProfileView()

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

usePlenaryProfileView

void usePlenaryProfileView()

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

getRootProfileIds

IdList getRootProfileIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root profile Ids in this hierarchy.

Returns:

the root profile Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootProfiles

ProfileList getRootProfiles()
                     throws OperationFailedException,
PermissionDeniedException

Gets the root profiles in this profile hierarchy.

Returns:

the root profiles

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentProfiles

boolean hasParentProfiles(Id profileId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Profile has any parents.

Parameters:

profileId - a profile Id

Returns:

true if the profile has parents, false otherwise

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfProfile

boolean isParentOfProfile(Id id,
 Id profileId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a profile.

Parameters:

id - an Id

profileId - the Id of a profile

Returns:

true if this id is a parent of profileId , false otherwise

Throws:

NotFoundException - profileId is not found

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

getParentProfileIds

IdList getParentProfileIds(Id profileId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given profile.

Parameters:

profileId - a profile Id

Returns:

the parent Ids of the profile

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentProfiles

ProfileList getParentProfiles(Id profileId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given profile.

Parameters:

profileId - a profile Id

Returns:

the parents of the profile

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfProfile

boolean isAncestorOfProfile(Id id,
 Id profileId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a profile.

Parameters:

id - an Id

profileId - the Id of a profile

Returns:

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

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId 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} .

hasChildProfiles

boolean hasChildProfiles(Id profileId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a profile has any children.

Parameters:

profileId - a profileId

Returns:

true if the profileId has children, false otherwise

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfProfile

boolean isChildOfProfile(Id id,
 Id profileId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a profile is a direct child of another.

Parameters:

id - an Id

profileId - the Id of a profile

Returns:

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

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId 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} .

getChildProfileIds

IdList getChildProfileIds(Id profileId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given profile.

Parameters:

profileId - the Id to query

Returns:

the children of the profile

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildProfiles

ProfileList getChildProfiles(Id profileId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given profile.

Parameters:

profileId - the Id to query

Returns:

the children of the profile

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfProfile

boolean isDescendantOfProfile(Id id,
 Id profileId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a profile.

Parameters:

id - an Id

profileId - the Id of a profile

Returns:

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

Throws:

NotFoundException - profileId not found

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

getProfileNodeIds

Node getProfileNodeIds(Id profileId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given profile.

Parameters:

profileId - the Id to query

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

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

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

Returns:

a profile node

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileNodes

ProfileNode getProfileNodes(Id profileId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given profile.

Parameters:

profileId - the Id to query

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

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

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

Returns:

a profile node

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.