org.osid.repository

Interface RepositoryManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RepositoryProfile, Sourceable

public interface RepositoryManager
extends OsidManager, RepositoryProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AssetAdminSession	getAssetAdminSession() Gets an asset administration session for creating, updating and deleting assets.
AssetAdminSession	getAssetAdminSessionForRepository(Id repositoryId) Gets an asset administration session for the given repository.
AssetCompositionDesignSession	getAssetCompositionDesignSession() Gets the session for creating asset compositions.
AssetCompositionSession	getAssetCompositionSession() Gets the session for retrieving asset compositions.
AssetLookupSession	getAssetLookupSession() Gets the OsidSession associated with the asset lookup service.
AssetLookupSession	getAssetLookupSessionForRepository(Id repositoryId) Gets the OsidSession associated with the asset lookup service for the given repository.
AssetNotificationSession	getAssetNotificationSession(AssetReceiver assetReceiver) Gets the notification session for notifications pertaining to asset changes.
AssetNotificationSession	getAssetNotificationSessionForRepository(AssetReceiver assetReceiver, Id repositoryId) Gets the asset notification session for the given repository.
AssetQuerySession	getAssetQuerySession() Gets an asset query session.
AssetQuerySession	getAssetQuerySessionForRepository(Id repositoryId) Gets an asset query session for the given repository.
AssetRepositoryAssignmentSession	getAssetRepositoryAssignmentSession() Gets the session for assigning asset to repository mappings.
AssetRepositorySession	getAssetRepositorySession() Gets the session for retrieving asset to repository mappings.
AssetSearchSession	getAssetSearchSession() Gets an asset search session.
AssetSearchSession	getAssetSearchSessionForRepository(Id repositoryId) Gets an asset search session for the given repository.
AssetSmartRepositorySession	getAssetSmartRepositorySession(Id repositoryId) Gets an asset smart repository session for the given repository.
AssetSpatialAssignmentSession	getAssetSpatialAssignmentSession() Gets the session for assigning spatial coverage to an asset.
AssetSpatialAssignmentSession	getAssetSpatialAssignmentSessionForRepository(Id repositoryId) Gets the session for assigning spatial coverage of an asset for the given repository.
AssetSpatialSession	getAssetSpatialSession() Gets the session for retrieving spatial coverage of an asset.
AssetSpatialSession	getAssetSpatialSessionForRepository(Id repositoryId) Gets the session for retrieving spatial coverage of an asset for the given repository.
AssetTemporalAssignmentSession	getAssetTemporalAssignmentSession() Gets the session for assigning temporal coverage to an asset.
AssetTemporalAssignmentSession	getAssetTemporalAssignmentSessionForRepository(Id repositoryId) Gets the session for assigning temporal coverage of an asset for the given repository.
AssetTemporalSession	getAssetTemporalSession() Gets the session for retrieving temporal coverage of an asset.
AssetTemporalSession	getAssetTemporalSessionForRepository(Id repositoryId) Gets the session for retrieving temporal coverage of an asset for the given repository.
CompositionAdminSession	getCompositionAdminSession() Gets a composition administration session for creating, updating and deleting compositions.
CompositionAdminSession	getCompositionAdminSessionForRepository(Id repositoryId) Gets a composiiton administrative session for the given repository.
CompositionLookupSession	getCompositionLookupSession() Gets the OsidSession associated with the composition lookup service.
CompositionLookupSession	getCompositionLookupSessionForRepository(Id repositoryId) Gets the OsidSession associated with the composition lookup service for the given repository.
CompositionNotificationSession	getCompositionNotificationSession(CompositionReceiver compositionReceiver) Gets the notification session for notifications pertaining to composition changes.
CompositionNotificationSession	getCompositionNotificationSessionForRepository(CompositionReceiver compositionReceiver, Id repositoryId) Gets the composition notification session for the given repository.
CompositionQuerySession	getCompositionQuerySession() Gets a composition query session.
CompositionQuerySession	getCompositionQuerySessionForRepository(Id repositoryId) Gets a composition query session for the given repository.
CompositionRepositoryAssignmentSession	getCompositionRepositoryAssignmentSession() Gets the session for assigning composition to repository mappings.
CompositionRepositorySession	getCompositionRepositorySession() Gets the session for retrieving composition to repository mappings.
CompositionSearchSession	getCompositionSearchSession() Gets a composition search session.
CompositionSearchSession	getCompositionSearchSessionForRepository(Id repositoryId) Gets a composition search session for the given repository.
CompositionSmartRepositorySession	getCompositionSmartRepositorySession(Id repositoryId) Gets a composition smart repository session for the given repository.
RepositoryAdminSession	getRepositoryAdminSession() Gets the repository administrative session for creating, updating and deleteing repositories.
RepositoryBatchManager	getRepositoryBatchManager() Gets a RepositoryBatchManager.
RepositoryHierarchyDesignSession	getRepositoryHierarchyDesignSession() Gets the repository hierarchy design session.
RepositoryHierarchySession	getRepositoryHierarchySession() Gets the repository hierarchy traversal session.
RepositoryLookupSession	getRepositoryLookupSession() Gets the repository lookup session.
RepositoryNotificationSession	getRepositoryNotificationSession(RepositoryReceiver repositoryReceiver) Gets the notification session for subscribing to changes to a repository.
RepositoryQuerySession	getRepositoryQuerySession() Gets the repository query session.
RepositoryRulesManager	getRepositoryRulesManager() Gets a RepositoryRulesManager.
RepositorySearchSession	getRepositorySearchSession() Gets the repository search session.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.repository.RepositoryProfile

