Interface RepositoryProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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

• AssetContentLookupSession : a session to retrieve asset contents
• AssetContentQuerySession : a session to query for asset contents
• AssetContentSearchSession : a session to search for asset contents
• AssetContentAdminSession : a session to create and delete asset contents
• AssetContentNotificationSession : a session to receive notifications pertaining to asset content changes
• AssetContentRepositorySession : a session to look up asset content repository mappings
• AssetContentRepositoryAssignmentSession : a session to manage asset content to repository mappings
• AssetContentSmartRepositorySession : a session to manage dynamic repositories of asset contents

• 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

Modifier and Type	Method	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.
AssetCompositionDesignSession	getAssetCompositionDesignSessionForRepository(Id repositoryId, Proxy proxy)	Gets the session for creating asset compositions for the given repository.
AssetCompositionSession	getAssetCompositionSession(Proxy proxy)	Gets the session for retrieving asset compositions.
AssetCompositionSession	getAssetCompositionSessionForRepository(Id repositoryId, Proxy proxy)	Gets the session for composing assets for the given repository.
AssetContentAdminSession	getAssetContentAdminSession(Proxy proxy)	Gets the OsidSession associated with the asset content administration service.
AssetContentAdminSession	getAssetContentAdminSessionForRepository(Id repositoryId, Proxy proxy)	Gets the OsidSession associated with the asset content administration service for the given repository.
AssetContentLookupSession	getAssetContentLookupSession(Proxy proxy)	Gets the OsidSession associated with the asset content lookup service.
AssetContentLookupSession	getAssetContentLookupSessionForRepository(Id repositoryId, Proxy proxy)	Gets the OsidSession associated with the asset content lookup service for the given repository.
AssetContentNotificationSession	getAssetContentNotificationSession(AssetContentReceiver assetContentReceiver, Proxy proxy)	Gets the OsidSession associated with the asset content notification service.
AssetContentNotificationSession	getAssetContentNotificationSessionForRepository(AssetContentReceiver assetContentReceiver, Id repositoryId, Proxy proxy)	Gets the OsidSession associated with the asset content notification service for the given repository.
AssetContentQuerySession	getAssetContentQuerySession(Proxy proxy)	Gets the OsidSession associated with the asset content query service.
AssetContentQuerySession	getAssetContentQuerySessionForRepository(Id repositoryId, Proxy proxy)	Gets the OsidSession associated with the asset content query service for the given repository.
AssetContentRepositoryAssignmentSession	getAssetContentRepositoryAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning asset contents to repositories.
AssetContentRepositorySession	getAssetContentRepositorySession(Proxy proxy)	Gets the OsidSession to lookup asset content/repository mappings.
AssetContentSearchSession	getAssetContentSearchSession(Proxy proxy)	Gets the OsidSession associated with the asset content search service.
AssetContentSearchSession	getAssetContentSearchSessionForRepository(Id repositoryId, Proxy proxy)	Gets the OsidSession associated with the asset content search service for the given repository.
AssetContentSmartRepositorySession	getAssetContentSmartRepositorySession(Id repositoryId, Proxy proxy)	Gets the OsidSession to manage asset content smart repositories.
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 composition 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 Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface RepositoryProfile

getAssetContentRecordTypes, getAssetContentSearchRecordTypes, getAssetRecordTypes, getAssetSearchRecordTypes, getCompositionRecordTypes, getCompositionSearchRecordTypes, getCoordinateTypes, getRepositoryRecordTypes, getRepositorySearchRecordTypes, getSpatialUnitRecordTypes, supportsAssetAdmin, supportsAssetComposition, supportsAssetCompositionDesign, supportsAssetContentAdmin, supportsAssetContentLookup, supportsAssetContentNotification, supportsAssetContentQuery, supportsAssetContentRecordType, supportsAssetContentRepository, supportsAssetContentRepositoryAssignment, supportsAssetContentSearch, supportsAssetContentSearchRecordType, supportsAssetContentSmartRepository, 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

