Interface RepositoryHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RepositoryHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildRepository(Id repositoryId, Id childId)	Adds a child to a repository.
void	addRootRepository(Id repositoryId)	Adds a root repository.
boolean	canModifyRepositoryHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getRepositoryHierarchy()	Gets the hierarchy associated with this session.
Id	getRepositoryHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildRepositories(Id repositoryId)	Removes all children from a repository.
void	removeChildRepository(Id repositoryId, Id childId)	Removes a child from a repository.
void	removeRootRepository(Id repositoryId)	Removes a root repository.

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

getRepositoryHierarchyId

Id getRepositoryHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepositoryHierarchy

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

canModifyRepositoryHierarchy

boolean canModifyRepositoryHierarchy()

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.

addRootRepository

void addRootRepository(Id repositoryId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root repository.

Parameters:

repositoryId - the Id of a repository

Throws:

AlreadyExistsException - repositoryId is already in hierarchy

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootRepository

void removeRootRepository(Id repositoryId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root repository.

Parameters:

repositoryId - the Id of a repository

Throws:

NotFoundException - repositoryId not a root

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildRepository

void addChildRepository(Id repositoryId,
 Id childId)
                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a repository.

Parameters:

repositoryId - the Id of a repository

childId - the Id of the new child

Throws:

AlreadyExistsException - repositoryId is already a parent of childId

NotFoundException - repositoryId or childId not found

NullArgumentException - repositoryId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildRepository

void removeChildRepository(Id repositoryId,
 Id childId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a repository.

Parameters:

repositoryId - the Id of a repository

childId - the Id of the new child

Throws:

NotFoundException - repositoryId not a parent of childId

NullArgumentException - repositoryId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildRepositories

void removeChildRepositories(Id repositoryId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a repository.

Parameters:

repositoryId - the Id of a repository

Throws:

NotFoundException - repositoryId not in hierarchy

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.