Interface RealmHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RealmHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildRealm(Id realmId, Id childId)	Adds a child to a realm.
void	addRootRealm(Id realmId)	Adds a root realm.
boolean	canModifyRealmHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getRealmHierarchy()	Gets the hierarchy associated with this session.
Id	getRealmHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildRealm(Id realmId, Id childId)	Removes a child from a realm.
void	removeChildRealms(Id realmId)	Removes all children from a realm.
void	removeRootRealm(Id realmId)	Removes a root realm.

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

getRealmHierarchyId

Id getRealmHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRealmHierarchy

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

canModifyRealmHierarchy

boolean canModifyRealmHierarchy()

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.

addRootRealm

void addRootRealm(Id realmId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root realm.

Parameters:

realmId - the Id of a realm

Throws:

AlreadyExistsException - realmId is already in hierarchy

NotFoundException - realmId is not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootRealm

void removeRootRealm(Id realmId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root realm.

Parameters:

realmId - the Id of a realm

Throws:

NotFoundException - realmId is not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildRealm

void addChildRealm(Id realmId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a realm.

Parameters:

realmId - the Id of a realm

childId - the Id of the new child

Throws:

AlreadyExistsException - realmId is already a parent of childId

NotFoundException - realmId or childId not found

NullArgumentException - realmId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildRealm

void removeChildRealm(Id realmId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a realm.

Parameters:

realmId - the Id of a realm

childId - the Id of the new child

Throws:

NotFoundException - realmId not a parent of childId

NullArgumentException - realmId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildRealms

void removeChildRealms(Id realmId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a realm.

Parameters:

realmId - the Id of a realm

Throws:

NotFoundException - realmId is not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.