org.osid.repository

Interface RepositoryProxyManager

All Superinterfaces:

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

public interface RepositoryProxyManager
extends OsidProxyManager, RepositoryProfile

The repository manager provides access to asset lookup and creation session and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information from a server environment. 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(Proxy proxy) Gets an asset administration session for creating, updating and deleting assets.
AssetAdminSession	getAssetAdminSessionForRepository(Id repositoryId, Proxy proxy) Gets an asset administration session for the given repository.
AssetCompositionDesignSession	getAssetCompositionDesignSession(Proxy proxy) Gets the session for creating asset compositions.
AssetCompositionSession	getAssetCompositionSession(Proxy proxy) Gets the session for retrieving asset compositions.
AssetLookupSession	getAssetLookupSession(Proxy proxy) Gets the OsidSession associated with the asset lookup service.
AssetLookupSession	getAssetLookupSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the asset lookup service for the given repository.
AssetNotificationSession	getAssetNotificationSession(AssetReceiver assetReceiver, Proxy proxy) Gets the notification session for notifications pertaining to asset changes.
AssetNotificationSession	getAssetNotificationSessionForRepository(AssetReceiver assetReceiver, Id repositoryId, Proxy proxy) Gets the asset notification session for the given repository.
AssetQuerySession	getAssetQuerySession(Proxy proxy) Gets the OsidSession associated with the asset query service.
AssetQuerySession	getAssetQuerySessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the asset query service for the given repository.
AssetRepositoryAssignmentSession	getAssetRepositoryAssignmentSession(Proxy proxy) Gets the session for assigning asset to repository mappings.
AssetRepositorySession	getAssetRepositorySession(Proxy proxy) Gets the session for retrieving asset to repository mappings.
AssetSearchSession	getAssetSearchSession(Proxy proxy) Gets an asset search session.
AssetSearchSession	getAssetSearchSessionForRepository(Id repositoryId, Proxy proxy) Gets an asset search session for the given repository.
AssetSmartRepositorySession	getAssetSmartRepositorySession(Id repositoryId, Proxy proxy) Gets an asset smart repository session for the given repository.
AssetSpatialAssignmentSession	getAssetSpatialAssignmentSession(Proxy proxy) Gets the session for assigning spatial coverage to an asset.
AssetSpatialAssignmentSession	getAssetSpatialAssignmentSessionForRepository(Id repositoryId, Proxy proxy) Gets the session for assigning spatial coverage of an asset for the given repository.
AssetSpatialSession	getAssetSpatialSession(Proxy proxy) Gets the session for retrieving spatial coverage of an asset.
AssetSpatialSession	getAssetSpatialSessionForRepository(Id repositoryId, Proxy proxy) Gets the session for retrieving spatial coverage of an asset for the given repository.
AssetTemporalAssignmentSession	getAssetTemporalAssignmentSession(Proxy proxy) Gets the session for assigning temporal coverage to an asset.
AssetTemporalAssignmentSession	getAssetTemporalAssignmentSessionForRepository(Id repositoryId, Proxy proxy) Gets the session for assigning temporal coverage of an asset for the given repository.
AssetTemporalSession	getAssetTemporalSession(Proxy proxy) Gets the session for retrieving temporal coverage of an asset.
AssetTemporalSession	getAssetTemporalSessionForRepository(Id repositoryId, Proxy proxy) Gets the session for retrieving temporal coverage of an asset for the given repository.
CompositionAdminSession	getCompositionAdminSession(Proxy proxy) Gets a composition administration session for creating, updating and deleting compositions.
CompositionAdminSession	getCompositionAdminSessionForRepository(Id repositoryId, Proxy proxy) Gets a composiiton administrative session for the given repository.
CompositionLookupSession	getCompositionLookupSession(Proxy proxy) Gets the OsidSession associated with the composition lookup service.
CompositionLookupSession	getCompositionLookupSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the composition lookup service for the given repository.
CompositionNotificationSession	getCompositionNotificationSession(CompositionReceiver compositionReceiver, Proxy proxy) Gets the notification session for notifications pertaining to composition changes.
CompositionNotificationSession	getCompositionNotificationSessionForRepository(CompositionReceiver compositionReceiver, Id repositoryId, Proxy proxy) Gets the composition notification session for the given repository.
CompositionSearchSession	getCompositionQuerySession(Proxy proxy) Gets a composition query session.
CompositionQuerySession	getCompositionQuerySessionForRepository(Id repositoryId, Proxy proxy) Gets a composition query session for the given repository.
CompositionRepositoryAssignmentSession	getCompositionRepositoryAssignmentSession(Proxy proxy) Gets the session for assigning composition to repository mappings.
CompositionRepositorySession	getCompositionRepositorySession(Proxy proxy) Gets the session for retrieving composition to repository mappings.
CompositionSearchSession	getCompositionSearchSession(Proxy proxy) Gets a composition search session.
CompositionSearchSession	getCompositionSearchSessionForRepository(Id repositoryId, Proxy proxy) Gets a composition search session for the given repository.
CompositionSmartRepositorySession	getCompositionSmartRepositorySession(Id repositoryId, Proxy proxy) Gets a composition smart repository session for the given repository.
RepositoryAdminSession	getRepositoryAdminSession(Proxy proxy) Gets the repository administrative session for creating, updating and deleteing repositories.
RepositoryBatchProxyManager	getRepositoryBatchProxyManager() Gets a RepositoryBatchProxyManager.
RepositoryHierarchyDesignSession	getRepositoryHierarchyDesignSession(Proxy proxy) Gets the repository hierarchy design session.
RepositoryHierarchySession	getRepositoryHierarchySession(Proxy proxy) Gets the repository hierarchy traversal session.
RepositoryLookupSession	getRepositoryLookupSession(Proxy proxy) Gets the repository lookup session.
RepositoryNotificationSession	getRepositoryNotificationSession(RepositoryReceiver repositoryReceiver, Proxy proxy) Gets the notification session for subscribing to changes to a repository.
RepositoryQuerySession	getRepositoryQuerySession(Proxy proxy) Gets the repository query session.
RepositoryRulesProxyManager	getRepositoryRulesProxyManager() Gets a RepositoryRulesProxyManager.
RepositorySearchSession	getRepositorySearchSession(Proxy proxy) Gets the repository search session.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the asset lookup service.

