OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.RepositoryManager
Implementsosid.OsidManager
osid.repository.RepositoryProfile
Description

The repository manager provides access to asset lookup and creation session and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • AssetLookupSession: a session to retrieve assets
  • AssetQuerySession: a session to query assets
  • AssetSearchSession: a session to search for assets
  • AssetAdminSession: a session to create and delete assets
  • AssetNotificationSession: a session to receive notifications pertaining to asset changes
  • AssetRepositorySession: a session to look up asset to repository mappings
  • AssetRepositoryAssignmentSession: a session to manage asset to repository mappings
  • AssetSmartRepositorySession: a session to manage dynamic repositories of assets
  • AssetTemporalSession: a session to access the temporal coverage of an asset
  • AssetTemporalAssignmentSession: a session to manage the temporal coverage of an asset
  • AssetSpatialSession: a session to access the spatial coverage of an asset
  • AssetSpatialAssignmentSession: a session to manage the spatial coverage of an asset
  • AssetCompositionSession: a session to look up asset composition mappings
  • AssetCompositionDesignSession: a session to map assets to compositions
  • CompositionLookupSession: a session to retrieve compositions
  • CompositionQuerySession: a session to query compositions
  • CompositionSearchSession: a session to search for compositions
  • CompositionAdminSession: a session to create, update and delete compositions
  • CompositionNotificationSession: a session to receive notifications pertaining to changes in compositions
  • CompositionRepositorySession: a session to retrieve composition repository mappings
  • CompositionRepositoryAssignmentSession: a session to manage composition repository mappings
  • CompositionSmartRepositorySession: a session to manage dynamic repositories of compositions
  • RepositoryLookupSession: a session to retrieve repositories
  • RepositoryQuerySession: a session to query repositories
  • RepositorySearchSession: a session to search for repositories
  • RepositoryAdminSession: a session to create, update and delete repositories
  • RepositoryNotificationSession: a session to receive notifications pertaining to changes in repositories
  • RepositoryHierarchySession: a session to traverse repository hierarchies
  • RepositoryHierarchyDesignSession: a session to manage repository hierarchies
MethodgetAssetLookupSession
Description

Gets the OsidSession associated with the asset lookup service.

Returnosid.repository.AssetLookupSessionthe new AssetLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetLookup() is false
ComplianceoptionalThis method must be implemented if supportsAssetLookup() is true.
MethodgetAssetLookupSessionForRepository
Description

Gets the OsidSession associated with the asset lookup service for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetLookupSessionthe new AssetLookupSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAssetLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetLookup() and supportsVisibleFederation() are true.
MethodgetAssetQuerySession
Description

Gets an asset query session.

Returnosid.repository.AssetQuerySessionan AssetQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssetQuery() is true.
MethodgetAssetQuerySessionForRepository
Description

Gets an asset query session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetQuerySessionan AssetQuerySession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAssetQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetQuery() and supportsVisibleFederation() are true.
MethodgetAssetSearchSession
Description

Gets an asset search session.

Returnosid.repository.AssetSearchSessionan AssetSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetSearch() is false
ComplianceoptionalThis method must be implemented if supportsAssetSearch() is true.
MethodgetAssetSearchSessionForRepository
Description

Gets an asset search session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetSearchSessionan AssetSearchSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAssetSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetSearch() and supportsVisibleFederation() are true.
MethodgetAssetAdminSession
Description

Gets an asset administration session for creating, updating and deleting assets.

Returnosid.repository.AssetAdminSessionan AssetAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAssetAdmin() is true.
MethodgetAssetAdminSessionForRepository
Description

Gets an asset administration session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetAdminSessionan AssetAdminSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetAdmin() and supportsVisibleFederation() are true.
MethodgetAssetNotificationSession
Description

Gets the notification session for notifications pertaining to asset changes.

Parametersosid.repository.AssetReceiverassetReceiverthe notification callback
Returnosid.repository.AssetNotificationSessionan AssetNotificationSession
ErrorsNULL_ARGUMENT assetReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetNotification() is false
ComplianceoptionalThis method must be implemented if supportsAssetNotification() is true.
MethodgetAssetNotificationSessionForRepository
Description

Gets the asset notification session for the given repository.

Parametersosid.repository.AssetReceiverassetReceiverthe notification callback
osid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetNotificationSessionan AssetNotificationSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT assetReceiver or repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAssetNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetNotfication() and supportsVisibleFederation() are true.
MethodgetAssetRepositorySession
Description