Modifier and Type	Method	Description
TypeList	getAssetContentRecordTypes()	Gets the supported AssetContent record types.
TypeList	getAssetContentSearchRecordTypes()	Gets the supported AssetContent search types.
TypeList	getAssetRecordTypes()	Gets all the asset record types supported.
TypeList	getAssetSearchRecordTypes()	Gets all the asset search record types supported.
TypeList	getCompositionRecordTypes()	Gets all the composition record types supported.
TypeList	getCompositionSearchRecordTypes()	Gets all the composition search record types supported.
TypeList	getCoordinateTypes()	Gets all the coordinate types supported.
TypeList	getRepositoryRecordTypes()	Gets all the repository record types supported.
TypeList	getRepositorySearchRecordTypes()	Gets all the repository search record types supported.
TypeList	getSpatialUnitRecordTypes()	Gets all the spatial unit record types supported.
boolean	supportsAssetAdmin()	Tests if asset administration is supported.
boolean	supportsAssetComposition()	Tests if assets are included in compositions.
boolean	supportsAssetCompositionDesign()	Tests if mapping assets to compositions is supported.
boolean	supportsAssetContentAdmin()	Tests if an asset content administrative service is supported.
boolean	supportsAssetContentLookup()	Tests if looking up asset contents is supported.
boolean	supportsAssetContentNotification()	Tests if an asset content notification service is supported.
boolean	supportsAssetContentQuery()	Tests if querying asset contents is supported.
boolean	supportsAssetContentRecordType(Type assetContentRecordType)	Tests if the given AssetContent record type is supported.
boolean	supportsAssetContentRepository()	Tests if an asset content repository lookup service is supported.
boolean	supportsAssetContentRepositoryAssignment()	Tests if an asset content repository assignment service is supported.
boolean	supportsAssetContentSearch()	Tests if searching asset contents is supported.
boolean	supportsAssetContentSearchRecordType(Type assetContentSearchRecordType)	Tests if the given AssetContent search type is supported.
boolean	supportsAssetContentSmartRepository()	Tests if an asset content smart repository service is supported.
boolean	supportsAssetLookup()	Tests if asset lookup is supported.
boolean	supportsAssetNotification()	Tests if asset notification is supported.
boolean	supportsAssetQuery()	Tests if asset query is supported.
boolean	supportsAssetRecordType(Type assetRecordType)	Tests if a given asset type is supported.
boolean	supportsAssetRepository()	Tests if retrieving mappings of assets and repositories is supported.
boolean	supportsAssetRepositoryAssignment()	Tests if managing mappings of assets and repositories is supported.
boolean	supportsAssetSearch()	Tests if asset search is supported.
boolean	supportsAssetSearchRecordType(Type assetSearchRecordType)	Tests if a given asset search record type is supported.
boolean	supportsAssetSmartRepository()	Tests if asset smart repository is supported.
boolean	supportsAssetSpatial()	Tests if retrieving mappings of assets and spatial coverage is supported.
boolean	supportsAssetSpatialAssignment()	Tests if managing mappings of assets and spatial ocverage is supported.
boolean	supportsAssetTemporal()	Tests if retrieving mappings of assets and time coverage is supported.
boolean	supportsAssetTemporalAssignment()	Tests if managing mappings of assets and time ocverage is supported.
boolean	supportsCompositionAdmin()	Tests if composition administration is supported.
boolean	supportsCompositionLookup()	Tests if composition lookup is supported.
boolean	supportsCompositionNotification()	Tests if composition notification is supported.
boolean	supportsCompositionQuery()	Tests if composition query is supported.
boolean	supportsCompositionRecordType(Type compositionRecordType)	Tests if a given composition record type is supported.
boolean	supportsCompositionRepository()	Tests if retrieval of composition to repository mappings is supported.
boolean	supportsCompositionRepositoryAssignment()	Tests if assigning composition to repository mappings is supported.
boolean	supportsCompositionSearch()	Tests if composition search is supported.
boolean	supportsCompositionSearchRecordType(Type compositionSearchRecordType)	Tests if a given composition search record type is supported.
boolean	supportsCompositionSmartRepository()	Tests if composition smart repository is supported.
boolean	supportsCoordinateType(Type coordinateType)	Tests if a given coordinate type is supported.
boolean	supportsRepositoryAdmin()	Tests if repository administration is supported.
boolean	supportsRepositoryBatch()	Tests if a repository batch service is supported.
boolean	supportsRepositoryHierarchy()	Tests if a repository hierarchy traversal is supported.
boolean	supportsRepositoryHierarchyDesign()	Tests if a repository hierarchy design is supported.
boolean	supportsRepositoryLookup()	Tests if repository lookup is supported.
boolean	supportsRepositoryNotification()	Tests if repository notification is supported.
boolean	supportsRepositoryQuery()	Tests if repository query is supported.
boolean	supportsRepositoryRecordType(Type repositoryRecordType)	Tests if a given repository record type is supported.
boolean	supportsRepositoryRules()	Tests if a repository rules service is supported.
boolean	supportsRepositorySearch()	Tests if repository search is supported.
boolean	supportsRepositorySearchRecordType(Type repositorySearchRecordType)	Tests if a given repository search record type is supported.
boolean	supportsSpatialUnitRecordType(Type spatialUnitRecordType)	Tests if a given spatial unit record type is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsAssetLookup()} is {@code 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 {@code supportsAssetLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetQuery()} is {@code 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 {@code supportsAssetQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetSearch()} is {@code 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 {@code supportsAssetSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetAdmin()} is {@code 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 {@code supportsAssetAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetNotification()} is {@code 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 {@code supportsAssetNotfication()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetRepository()} is {@code 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 {@code supportsAssetRepositoryAssignment()} is {@code 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 {@code supportsAssetSmartRepository()} is {@code 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 {@code supportsAssetTemporal()} is {@code 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 {@code supportsAssetTemporal()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetTemporalAssignment()} is {@code 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 {@code supportsAssetTemporalAssignment()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSpatialAssets()} is {@code 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 {@code supportsAssetSpatial()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetSpatialAssignment()} is {@code 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 {@code supportsAssetSpatialAssignment()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAssetComposition()} is {@code 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 {@code supportsAssetCompositionDesign()} is {@code true} .

getAssetCompositionSessionForRepository

AssetCompositionSession getAssetCompositionSessionForRepository(Id repositoryId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

Gets the session for composing assets for the given repository.

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetCompositionSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetComposition() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetComposition()} and {@code supportsVisibleFederation()} are {@code true}

getAssetCompositionDesignSessionForRepository

AssetCompositionDesignSession getAssetCompositionDesignSessionForRepository(Id repositoryId,
 Proxy proxy)
                                                                     throws NotFoundException,
OperationFailedException

Gets the session for creating asset compositions for the given repository.

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetCompositionDesignSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetCompositionDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetCompositionDesign()} and {@code supportsVisibleFederation()} are {@code true}

getAssetContentLookupSession

AssetContentLookupSession getAssetContentLookupSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the asset content lookup service.

Parameters:

proxy - a proxy

Returns:

an AssetContentLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentLookup()} is {@code true} .

getAssetContentLookupSessionForRepository

AssetContentLookupSession getAssetContentLookupSessionForRepository(Id repositoryId,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetContentLookupSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentLookup()} and {@code supportsVisibleFederation()} are {@code true}

getAssetContentQuerySession

AssetContentQuerySession getAssetContentQuerySession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the asset content query service.

Parameters:

proxy - a proxy

Returns:

an AssetContentQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentQuery()} is {@code true} .

getAssetContentQuerySessionForRepository

AssetContentQuerySession getAssetContentQuerySessionForRepository(Id repositoryId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetContentQuerySession

Throws:

NotFoundException - no repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentQuery()} and {@code supportsVisibleFederation()} are {@code true}

getAssetContentSearchSession

AssetContentSearchSession getAssetContentSearchSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the asset content search service.

Parameters:

proxy - a proxy

Returns:

an AssetContentSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentSearch()} is {@code true} .

getAssetContentSearchSessionForRepository

AssetContentSearchSession getAssetContentSearchSessionForRepository(Id repositoryId,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the asset content search service for the given repository.

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetContentSearchSession

Throws:

NotFoundException - no repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentSearch()} and {@code supportsVisibleFederation()} are {@code true}

getAssetContentAdminSession

AssetContentAdminSession getAssetContentAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the asset content administration service.

Parameters:

proxy - a proxy

Returns:

an AssetContentAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentAdmin()} is {@code true} .

getAssetContentAdminSessionForRepository

AssetContentAdminSession getAssetContentAdminSessionForRepository(Id repositoryId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the asset content administration service for the given repository.

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetContentAdminSession

Throws:

NotFoundException - no repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getAssetContentNotificationSession

AssetContentNotificationSession getAssetContentNotificationSession(AssetContentReceiver assetContentReceiver,
 Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the asset content notification service.

Parameters:

assetContentReceiver - the notification callback

proxy - a proxy

Returns:

an AssetContentNotificationSession

Throws:

NullArgumentException - assetContentReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentNotification()} is {@code true} .

getAssetContentNotificationSessionForRepository

AssetContentNotificationSession getAssetContentNotificationSessionForRepository(AssetContentReceiver assetContentReceiver,
 Id repositoryId,
 Proxy proxy)
                                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the asset content notification service for the given repository.

Parameters:

assetContentReceiver - the notification callback

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetContentNotificationSession

Throws:

NotFoundException - no repository found by the given Id

NullArgumentException - assetContentReceiver , repositoryId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentNotification()} and {@code supportsVisibleFederation()} are {@code true}

getAssetContentRepositorySession

AssetContentRepositorySession getAssetContentRepositorySession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession to lookup asset content/repository mappings.

Parameters:

proxy - a proxy

Returns:

an AssetContentRepositorySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentRepository() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentRepository()} is {@code true} .

getAssetContentRepositoryAssignmentSession

AssetContentRepositoryAssignmentSession getAssetContentRepositoryAssignmentSession(Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with assigning asset contents to repositories.

Parameters:

proxy - a proxy

Returns:

an AssetContentRepositoryAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentRepositoryAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentRepositoryAssignment()} is {@code true} .

getAssetContentSmartRepositorySession

AssetContentSmartRepositorySession getAssetContentSmartRepositorySession(Id repositoryId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage asset content smart repositories.

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

an AssetContentSmartRepositorySession

Throws:

NotFoundException - no repository found by the given Id

NullArgumentException - repositoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssetContentSmartRepository() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetContentSmartRepository()} is {@code 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 {@code supportsCompositionLookup()} is {@code 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 {@code supportsCompositionLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionQuery()} is {@code 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 {@code supportsCompositionQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionSearch()} is {@code 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 {@code supportsCompositionSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionAdmin()} is {@code true} .

getCompositionAdminSessionForRepository

CompositionAdminSession getCompositionAdminSessionForRepository(Id repositoryId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

Gets a composition 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 {@code supportsCompositionAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionNotification()} is {@code 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 {@code supportsCompositionNotfication()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionRepository()} is {@code 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 {@code supportsCompositionRepositoryAssignment()} is {@code 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 {@code supportsCompositionSmartRepository()} is {@code 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 {@code supportsRepositoryLookup()} is {@code 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 {@code supportsRepositoryQuery()} is {@code 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 {@code supportsRepositorySearch()} is {@code 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 {@code supportsRepositoryAdmin()} is {@code 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 {@code supportsRepositoryNotification()} is {@code 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 {@code supportsRepositoryHierarchy()} is {@code 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 {@code supportsRepositoryHierarchyDesign()} is {@code 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 {@code supportsRepositoryBatch()} is {@code 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 {@code supportsRepositoryRules()} is {@code true} .