Interface ProfileHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProfileHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildProfile(Id profileId, Id childId)	Adds a child to a profile.
void	addRootProfile(Id profileId)	Adds a root profile.
boolean	canModifyProfileHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getProfileHierarchy()	Gets the hierarchy associated with this session.
Id	getProfileHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildProfile(Id profileId, Id childId)	Removes a child from a profile.
void	removeChildProfiles(Id profileId)	Removes all children from a profile.
void	removeRootProfile(Id profileId)	Removes a root profile.

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.

canModifyProfileHierarchy

boolean canModifyProfileHierarchy()

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.

addRootProfile

void addRootProfile(Id profileId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root profile.

Parameters:

profileId - the Id of a profile

Throws:

AlreadyExistsException - profileId is already in hierarchy

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootProfile

void removeRootProfile(Id profileId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root profile.

Parameters:

profileId - the Id of a profile

Throws:

NotFoundException - profileId not a root

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildProfile

void addChildProfile(Id profileId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a profile.

Parameters:

profileId - the Id of a profile

childId - the Id of the new child

Throws:

AlreadyExistsException - profileId is already a parent of childId

NotFoundException - profileId or childId not found

NullArgumentException - profileId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildProfile

void removeChildProfile(Id profileId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a profile.

Parameters:

profileId - the Id of a profile

childId - the Id of the new child

Throws:

NotFoundException - profileId not a parent of childId

NullArgumentException - profileId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildProfiles

void removeChildProfiles(Id profileId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a profile.

Parameters:

profileId - the Id of a profile

Throws:

NotFoundException - profileId not in hierarchy

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.