Interface FamilyHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface FamilyHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of families may be organized into a hierarchy for organizing or federating. A parent Family includes all of the relationships of its children such that a single root node contains all of the relationships of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildFamily(Id familyId, Id childId)	Adds a child to a family.
void	addRootFamily(Id familyId)	Adds a root family.
boolean	canModifyFamilyHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getFamilyHierarchy()	Gets the hierarchy associated with this session.
Id	getFamilyHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildFamilies(Id familyId)	Removes all children from a family.
void	removeChildFamily(Id familyId, Id childId)	Removes a child from a family.
void	removeRootFamily(Id familyId)	Removes a root family.

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

getFamilyHierarchyId

Id getFamilyHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFamilyHierarchy

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

canModifyFamilyHierarchy

boolean canModifyFamilyHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootFamily

void addRootFamily(Id familyId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root family.

Parameters:

familyId - the Id of a family

Throws:

AlreadyExistsException - familyId is already in hierarchy

NotFoundException - familyId not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootFamily

void removeRootFamily(Id familyId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root family.

Parameters:

familyId - the Id of a family

Throws:

NotFoundException - familyId not a root

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildFamily

void addChildFamily(Id familyId,
 Id childId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a family.

Parameters:

familyId - the Id of a family

childId - the Id of the new child

Throws:

AlreadyExistsException - familyId is already a parent of childId

NotFoundException - familyId or childId not found

NullArgumentException - familyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildFamily

void removeChildFamily(Id familyId,
 Id childId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a family.

Parameters:

familyId - the Id of a family

childId - the Id of the new child

Throws:

NotFoundException - familyId not a parent of childId

NullArgumentException - familyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildFamilies

void removeChildFamilies(Id familyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a family.

Parameters:

familyId - the Id of a family

Throws:

NotFoundException - familyId not in hierarchy

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.