getAssetContentRecordTypes, getAssetRecordTypes, getAssetSearchRecordTypes, getCompositionRecordTypes, getCompositionSearchRecordTypes, getCoordinateTypes, getRepositoryRecordTypes, getRepositorySearchRecordTypes, getSpatialUnitRecordTypes, supportsAssetAdmin, supportsAssetComposition, supportsAssetCompositionDesign, supportsAssetContentRecordType, supportsAssetLookup, supportsAssetNotification, supportsAssetQuery, supportsAssetRecordType, supportsAssetRepository, supportsAssetRepositoryAssignment, supportsAssetSearch, supportsAssetSearchRecordType, supportsAssetSmartRepository, supportsAssetSpatial, supportsAssetSpatialAssignment, supportsAssetTemporal, supportsAssetTemporalAssignment, supportsCompositionAdmin, supportsCompositionLookup, supportsCompositionNotification, supportsCompositionQuery, supportsCompositionRecordType, supportsCompositionRepository, supportsCompositionRepositoryAssignment, supportsCompositionSearch, supportsCompositionSearchRecordType, supportsCompositionSmartRepository, supportsCoordinateType, supportsRepositoryAdmin, supportsRepositoryBatch, supportsRepositoryHierarchy, supportsRepositoryHierarchyDesign, supportsRepositoryLookup, supportsRepositoryNotification, supportsRepositoryQuery, supportsRepositoryRecordType, supportsRepositoryRules, supportsRepositorySearch, supportsRepositorySearchRecordType, supportsSpatialUnitRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAssetLookupSession

AssetLookupSession getAssetLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the asset lookup service.

Returns:

the new AssetLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetLookup() is false

Compliance:

optional - This method must be implemented if supportsAssetLookup() is true.

getAssetLookupSessionForRepository

AssetLookupSession getAssetLookupSessionForRepository(Id repositoryId)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

Returns:

the new AssetLookupSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetLookup() and supportsVisibleFederation() are true.

getAssetQuerySession

AssetQuerySession getAssetQuerySession()
                                       throws OperationFailedException

Gets an asset query session.

Returns:

an AssetQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetQuery() is false

Compliance:

optional - This method must be implemented if supportsAssetQuery() is true.

getAssetQuerySessionForRepository

AssetQuerySession getAssetQuerySessionForRepository(Id repositoryId)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets an asset query session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetQuerySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetQuery() and supportsVisibleFederation() are true.

getAssetSearchSession

AssetSearchSession getAssetSearchSession()
                                         throws OperationFailedException

