Interface OfficeHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OfficeHierarchySession
extends OsidSession

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

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

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessOfficeHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildOfficeIds(Id officeId)	Gets the child Ids of the given office.
OfficeList	getChildOffices(Id officeId)	Gets the children of the given office.
Hierarchy	getOfficeHierarchy()	Gets the hierarchy associated with this session.
Id	getOfficeHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getOfficeNodeIds(Id officeId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given office.
OfficeNode	getOfficeNodes(Id officeId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given office.
IdList	getParentOfficeIds(Id officeId)	Gets the parent Ids of the given office.
OfficeList	getParentOffices(Id officeId)	Gets the parents of the given office.
IdList	getRootOfficeIds()	Gets the root office Ids in this hierarchy.
OfficeList	getRootOffices()	Gets the root office in the office hierarchy.
boolean	hasChildOffices(Id officeId)	Tests if an office has any children.
boolean	hasParentOffices(Id officeId)	Tests if the Office has any parents.
boolean	isAncestorOfOffice(Id id, Id officeId)	Tests if an Id is an ancestor of an office.
boolean	isChildOfOffice(Id id, Id officeId)	Tests if an office is a direct child of another.
boolean	isDescendantOfOffice(Id id, Id officeId)	Tests if an Id is a descendant of an office.
boolean	isParentOfOffice(Id id, Id officeId)	Tests if an Id is a direct parent of office.
void	useComparativeOfficeView()	The returns from the office methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryOfficeView()	A complete view of the Offices 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

getOfficeHierarchyId

Id getOfficeHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOfficeHierarchy

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

canAccessOfficeHierarchy

boolean canAccessOfficeHierarchy()

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.

useComparativeOfficeView

void useComparativeOfficeView()

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

usePlenaryOfficeView

void usePlenaryOfficeView()

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

getRootOfficeIds

IdList getRootOfficeIds()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root office Ids in this hierarchy.

Returns:

the root office Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootOffices

OfficeList getRootOffices()
                   throws OperationFailedException,
PermissionDeniedException

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

Returns:

the root offices

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentOffices

boolean hasParentOffices(Id officeId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Office has any parents.

Parameters:

officeId - an office Id

Returns:

true if the office has parents, f alse otherwise

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfOffice

boolean isParentOfOffice(Id id,
 Id officeId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of office.

Parameters:

id - an Id

officeId - the Id of an office

Returns:

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

Throws:

NotFoundException - officeId is not found

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

getParentOfficeIds

IdList getParentOfficeIds(Id officeId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given office.

Parameters:

officeId - an office Id

Returns:

the parent Ids of the office

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentOffices

OfficeList getParentOffices(Id officeId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given office.

Parameters:

officeId - the Id to query

Returns:

the parents of the office

Throws:

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfOffice

boolean isAncestorOfOffice(Id id,
 Id officeId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an office.

Parameters:

id - an Id

officeId - the Id of an office

Returns:

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

Throws:

NotFoundException - officeId not found

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

hasChildOffices

boolean hasChildOffices(Id officeId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an office has any children.

Parameters:

officeId - an office Id

Returns:

true if the officeId has children, false otherwise

Throws:

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfOffice

boolean isChildOfOffice(Id id,
 Id officeId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an office is a direct child of another.

Parameters:

id - an Id

officeId - the Id of an office

Returns:

true if the Id is a child of officeId , false otherwise

Throws:

NotFoundException - officeId not found

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

getChildOfficeIds

IdList getChildOfficeIds(Id officeId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given office.

Parameters:

officeId - the Id to query

Returns:

the children of the office

Throws:

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildOffices

OfficeList getChildOffices(Id officeId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given office.

Parameters:

officeId - the Id to query

Returns:

the children of the office

Throws:

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfOffice

boolean isDescendantOfOffice(Id id,
 Id officeId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an office.

Parameters:

id - an Id

officeId - the Id of an office

Returns:

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

Throws:

NotFoundException - officeId not found

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

getOfficeNodeIds

Node getOfficeNodeIds(Id officeId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given office.

Parameters:

officeId - the Id to query

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

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

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

Returns:

an office node

Throws:

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeNodes

OfficeNode getOfficeNodes(Id officeId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given office.

Parameters:

officeId - the Id to query

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

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

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

Returns:

an office node

Throws:

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.