Interface EndpointHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EndpointHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildEndpoint(Id endpointId, Id childId)	Adds a child to a endpoint.
void	addRootEndpoint(Id endpointId)	Adds a root endpoint.
boolean	canModifyEndpointHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getEndpointHierarchy()	Gets the hierarchy associated with this session.
Id	getEndpointHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildEndpoint(Id endpointId, Id childId)	Removes a child from a endpoint.
void	removeChildEndpoints(Id endpointId)	Removes all children from a endpoint.
void	removeRootEndpoint(Id endpointId)	Removes a root endpoint.

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

getEndpointHierarchyId

Id getEndpointHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEndpointHierarchy

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

canModifyEndpointHierarchy

boolean canModifyEndpointHierarchy()

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.

addRootEndpoint

void addRootEndpoint(Id endpointId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root endpoint.

Parameters:

endpointId - the Id of a endpoint

Throws:

AlreadyExistsException - endpointId is already in hierarchy

NotFoundException - endpointId not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootEndpoint

void removeRootEndpoint(Id endpointId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root endpoint.

Parameters:

endpointId - the Id of a endpoint

Throws:

NotFoundException - endpointId not a root

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildEndpoint

void addChildEndpoint(Id endpointId,
 Id childId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a endpoint.

Parameters:

endpointId - the Id of a endpoint

childId - the Id of the new child

Throws:

AlreadyExistsException - endpointId is already a parent of childId

NotFoundException - endpointId or childId not found

NullArgumentException - endpointId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildEndpoint

void removeChildEndpoint(Id endpointId,
 Id childId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a endpoint.

Parameters:

endpointId - the Id of a endpoint

childId - the Id of the new child

Throws:

NotFoundException - endpointId not a parent of childId

NullArgumentException - endpointId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildEndpoints

void removeChildEndpoints(Id endpointId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a endpoint.

Parameters:

endpointId - the Id of a endpoint

Throws:

NotFoundException - endpointId not in hierarchy

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.