OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.RepositoryHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetRepositoryHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyRepositoryHierarchy
Description

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.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootRepository
Description

Adds a root repository.

Parametersosid.id.IdrepositoryIdthe Id of a repository
ErrorsALREADY_EXISTS repositoryId is already in hierarchy
NOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootRepository
Description

Removes a root repository.

Parametersosid.id.IdrepositoryIdthe Id of a repository
ErrorsNOT_FOUND repositoryId not a root
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildRepository
Description

Adds a child to a repository.

Parametersosid.id.IdrepositoryIdthe Id of a repository
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS repositoryId is already a parent of childId
NOT_FOUND repositoryId or childId not found
NULL_ARGUMENT repositoryId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildRepository
Description

Removes a child from a repository.

Parametersosid.id.IdrepositoryIdthe Id of a repository
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND repositoryId not a parent of childId
NULL_ARGUMENT repositoryId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildRepositories
Description

Removes all children from a repository.

Parametersosid.id.IdrepositoryIdthe Id of a repository
ErrorsNOT_FOUND repositoryId not in hierarchy
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.