Gets the session for retrieving asset to repository mappings.

Returnosid.repository.AssetRepositorySessionan AssetRepositorySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetRepository() is false
ComplianceoptionalThis method must be implemented if supportsAssetRepository() is true.
MethodgetAssetRepositoryAssignmentSession
Description

Gets the session for assigning asset to repository mappings.

Returnosid.repository.AssetRepositoryAssignmentSessionan AssetRepositoryAsignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetRepositoryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAssetRepositoryAssignment() is true.
MethodgetAssetSmartRepositorySession
Description

Gets an asset smart repository session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetSmartRepositorySessionan AssetSmartRepositorySession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAssetSmartRepository() false
ComplianceoptionalThis method must be implemented if supportsAssetSmartRepository() is true.
MethodgetAssetTemporalSession
Description

Gets the session for retrieving temporal coverage of an asset.

Returnosid.repository.AssetTemporalSessionan AssetTemporalSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetTemporal() is false
ComplianceoptionalThis method must be implemented if supportsAssetTemporal() is true.
MethodgetAssetTemporalSessionForRepository
Description

Gets the session for retrieving temporal coverage of an asset for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetTemporalSessionan AssetTemporalSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetTemporal() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetTemporal() and supportsVisibleFederation() are true.
MethodgetAssetTemporalAssignmentSession
Description

Gets the session for assigning temporal coverage to an asset.

Returnosid.repository.AssetTemporalAssignmentSessionan AssetTemporalAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetTemporalAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAssetTemporalAssignment() is true.
MethodgetAssetTemporalAssignmentSessionForRepository
Description

Gets the session for assigning temporal coverage of an asset for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetTemporalAssignmentSessionan AssetTemporalAssignmentSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetTemporalAssignment() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetTemporalAssignment() and supportsVisibleFederation() are true.
MethodgetAssetSpatialSession
Description

Gets the session for retrieving spatial coverage of an asset.

Returnosid.repository.AssetSpatialSessionan AssetSpatialSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpatialAssets() is false
ComplianceoptionalThis method must be implemented if supportsSpatialAssets() is true.
MethodgetAssetSpatialSessionForRepository
Description

Gets the session for retrieving spatial coverage of an asset for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetSpatialSessionan AssetSpatialSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetSpatial() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetSpatial() and supportsVisibleFederation() are true.
MethodgetAssetSpatialAssignmentSession
Description

Gets the session for assigning spatial coverage to an asset.

Returnosid.repository.AssetSpatialAssignmentSessionan AssetSpatialAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetSpatialAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAssetSpatialAssignment() is true.
MethodgetAssetSpatialAssignmentSessionForRepository
Description

Gets the session for assigning spatial coverage of an asset for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.AssetSpatialAssignmentSessionan AssetSpatialAssignmentSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetSpatialAssignment() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAssetSpatialAssignment() and supportsVisibleFederation() are true.
MethodgetAssetCompositionSession
Description

Gets the session for retrieving asset compositions.

Returnosid.repository.AssetCompositionSessionan AssetCompositionSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetComposition() is false
ComplianceoptionalThis method must be implemented if supportsAssetComposition() is true.
MethodgetAssetCompositionDesignSession
Description

Gets the session for creating asset compositions.

Returnosid.repository.AssetCompositionDesignSessionan AssetCompositionDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAssetCompositionDesign() is false
ComplianceoptionalThis method must be implemented if supportsAssetCompositionDesign() is true.
MethodgetCompositionLookupSession
Description

Gets the OsidSession associated with the composition lookup service.

Returnosid.repository.CompositionLookupSessionthe new CompositionLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionLookup() is false
ComplianceoptionalThis method must be implemented if supportsCompositionLookup() is true.
MethodgetCompositionLookupSessionForRepository
Description

Gets the OsidSession associated with the composition lookup service for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.CompositionLookupSessionthe new CompositionLookupSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompositionLookup() and supportsVisibleFederation() are true.
MethodgetCompositionQuerySession
Description

Gets a composition query session.

Returnosid.repository.CompositionQuerySessiona CompositionQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionQuery() is false
ComplianceoptionalThis method must be implemented if supportsCompositionQuery() is true.
MethodgetCompositionQuerySessionForRepository
Description

Gets a composition query session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.CompositionQuerySessiona CompositionQuerySession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompositionQuery() and supportsVisibleFederation() are true.
MethodgetCompositionSearchSession
Description

Gets a composition search session.

