org.osid.installation

Interface InstallationProxyManager

All Superinterfaces:

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

public interface InstallationProxyManager
extends OsidProxyManager, InstallationProfile

The installation manager provides access to package installation sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from server environments. The sessions included in this manager are:

• InstallationLookupSession: a session to look up local installations
• InstallationQuerySession: a session to query local installations
• InstallationSearchSession: a session to search local installations
• InstallationManagementSession: a session to install and remove packages
• InstallationUpdateSession: a session to get package updates
• InstallationNotificationSession a session for subscribing to new or deleted installations
• SiteLookupSession: a session for listing installation sites

• PackageLookupSession: a session to look up packages
• PackageQuerySession: a session to query packages
• PackageSearchSession: a session to search packages
• PackageAdminSession: a session to create, modify and delete packages
• PackageNotificationSession: a session to receive messages pertaining to package changes
• PackageDepotSession: a session for retrieving package and depot mappings
• PackageDepotAssignmentSession: a session for managing package and depot mappings
• PackageSmartDepotSession: a session for managing smart depots of packages

• DepotLookupSession: a session to lookup depots
• DepotQuerySession: a session to query depots
• DepotSearchSession : a session to search depots
• DepotAdminSession : a session to create, modify and delete depots
• DepotNotificationSession : a session to receive messages pertaining to depot changes
• DepotHierarchySession: a session to traverse the depot hierarchy
• DepotHierarchyDesignSession: a session to manage the depot hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
DepotAdminSession	getDepotAdminSession(Proxy proxy) Gets the OsidSession associated with the depot administration service.
DepotHierarchyDesignSession	getDepotHierarchyDesignSession(Proxy proxy) Gets the session designing depot hierarchies.
DepotHierarchySession	getDepotHierarchySession(Proxy proxy) Gets the session traversing depot hierarchies.
DepotLookupSession	getDepotLookupSession(Proxy proxy) Gets the OsidSession associated with the depot lookup service.
DepotNotificationSession	getDepotNotificationSession(DepotReceiver depotReceiver, Proxy proxy) Gets the notification session for notifications pertaining to depot service changes.
DepotQuerySession	getDepotQuerySession(Proxy proxy) Gets the depot query session.
DepotSearchSession	getDepotSearchSession(Proxy proxy) Gets the OsidSession associated with the depot search service.
InstallationBatchProxyManager	getInstallationBatchProxyManager() Gets an InstallationBatchProxyManager.
InstallationLookupSession	getInstallationLookupSession(Proxy proxy) Gets the OsidSession associated with the installation lookup service.
InstallationLookupSession	getInstallationLookupSessionForSite(Id siteId, Proxy proxy) Gets the OsidSession associated with the installation lookup service for the given site.
InstallationManagementSession	getInstallationManagementSession(Proxy proxy) Gets the OsidSession associated with the installation management service.
InstallationManagementSession	getInstallationManagementSessionForSite(Id siteId, Proxy proxy) Gets the OsidSession associated with the installation management service for the given site.
InstallationNotificationSession	getInstallationNotificationSession(InstallationReceiver installationReceiver, Proxy proxy) Gets the notification session for notifications pertaining to installation changes.
InstallationNotificationSession	getInstallationNotificationSessionForSite(InstallationReceiver installationReceiver, Id siteId, Proxy proxy) Gets the OsidSession associated with the installation notification service for the given site.
InstallationQuerySession[]	getInstallationQuerySession(Proxy proxy) Gets the OsidSession associated with the installation query service.
InstallationQuerySession[]	getInstallationQuerySessionForSite(Id siteId, Proxy proxy) Gets the OsidSession associated with the installation query service for the given site.
InstallationSearchSession	getInstallationSearchSession(Proxy proxy) Gets the OsidSession associated with the installation search service.
InstallationSearchSession	getInstallationSearchSessionForSite(Id siteId, Proxy proxy) Gets the OsidSession associated with the installation search service for the given site.
InstallationUpdateSession	getInstallationUpdateSession(Proxy proxy) Gets the OsidSession associated with the installation update service.
InstallationUpdateSession	getInstallationUpdateSessionForSite(Id siteId, Proxy proxy) Gets the OsidSession associated with the installation update service for the given site.
PackageAdminSession	getPackageAdminSession(Proxy proxy) Gets the OsidSession associated with the package administration service.
PackageAdminSession	getPackageAdminSessionForDepot(Id depotId, Proxy proxy) Gets the OsidSession associated with the package admin service for the given depot.
PackageDepotSession	getPackageDepotAssignmentSession(Proxy proxy) Gets the session for assigning package to depot mappings.
PackageDepotSession	getPackageDepotSession(Proxy proxy) Gets the session for retrieving package to depot mappings.
PackageLookupSession	getPackageLookupSession(Proxy proxy) Gets the OsidSession associated with the package lookup service.
PackageLookupSession	getPackageLookupSessionForDepot(Id depotId, Proxy proxy) Gets the OsidSession associated with the package lookup service for the given depot.
PackageNotificationSession	getPackageNotificationSession(PackageReceiver packageReceiver, Proxy proxy) Gets the notification session for notifications pertaining to package changes.
PackageNotificationSession	getPackageNotificationSessionForDepot(PackageReceiver packageReceiver, Id depotId, Proxy proxy) Gets the OsidSession associated with the package notification service for the given depot.
PackageQuerySession	getPackageQuerySession(Proxy proxy) Gets the OsidSession associated with the package query service.
PackageQuerySession	getPackageQuerySessionForDepot(Id depotId, Proxy proxy) Gets the OsidSession associated with the package query service for the given depot.
PackageSearchSession	getPackageSearchSession(Proxy proxy) Gets the OsidSession associated with the package search service.
PackageSearchSession	getPackageSearchSessionForDepot(Id depotId, Proxy proxy) Gets the OsidSession associated with the package search service for the given depot.
PackageSmartDepotSession	getPackageSmartDepotSession(Id depotId, Proxy proxy) Gets the session for managing dynamic package depot.
SiteLookupSession	getSiteLookupSession(Proxy proxy) Gets the OsidSession associated with the site lookup service.

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.installation.InstallationProfile