Gets an asset search session.

Returns:

an AssetSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetSearch() is false

Compliance:

optional - This method must be implemented if supportsAssetSearch() is true.

getAssetSearchSessionForRepository

AssetSearchSession getAssetSearchSessionForRepository(Id repositoryId)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets an asset search session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetSearchSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetSearch() and supportsVisibleFederation() are true.

getAssetAdminSession

AssetAdminSession getAssetAdminSession()
                                       throws OperationFailedException

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

Returns:

an AssetAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetAdmin() is false

Compliance:

optional - This method must be implemented if supportsAssetAdmin() is true.

getAssetAdminSessionForRepository

AssetAdminSession getAssetAdminSessionForRepository(Id repositoryId)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets an asset administration session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetAdminSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetAdmin() and supportsVisibleFederation() are true.

getAssetNotificationSession

AssetNotificationSession getAssetNotificationSession(AssetReceiver assetReceiver)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to asset changes.

Parameters:

assetReceiver - the notification callback

Returns:

an AssetNotificationSession

Throws:

NullArgumentException - assetReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetNotification() is false

Compliance:

optional - This method must be implemented if supportsAssetNotification() is true.

getAssetNotificationSessionForRepository

AssetNotificationSession getAssetNotificationSessionForRepository(AssetReceiver assetReceiver,
                                                                Id repositoryId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the asset notification session for the given repository.

Parameters:

assetReceiver - the notification callback

repositoryId - the Id of the repository

Returns:

an AssetNotificationSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - assetReceiver or repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetNotfication() and supportsVisibleFederation() are true.

getAssetRepositorySession

AssetRepositorySession getAssetRepositorySession()
                                                 throws OperationFailedException

Gets the session for retrieving asset to repository mappings.

Returns:

an AssetRepositorySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetRepository() is false

Compliance:

optional - This method must be implemented if supportsAssetRepository() is true.

getAssetRepositoryAssignmentSession

AssetRepositoryAssignmentSession getAssetRepositoryAssignmentSession()
                                                                     throws OperationFailedException

Gets the session for assigning asset to repository mappings.

Returns:

an AssetRepositoryAsignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetRepositoryAssignment() is false

Compliance:

optional - This method must be implemented if supportsAssetRepositoryAssignment() is true.

getAssetSmartRepositorySession

AssetSmartRepositorySession getAssetSmartRepositorySession(Id repositoryId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets an asset smart repository session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetSmartRepositorySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetSmartRepository() false

Compliance:

optional - This method must be implemented if supportsAssetSmartRepository() is true.

getAssetTemporalSession

AssetTemporalSession getAssetTemporalSession()
                                             throws OperationFailedException

Gets the session for retrieving temporal coverage of an asset.

Returns:

an AssetTemporalSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetTemporal() is false

Compliance:

optional - This method must be implemented if supportsAssetTemporal() is true.

getAssetTemporalSessionForRepository

AssetTemporalSession getAssetTemporalSessionForRepository(Id repositoryId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetTemporalSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetTemporal() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetTemporal() and supportsVisibleFederation() are true.

getAssetTemporalAssignmentSession

AssetTemporalAssignmentSession getAssetTemporalAssignmentSession()
                                                                 throws OperationFailedException

Gets the session for assigning temporal coverage to an asset.

Returns:

an AssetTemporalAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetTemporalAssignment() is false

Compliance:

optional - This method must be implemented if supportsAssetTemporalAssignment() is true.

getAssetTemporalAssignmentSessionForRepository

AssetTemporalAssignmentSession getAssetTemporalAssignmentSessionForRepository(Id repositoryId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetTemporalAssignmentSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetTemporalAssignment() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetTemporalAssignment() and supportsVisibleFederation() are true.

getAssetSpatialSession

AssetSpatialSession getAssetSpatialSession()
                                           throws OperationFailedException

Gets the session for retrieving spatial coverage of an asset.

Returns:

an AssetSpatialSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpatialAssets() is false

Compliance:

optional - This method must be implemented if supportsSpatialAssets() is true.

getAssetSpatialSessionForRepository

AssetSpatialSession getAssetSpatialSessionForRepository(Id repositoryId)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetSpatialSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetSpatial() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetSpatial() and supportsVisibleFederation() are true.

getAssetSpatialAssignmentSession

AssetSpatialAssignmentSession getAssetSpatialAssignmentSession()
                                                               throws OperationFailedException

Gets the session for assigning spatial coverage to an asset.

Returns:

an AssetSpatialAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetSpatialAssignment() is false

Compliance:

optional - This method must be implemented if supportsAssetSpatialAssignment() is true.

getAssetSpatialAssignmentSessionForRepository

AssetSpatialAssignmentSession getAssetSpatialAssignmentSessionForRepository(Id repositoryId)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

Returns:

an AssetSpatialAssignmentSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetSpatialAssignment() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssetSpatialAssignment() and supportsVisibleFederation() are true.

getAssetCompositionSession

AssetCompositionSession getAssetCompositionSession()
                                                   throws OperationFailedException

Gets the session for retrieving asset compositions.

Returns:

an AssetCompositionSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetComposition() is false

Compliance:

optional - This method must be implemented if supportsAssetComposition() is true.

getAssetCompositionDesignSession

AssetCompositionDesignSession getAssetCompositionDesignSession()
                                                               throws OperationFailedException

Gets the session for creating asset compositions.

Returns:

an AssetCompositionDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetCompositionDesign() is false

Compliance:

optional - This method must be implemented if supportsAssetCompositionDesign() is true.

getCompositionLookupSession

CompositionLookupSession getCompositionLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the composition lookup service.

Returns:

the new CompositionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionLookup() is false

Compliance:

optional - This method must be implemented if supportsCompositionLookup() is true.

getCompositionLookupSessionForRepository

CompositionLookupSession getCompositionLookupSessionForRepository(Id repositoryId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

Returns:

the new CompositionLookupSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionLookup() and supportsVisibleFederation() are true.

getCompositionQuerySession

CompositionQuerySession getCompositionQuerySession()
                                                   throws OperationFailedException

Gets a composition query session.

Returns:

a CompositionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionQuery() is false

Compliance:

optional - This method must be implemented if supportsCompositionQuery() is true.

getCompositionQuerySessionForRepository

CompositionQuerySession getCompositionQuerySessionForRepository(Id repositoryId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets a composition query session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

a CompositionQuerySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionQuery() and supportsVisibleFederation() are true.

getCompositionSearchSession

CompositionSearchSession getCompositionSearchSession()
                                                     throws OperationFailedException

Gets a composition search session.

Returns:

a CompositionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionSearch() is false

Compliance:

optional - This method must be implemented if supportsCompositionSearch() is true.

getCompositionSearchSessionForRepository

CompositionSearchSession getCompositionSearchSessionForRepository(Id repositoryId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets a composition search session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

a CompositionSearchSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionSearch() and supportsVisibleFederation() are true.

getCompositionAdminSession

CompositionAdminSession getCompositionAdminSession()
                                                   throws OperationFailedException

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

Returns:

a CompositionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionAdmin() is false

Compliance:

optional - This method must be implemented if supportsCompositionAdmin() is true.

getCompositionAdminSessionForRepository

CompositionAdminSession getCompositionAdminSessionForRepository(Id repositoryId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets a composiiton administrative session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

a CompositionAdminSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionAdmin() and supportsVisibleFederation() are true.

getCompositionNotificationSession

CompositionNotificationSession getCompositionNotificationSession(CompositionReceiver compositionReceiver)
                                                                 throws OperationFailedException

Gets the notification session for notifications pertaining to composition changes.

Parameters:

compositionReceiver - the notification callback

Returns:

a CompositionNotificationSession

Throws:

NullArgumentException - compositionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionNotification() is false

Compliance:

optional - This method must be implemented if supportsCompositionNotification() is true.

getCompositionNotificationSessionForRepository

CompositionNotificationSession getCompositionNotificationSessionForRepository(CompositionReceiver compositionReceiver,
                                                                            Id repositoryId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

Gets the composition notification session for the given repository.

Parameters:

compositionReceiver - the notification callback

repositoryId - the Id of the repository

Returns:

a CompositionNotificationSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - compositionReceiver or repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionNotfication() and supportsVisibleFederation() are true.

getCompositionRepositorySession

CompositionRepositorySession getCompositionRepositorySession()
                                                             throws OperationFailedException

Gets the session for retrieving composition to repository mappings.

Returns:

a CompositionRepositorySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionRepository() is false

Compliance:

optional - This method must be implemented if supportsCompositionRepository() is true.

getCompositionRepositoryAssignmentSession

CompositionRepositoryAssignmentSession getCompositionRepositoryAssignmentSession()
                                                                                 throws OperationFailedException

Gets the session for assigning composition to repository mappings.

Returns:

a CompositionRepositoryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionRepositoryAssignment() is false

Compliance:

optional - This method must be implemented if supportsCompositionRepositoryAssignment() is true.

getCompositionSmartRepositorySession

CompositionSmartRepositorySession getCompositionSmartRepositorySession(Id repositoryId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets a composition smart repository session for the given repository.

Parameters:

repositoryId - the Id of the repository

Returns:

a CompositionSmartRepositorySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionSmartRepository() false

Compliance:

optional - This method must be implemented if supportsCompositionSmartRepository() is true.

getRepositoryLookupSession

RepositoryLookupSession getRepositoryLookupSession()
                                                   throws OperationFailedException

Gets the repository lookup session.

Returns:

a RepositoryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryLookup() is false

Compliance:

optional - This method must be implemented if supportsRepositoryLookup() is true.

getRepositoryQuerySession

RepositoryQuerySession getRepositoryQuerySession()
                                                 throws OperationFailedException

Gets the repository query session.

Returns:

a RepositoryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryQuery() is false

Compliance:

optional - This method must be implemented if supportsRepositoryQuery() is true.

getRepositorySearchSession

RepositorySearchSession getRepositorySearchSession()
                                                   throws OperationFailedException

Gets the repository search session.

Returns:

a RepositorySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositorySearch() is false

Compliance:

optional - This method must be implemented if supportsRepositorySearch() is true.

getRepositoryAdminSession

RepositoryAdminSession getRepositoryAdminSession()
                                                 throws OperationFailedException

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

Returns:

a RepositoryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryAdmin() is false

Compliance:

optional - This method must be implemented if supportsRepositoryAdmin() is true.

getRepositoryNotificationSession

RepositoryNotificationSession getRepositoryNotificationSession(RepositoryReceiver repositoryReceiver)
                                                               throws OperationFailedException

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

Parameters:

repositoryReceiver - the notification callback

Returns:

a RepositoryNotificationSession

Throws:

NullArgumentException - repositoryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryNotification() is false

Compliance:

optional - This method must be implemented if supportsRepositoryNotification() is true.

getRepositoryHierarchySession

RepositoryHierarchySession getRepositoryHierarchySession()
                                                         throws OperationFailedException

Gets the repository hierarchy traversal session.

Returns:

a RepositoryHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryHierarchy() is false

Compliance:

optional - This method must be implemented if supportsRepositoryHierarchy() is true.

getRepositoryHierarchyDesignSession

RepositoryHierarchyDesignSession getRepositoryHierarchyDesignSession()
                                                                     throws OperationFailedException

Gets the repository hierarchy design session.

Returns:

a RepostoryHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsRepositoryHierarchyDesign() is true.

getRepositoryBatchManager

RepositoryBatchManager getRepositoryBatchManager()
                                                 throws OperationFailedException

Gets a RepositoryBatchManager.

Returns:

a RepostoryBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryBatch() is false

Compliance:

optional - This method must be implemented if supportsRepositoryBatch() is true.

getRepositoryRulesManager

RepositoryRulesManager getRepositoryRulesManager()
                                                 throws OperationFailedException

Gets a RepositoryRulesManager.

Returns:

a RepostoryRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryRules() is false

Compliance:

optional - This method must be implemented if supportsRepositoryRules() is true.