Parameters:

proxy - a proxy

Returns:

an AssetLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetLookupSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the asset query service.

Parameters:

proxy - a proxy

Returns:

an AssetQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetQuerySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets an asset search session.

Parameters:

proxy - a proxy

Returns:

an AssetSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets an asset search session for the given repository.

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetSearchSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AssetAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets an asset administration session for the given repository.

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetAdminSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to asset changes.

Parameters:

assetReceiver - the notification callback

proxy - a proxy

Returns:

an AssetNotificationSession

Throws:

NullArgumentException - assetReceiver or proxy 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,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the asset notification session for the given repository.

Parameters:

assetReceiver - the notification callback

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetNotificationSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - assetReceiver, repositoryId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the session for retrieving asset to repository mappings.

Parameters:

proxy - a proxy

Returns:

an AssetRepositorySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetRepository() is false

Compliance:

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

getAssetRepositoryAssignmentSession

AssetRepositoryAssignmentSession getAssetRepositoryAssignmentSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the session for assigning asset to repository mappings.

Parameters:

proxy - a proxy

Returns:

an AssetRepositoryAsignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets an asset smart repository session for the given repository.

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetSmartRepositorySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetSmartRepository() false

Compliance:

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

getAssetTemporalSession

AssetTemporalSession getAssetTemporalSession(Proxy proxy)
                                             throws OperationFailedException

Gets the session for retrieving temporal coverage of an asset.

Parameters:

proxy - a proxy

Returns:

an AssetTemporalSession

Throws:

NullArgumentException - proxy is null

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,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetTemporalSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session for assigning temporal coverage to an asset.

Parameters:

proxy - a proxy

Returns:

an AssetTemporalAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                            Proxy proxy)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetTemporalAssignmentSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the session for retrieving spatial coverage of an asset.

Parameters:

proxy - a proxy

Returns:

an AssetSpatialSession

Throws:

NullArgumentException - proxy is null

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,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetSpatialSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                               throws OperationFailedException

Gets the session for assigning spatial coverage to an asset.

Parameters:

proxy - a proxy

Returns:

an AssetSpatialAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                          Proxy proxy)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

an AssetSpatialAssignmentSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the session for retrieving asset compositions.

Parameters:

proxy - a proxy