getDepotRecordTypes, getDepotSearchRecordTypes, getInstallationContentRecordTypes, getInstallationRecordTypes, getInstallationSearchRecordTypes, getPackageRecordTypes, getPackageSearchRecordTypes, getSiteRecordTypes, supportsDepotAdmin, supportsDepotHierarchy, supportsDepotHierarchyDesign, supportsDepotLookup, supportsDepotNotification, supportsDepotQuery, supportsDepotRecordType, supportsDepotSearch, supportsDepotSearchRecordType, supportsInstallationBatch, supportsInstallationContentRecordType, supportsInstallationLookup, supportsInstallationManagement, supportsInstallationNotification, supportsInstallationQuery, supportsInstallationRecordType, supportsInstallationSearch, supportsInstallationSearchRecordType, supportsInstallationUpdate, supportsPackageAdmin, supportsPackageDepot, supportsPackageDepotAssignment, supportsPackageLookup, supportsPackageNotification, supportsPackageQuery, supportsPackageRecordType, supportsPackageSearch, supportsPackageSearchRecordType, supportsPackageSmartDepot, supportsSiteLookup, supportsSiteRecordType, 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

getInstallationLookupSession

InstallationLookupSession getInstallationLookupSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the installation lookup service.

Parameters:

proxy - a proxy

Returns:

an InstallationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationLookup() is false

Compliance:

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

getInstallationLookupSessionForSite