Returnosid.repository.CompositionSearchSessiona CompositionSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionSearch() is false
ComplianceoptionalThis method must be implemented if supportsCompositionSearch() is true.
MethodgetCompositionSearchSessionForRepository
Description

Gets a composition search session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.CompositionSearchSessiona CompositionSearchSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompositionSearch() and supportsVisibleFederation() are true.
MethodgetCompositionAdminSession
Description

Gets a composition administration session for creating, updating and deleting compositions.

Returnosid.repository.CompositionAdminSessiona CompositionAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCompositionAdmin() is true.
MethodgetCompositionAdminSessionForRepository
Description

Gets a composiiton administrative session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.CompositionAdminSessiona CompositionAdminSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompositionAdmin() and supportsVisibleFederation() are true.
MethodgetCompositionNotificationSession
Description

Gets the notification session for notifications pertaining to composition changes.

Parametersosid.repository.CompositionReceivercompositionReceiverthe notification callback
Returnosid.repository.CompositionNotificationSessiona CompositionNotificationSession
ErrorsNULL_ARGUMENT compositionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionNotification() is false
ComplianceoptionalThis method must be implemented if supportsCompositionNotification() is true.
MethodgetCompositionNotificationSessionForRepository
Description

Gets the composition notification session for the given repository.

Parametersosid.repository.CompositionReceivercompositionReceiverthe notification callback
osid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.CompositionNotificationSessiona CompositionNotificationSession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT compositionReceiver or repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompositionNotfication() and supportsVisibleFederation() are true.
MethodgetCompositionRepositorySession
Description

Gets the session for retrieving composition to repository mappings.

Returnosid.repository.CompositionRepositorySessiona CompositionRepositorySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionRepository() is false
ComplianceoptionalThis method must be implemented if supportsCompositionRepository() is true.
MethodgetCompositionRepositoryAssignmentSession
Description

Gets the session for assigning composition to repository mappings.

Returnosid.repository.CompositionRepositoryAssignmentSessiona CompositionRepositoryAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompositionRepositoryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCompositionRepositoryAssignment() is true.
MethodgetCompositionSmartRepositorySession
Description

Gets a composition smart repository session for the given repository.

Parametersosid.id.IdrepositoryIdthe Id of the repository
Returnosid.repository.CompositionSmartRepositorySessiona CompositionSmartRepositorySession
ErrorsNOT_FOUND repositoryId not found
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionSmartRepository() false
ComplianceoptionalThis method must be implemented if supportsCompositionSmartRepository() is true.
MethodgetRepositoryLookupSession
Description

Gets the repository lookup session.

Returnosid.repository.RepositoryLookupSessiona RepositoryLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryLookup() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryLookup() is true.
MethodgetRepositoryQuerySession
Description

Gets the repository query session.

Returnosid.repository.RepositoryQuerySessiona RepositoryQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryQuery() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryQuery() is true.
MethodgetRepositorySearchSession
Description

Gets the repository search session.

Returnosid.repository.RepositorySearchSessiona RepositorySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositorySearch() is false
ComplianceoptionalThis method must be implemented if supportsRepositorySearch() is true.
MethodgetRepositoryAdminSession
Description

Gets the repository administrative session for creating, updating and deleteing repositories.

Returnosid.repository.RepositoryAdminSessiona RepositoryAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryAdmin() is true.
MethodgetRepositoryNotificationSession
Description

Gets the notification session for subscribing to changes to a repository.

Parametersosid.repository.RepositoryReceiverrepositoryReceiverthe notification callback
Returnosid.repository.RepositoryNotificationSessiona RepositoryNotificationSession
ErrorsNULL_ARGUMENT repositoryReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryNotification() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryNotification() is true.
MethodgetRepositoryHierarchySession
Description

Gets the repository hierarchy traversal session.

Returnosid.repository.RepositoryHierarchySession a RepositoryHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryHierarchy() is true.
MethodgetRepositoryHierarchyDesignSession
Description

Gets the repository hierarchy design session.

Returnosid.repository.RepositoryHierarchyDesignSessiona RepostoryHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryHierarchyDesign() is true.
MethodgetRepositoryBatchManager
Description

Gets a RepositoryBatchManager.

Returnosid.repository.batch.RepositoryBatchManagera RepostoryBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryBatch() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryBatch() is true.
MethodgetRepositoryRulesManager
Description

Gets a RepositoryRulesManager.

Returnosid.repository.rules.RepositoryRulesManagera RepostoryRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRepositoryRules() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryRules() is true.