Returns:

an AssetCompositionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetComposition() is false

Compliance:

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

getAssetCompositionDesignSession

AssetCompositionDesignSession getAssetCompositionDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the session for creating asset compositions.

Parameters:

proxy - a proxy

Returns:

an AssetCompositionDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetCompositionDesign() is false

Compliance:

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

getCompositionLookupSession

CompositionLookupSession getCompositionLookupSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the composition lookup service.

Parameters:

proxy - a proxy

Returns:

the new CompositionLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

the new CompositionLookupSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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

CompositionSearchSession getCompositionQuerySession(Proxy proxy)
                                                    throws OperationFailedException

Gets a composition query session.

Parameters:

proxy - a proxy

Returns:

a CompositionQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets a composition query session for the given repository.

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

a CompositionQuerySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets a composition search session.

Parameters:

proxy - a proxy

Returns:

a CompositionSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets a composition search session for the given repository.

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

a CompositionSearchSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CompositionAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets a composiiton administrative session for the given repository.

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

a CompositionAdminSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy 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,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the notification session for notifications pertaining to composition changes.

Parameters:

compositionReceiver - the notification callback

proxy - a proxy

Returns:

a CompositionNotificationSession

Throws:

NullArgumentException - compositionReceiver or proxy 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,
                                                                            Proxy proxy)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

Gets the composition notification session for the given repository.

Parameters:

compositionReceiver - the notification callback

repositoryId - the Id of the repository

proxy - a proxy

Returns:

a CompositionNotificationSession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - compositionReceiver, repositoryId or proxy 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(Proxy proxy)
                                                             throws OperationFailedException

Gets the session for retrieving composition to repository mappings.

Parameters:

proxy - a proxy

Returns:

a CompositionRepositorySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionRepository() is false

Compliance:

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

getCompositionRepositoryAssignmentSession

CompositionRepositoryAssignmentSession getCompositionRepositoryAssignmentSession(Proxy proxy)
                                                                                 throws OperationFailedException

Gets the session for assigning composition to repository mappings.

Parameters:

proxy - a proxy

Returns:

a CompositionRepositoryAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets a composition smart repository session for the given repository.

Parameters:

repositoryId - the Id of the repository

proxy - a proxy

Returns:

a CompositionSmartRepositorySession

Throws:

NotFoundException - repositoryId not found

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionSmartRepository() false

Compliance:

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

getRepositoryLookupSession

RepositoryLookupSession getRepositoryLookupSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the repository lookup session.

Parameters:

proxy - a proxy

Returns:

a RepositoryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryLookup() is false

Compliance:

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

getRepositoryQuerySession

RepositoryQuerySession getRepositoryQuerySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the repository query session.

Parameters:

proxy - a proxy

Returns:

a RepositoryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryQuery() is false

Compliance:

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

getRepositorySearchSession

RepositorySearchSession getRepositorySearchSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the repository search session.

Parameters:

proxy - a proxy

Returns:

a RepositorySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositorySearch() is false

Compliance:

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

getRepositoryAdminSession

RepositoryAdminSession getRepositoryAdminSession(Proxy proxy)
                                                 throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a RepositoryAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws OperationFailedException

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

Parameters:

repositoryReceiver - the notification callback

proxy - a proxy

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(Proxy proxy)
                                                         throws OperationFailedException

Gets the repository hierarchy traversal session.

Parameters:

proxy - a proxy

Returns:

a RepositoryHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryHierarchy() is false

Compliance:

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

getRepositoryHierarchyDesignSession

RepositoryHierarchyDesignSession getRepositoryHierarchyDesignSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the repository hierarchy design session.

Parameters:

proxy - a proxy

Returns:

a RepostoryHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryHierarchyDesign() is false

Compliance:

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

getRepositoryBatchProxyManager

RepositoryBatchProxyManager getRepositoryBatchProxyManager()
                                                           throws OperationFailedException

Gets a RepositoryBatchProxyManager.

Returns:

a RepostoryBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryBatch() is false

Compliance:

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

getRepositoryRulesProxyManager

RepositoryRulesProxyManager getRepositoryRulesProxyManager()
                                                           throws OperationFailedException

Gets a RepositoryRulesProxyManager.

Returns:

a RepostoryRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRepositoryRules() is false

Compliance:

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