InstallationLookupSession getInstallationLookupSessionForSite(Id siteId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the installation lookup service for the given site.

Parameters:

siteId - the Id of the site

proxy - a proxy

Returns:

an InstallationLookupSession

Throws:

NotFoundException - siteId not found

NullArgumentException - siteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationLookup() or supportsVisibleFederation() is false

Compliance:

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

getInstallationQuerySession

InstallationQuerySession[] getInstallationQuerySession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the installation query service.

Parameters:

proxy - a proxy

Returns:

an InstallationQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationQuery() is false

Compliance:

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

getInstallationQuerySessionForSite

InstallationQuerySession[] getInstallationQuerySessionForSite(Id siteId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the installation query service for the given site.

Parameters:

siteId - the Id of the site

proxy - a proxy

Returns:

an InstallationQuerySession

Throws:

NotFoundException - siteId not found

NullArgumentException - siteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationQuery() or supportsVisibleFederation() is false

Compliance:

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

getInstallationSearchSession

InstallationSearchSession getInstallationSearchSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the installation search service.

Parameters:

proxy - a proxy

Returns:

an InstallationSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationSearch() is false

Compliance:

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

getInstallationSearchSessionForSite

InstallationSearchSession getInstallationSearchSessionForSite(Id siteId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the installation search service for the given site.

Parameters:

siteId - the Id of the site

proxy - a proxy

Returns:

an InstallationSearchSession

Throws:

NotFoundException - siteId not found

NullArgumentException - siteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationSearch() or supportsVisibleFederation() is false

Compliance:

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

getInstallationManagementSession

InstallationManagementSession getInstallationManagementSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the installation management service.

Parameters:

proxy - a proxy

Returns:

an InstallationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationManagement() is false

Compliance:

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

getInstallationManagementSessionForSite

InstallationManagementSession getInstallationManagementSessionForSite(Id siteId,
                                                                    Proxy proxy)
                                                                      throws NotFoundException,
                                                                             OperationFailedException

Gets the OsidSession associated with the installation management service for the given site.

Parameters:

siteId - the Id of the site

proxy - a proxy

Returns:

an InstallationAdminSession

Throws:

NotFoundException - siteId not found

NullArgumentException - siteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationManagement() or supportsVisibleFederation() is false

Compliance:

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

getInstallationUpdateSession

InstallationUpdateSession getInstallationUpdateSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the installation update service.

Parameters:

proxy - a proxy

Returns:

an InstallationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationUpdate() is false

Compliance:

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

getInstallationUpdateSessionForSite

InstallationUpdateSession getInstallationUpdateSessionForSite(Id siteId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the installation update service for the given site.

Parameters:

siteId - the Id of the site

proxy - a proxy

Returns:

an InstallationUpdateSession

Throws:

NotFoundException - siteId not found

NullArgumentException - siteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationUpdate() or supportsVisibleFederation() is false

Compliance:

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

getInstallationNotificationSession

InstallationNotificationSession getInstallationNotificationSession(InstallationReceiver installationReceiver,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the notification session for notifications pertaining to installation changes.

Parameters:

installationReceiver - the installation receiver

proxy - a proxy

Returns:

an InstallationNotificationSession

Throws:

NullArgumentException - installationReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationNotification() is false

Compliance:

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

getInstallationNotificationSessionForSite

InstallationNotificationSession getInstallationNotificationSessionForSite(InstallationReceiver installationReceiver,
                                                                        Id siteId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the installation notification service for the given site.

Parameters:

installationReceiver - the installation receiver

siteId - the Id of the site

proxy - a proxy

Returns:

an InstallationNotificationSession

Throws:

NotFoundException - siteId not found

NullArgumentException - installationReceiver, siteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationNotification() or supportsVisibleFederation() is false

Compliance:

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

getSiteLookupSession

SiteLookupSession getSiteLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the site lookup service.

Parameters:

proxy - a proxy

Returns:

a SiteLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSiteLookup() is false

Compliance:

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

getPackageLookupSession

PackageLookupSession getPackageLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the package lookup service.

Parameters:

proxy - a proxy

Returns:

a PackageLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageLookup() is false

Compliance:

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

getPackageLookupSessionForDepot

PackageLookupSession getPackageLookupSessionForDepot(Id depotId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the package lookup service for the given depot.

Parameters:

depotId - the Id of the depot

proxy - a proxy

Returns:

a PackageLookupSession

Throws:

NotFoundException - depotId not found

NullArgumentException - depotId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageLookup() or supportsVisibleFederation() is false

Compliance:

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

getPackageQuerySession

PackageQuerySession getPackageQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the package query service.

Parameters:

proxy - a proxy

Returns:

a PackageQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageQuery() is false

Compliance:

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

getPackageQuerySessionForDepot

PackageQuerySession getPackageQuerySessionForDepot(Id depotId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the package query service for the given depot.

Parameters:

depotId - the Id of the Depot

proxy - a proxy

Returns:

a PackageQuerySession

Throws:

NotFoundException - no Depot found by the given Id

NullArgumentException - depotId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageQuery() or supportsVisibleFederation() is false

Compliance:

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

getPackageSearchSession

PackageSearchSession getPackageSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the package search service.

Parameters:

proxy - a proxy

Returns:

a PackageSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageSearch() is false

Compliance:

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

getPackageSearchSessionForDepot

PackageSearchSession getPackageSearchSessionForDepot(Id depotId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the package search service for the given depot.

Parameters:

depotId - the Id of the depot

proxy - a proxy

Returns:

a PackageSearchSession

Throws:

NotFoundException - depotId not found

NullArgumentException - depotId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageSearch() or supportsVisibleFederation() is false

Compliance:

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

getPackageAdminSession

PackageAdminSession getPackageAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the package administration service.

Parameters:

proxy - a proxy

Returns:

a PackageAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageAdmin() is false

Compliance:

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

getPackageAdminSessionForDepot

PackageAdminSession getPackageAdminSessionForDepot(Id depotId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the package admin service for the given depot.

Parameters:

depotId - the Id of the depot

proxy - a proxy

Returns:

a PackageAdminSession

Throws:

NotFoundException - depotId not found

NullArgumentException - depotId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPackageNotificationSession

PackageNotificationSession getPackageNotificationSession(PackageReceiver packageReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the notification session for notifications pertaining to package changes.

Parameters:

packageReceiver - the package receiver

proxy - a proxy

Returns:

a PackageNotificationSession

Throws:

NullArgumentException - packageReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageNotification() is false

Compliance:

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

getPackageNotificationSessionForDepot

PackageNotificationSession getPackageNotificationSessionForDepot(PackageReceiver packageReceiver,
                                                               Id depotId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the package notification service for the given depot.

Parameters:

packageReceiver - the package receiver

depotId - the Id of the depot

proxy - a proxy

Returns:

a PackageNotificationSession

Throws:

NotFoundException - depotId not found

NullArgumentException - packageReceiver, depotId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageNotification() or supportsVisibleFederation() is false

Compliance:

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

getPackageDepotSession

PackageDepotSession getPackageDepotSession(Proxy proxy)
                                           throws OperationFailedException

Gets the session for retrieving package to depot mappings.

Parameters:

proxy - a proxy

Returns:

a PackageDepotSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageDepot() is false

Compliance:

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

getPackageDepotAssignmentSession

PackageDepotSession getPackageDepotAssignmentSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the session for assigning package to depot mappings.

Parameters:

proxy - a proxy

Returns:

a PackageDepotAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageDepotAssignment() is false

Compliance:

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

getPackageSmartDepotSession

PackageSmartDepotSession getPackageSmartDepotSession(Id depotId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the session for managing dynamic package depot.

Parameters:

depotId - the Id of the depot

proxy - a proxy

Returns:

a PackageSmartDepotSession

Throws:

NotFoundException - depotId not found

NullArgumentException - depotId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPackageSmartDepot() is false

Compliance:

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

getDepotLookupSession

DepotLookupSession getDepotLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the depot lookup service.

Parameters:

proxy - a proxy

Returns:

a DepotLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotLookup() is false

Compliance:

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

getDepotQuerySession

DepotQuerySession getDepotQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the depot query session.

Parameters:

proxy - a proxy

Returns:

a DepotQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotQuery() is false

Compliance:

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

getDepotSearchSession

DepotSearchSession getDepotSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the depot search service.

Parameters:

proxy - a proxy

Returns:

a DepotSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotSearch() is false

Compliance:

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

getDepotAdminSession

DepotAdminSession getDepotAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the depot administration service.

Parameters:

proxy - a proxy

Returns:

a DepotAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotAdmin() is false

Compliance:

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

getDepotNotificationSession

DepotNotificationSession getDepotNotificationSession(DepotReceiver depotReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to depot service changes.

Parameters:

depotReceiver - the depot receiver

proxy - a proxy

Returns:

a DepotNotificationSession

Throws:

NullArgumentException - depotReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotNotification() is false

Compliance:

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

getDepotHierarchySession

DepotHierarchySession getDepotHierarchySession(Proxy proxy)
                                               throws OperationFailedException

Gets the session traversing depot hierarchies.

Parameters:

proxy - a proxy

Returns:

a DepotHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotHierarchy() is false

Compliance:

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

getDepotHierarchyDesignSession

DepotHierarchyDesignSession getDepotHierarchyDesignSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the session designing depot hierarchies.

Parameters:

proxy - a proxy

Returns:

a DepotHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDepotHierarchyDesign() is false

Compliance:

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

getInstallationBatchProxyManager

InstallationBatchProxyManager getInstallationBatchProxyManager()
                                                               throws OperationFailedException

Gets an InstallationBatchProxyManager.

Returns:

an InstallationBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstallationBatch() is false

Compliance:

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