InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IAMSystemProvider Class Referenceabstract

#include <IAMSystemProvider.h>

Inheritance diagram for IAMSystemProvider:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IAMSYSTEMPROVIDER }
 

Public Member Functions

virtual IAssetMonitorGetAssetMonitor ()=0
 
virtual IAMServiceProviderGetServiceProvider ()=0
 
virtual IAMUIServiceProviderGetUIServiceProvider ()=0
 
virtual ErrorCode Init ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

The IAMSystemProvider provides the components for an asset management system.

Member Function Documentation

virtual IAssetMonitor* IAMSystemProvider::GetAssetMonitor ()
pure virtual

This method retrieves the IAssetMonitor instance if it exists.

Returns
a valid pointer or nil if the AMSP does not support asset monitoring.
virtual IAMServiceProvider* IAMSystemProvider::GetServiceProvider ()
pure virtual

This method retrieves the IAMServiceProvider.

Returns
a valid pointer or nil (it is unlikely that a useful AMSP will not have an IAMServiceProvider).
virtual IAMUIServiceProvider* IAMSystemProvider::GetUIServiceProvider ()
pure virtual

This method retrieves the IAMUIServiceProvider if it exists.

Returns
a valid pointer or nil if the AMSP does not handle UI.
virtual ErrorCode IAMSystemProvider::Init ()
pure virtual

The Init() method performs any initialization required by the IAMSystemProvider. This method must be called before calling any other method.

Returns
a failure ErrorCode if there was an initialization error; otherwise, this method should return kSuccess.