Interface FrontOfficeHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface FrontOfficeHierarchySession
extends OsidSession

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

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

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessFrontOfficeHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildFrontOfficeIds(Id frontOfficeId)	Gets the child Ids of the given front office.
FrontOfficeList	getChildFrontOffices(Id frontOfficeId)	Gets the children of the given front office.
Hierarchy	getFrontOfficeHierarchy()	Gets the hierarchy associated with this session.
Id	getFrontOfficeHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getFrontOfficeNodeIds(Id frontOfficeId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given front office.
FrontOfficeNode	getFrontOfficeNodes(Id frontOfficeId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given front office.
IdList	getParentFrontOfficeIds(Id frontOfficeId)	Gets the parent Ids of the given front office.
FrontOfficeList	getParentFrontOffices(Id frontOfficeId)	Gets the parents of the given front office.
IdList	getRootFrontOfficeIds()	Gets the root front office Ids in this hierarchy.
FrontOfficeList	getRootFrontOffices()	Gets the root front office in the front office hierarchy.
boolean	hasChildFrontOffices(Id frontOfficeId)	Tests if a front office has any children.
boolean	hasParentFrontOffices(Id frontOfficeId)	Tests if the FrontOffice has any parents.
boolean	isAncestorOfFrontOffice(Id id, Id frontOfficeId)	Tests if an Id is an ancestor of a front office.
boolean	isChildOfFrontOffice(Id id, Id frontOfficeId)	Tests if a front office is a direct child of another.
boolean	isDescendantOfFrontOffice(Id id, Id frontOfficeId)	Tests if an Id is a descendant of a front office.
boolean	isParentOfFrontOffice(Id id, Id frontOfficeId)	Tests if an Id is a direct parent of front office.
void	useComparativeFrontOfficeView()	The returns from the front office methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryFrontOfficeView()	A complete view of the FrontOffices 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

getFrontOfficeHierarchyId

Id getFrontOfficeHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOfficeHierarchy

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

canAccessFrontOfficeHierarchy

boolean canAccessFrontOfficeHierarchy()

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.

useComparativeFrontOfficeView

void useComparativeFrontOfficeView()

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

usePlenaryFrontOfficeView

void usePlenaryFrontOfficeView()

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

getRootFrontOfficeIds

IdList getRootFrontOfficeIds()
                      throws OperationFailedException,
PermissionDeniedException

Gets the root front office Ids in this hierarchy.

Returns:

the root front office Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootFrontOffices

FrontOfficeList getRootFrontOffices()
                             throws OperationFailedException,
PermissionDeniedException

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

Returns:

the root frontOffices

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentFrontOffices

boolean hasParentFrontOffices(Id frontOfficeId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the FrontOffice has any parents.

Parameters:

frontOfficeId - a front office Id

Returns:

true if the front office has parents, f alse otherwise

Throws:

NotFoundException - frontOfficeId is not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfFrontOffice

boolean isParentOfFrontOffice(Id id,
 Id frontOfficeId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of front office.

Parameters:

id - an Id

frontOfficeId - the Id of a front office

Returns:

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

Throws:

NotFoundException - frontOfficeId is not found

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

getParentFrontOfficeIds

IdList getParentFrontOfficeIds(Id frontOfficeId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given front office.

Parameters:

frontOfficeId - a front office Id

Returns:

the parent Ids of the front office

Throws:

NotFoundException - frontOfficeId is not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentFrontOffices

FrontOfficeList getParentFrontOffices(Id frontOfficeId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given front office.

Parameters:

frontOfficeId - the Id to query

Returns:

the parents of the front office

Throws:

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfFrontOffice

boolean isAncestorOfFrontOffice(Id id,
 Id frontOfficeId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a front office.

Parameters:

id - an Id

frontOfficeId - the Id of a front office

Returns:

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

Throws:

NotFoundException - frontOfficeId not found

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

hasChildFrontOffices

boolean hasChildFrontOffices(Id frontOfficeId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a front office has any children.

Parameters:

frontOfficeId - a front office Id

Returns:

true if the frontOfficeId has children, false otherwise

Throws:

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfFrontOffice

boolean isChildOfFrontOffice(Id id,
 Id frontOfficeId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a front office is a direct child of another.

Parameters:

id - an Id

frontOfficeId - the Id of a front office

Returns:

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

Throws:

NotFoundException - frontOfficeId not found

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

getChildFrontOfficeIds

IdList getChildFrontOfficeIds(Id frontOfficeId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given front office.

Parameters:

frontOfficeId - the Id to query

Returns:

the children of the front office

Throws:

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildFrontOffices

FrontOfficeList getChildFrontOffices(Id frontOfficeId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given front office.

Parameters:

frontOfficeId - the Id to query

Returns:

the children of the front office

Throws:

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfFrontOffice

boolean isDescendantOfFrontOffice(Id id,
 Id frontOfficeId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a front office.

Parameters:

id - an Id

frontOfficeId - the Id of a front office

Returns:

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

Throws:

NotFoundException - frontOfficeId not found

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

getFrontOfficeNodeIds

Node getFrontOfficeNodeIds(Id frontOfficeId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given front office.

Parameters:

frontOfficeId - the Id to query

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

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

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

Returns:

a front office node

Throws:

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficeNodes

FrontOfficeNode getFrontOfficeNodes(Id frontOfficeId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given front office.

Parameters:

frontOfficeId - the Id to query

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

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

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

Returns:

a front office node

Throws:

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.