Interface ActivityHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActivityHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Activities . Each node in the hierarchy is a unique Activity .

Method Summary

Modifier and Type	Method	Description
void	addChildActivity(Id activityId, Id childId)	Adds a child to an activity.
void	addRootActivity(Id activityId)	Adds a root activity.
boolean	canModifyActivityHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getActivityHierarchy()	Gets the hierarchy associated with this session.
Id	getActivityHierarchyId()	Gets the hierarchy Id associated with this session.
void	reassignActivityToBusiness(Id activityId, Id fromBusinessId, Id toBusinessId)	Moves an Activity from one Business to another.
void	removeChildActivities(Id activityId)	Removes all children from an activity.
void	removeChildActivity(Id activityId, Id childId)	Removes a child from an activity.
void	removeRootActivity(Id activityId)	Removes a root activity.

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

getActivityHierarchyId

Id getActivityHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getActivityHierarchy

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

canModifyActivityHierarchy

boolean canModifyActivityHierarchy()

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.

addRootActivity

void addRootActivity(Id activityId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root activity.

Parameters:

activityId - the Id of an activity

Throws:

AlreadyExistsException - activityId is already in hierarchy

NotFoundException - activityId not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootActivity

void removeRootActivity(Id activityId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root activity.

Parameters:

activityId - the Id of an activity

Throws:

NotFoundException - activityId not found

NullArgumentException - activityId is null

OperationFailedException - the root activities

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildActivity

void addChildActivity(Id activityId,
 Id childId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an activity.

Parameters:

activityId - the Id of an activity

childId - the Id of the new child

Throws:

AlreadyExistsException - activityId is already a parent of childId

NotFoundException - activityId or childId not found

NullArgumentException - activityId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildActivity

void removeChildActivity(Id activityId,
 Id childId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an activity.

Parameters:

activityId - the Id of an activity

childId - the Id of the new child

Throws:

NotFoundException - activityId not a parent of childId

NullArgumentException - activityId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildActivities

void removeChildActivities(Id activityId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an activity.

Parameters:

activityId - the Id of an activity

Throws:

NotFoundException - activityId not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignActivityToBusiness

void reassignActivityToBusiness(Id activityId,
 Id fromBusinessId,
 Id toBusinessId)
                         throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an Activity from one Business to another. Mappings to other Businesses are unaffected.

Parameters:

activityId - the Id of the Activity

fromBusinessId - the Id of the current Business

toBusinessId - the Id of the destination Business

Throws:

AlreadyExistsException - activityId already assigned to toB usinessId

NotFoundException - activityId, fromBusinessId , or toBusinessId not found or activityId not mapped to fromBusinessId

NullArgumentException - activityId, fromBusinessId , or toBusinessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.