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

#include <IAssetStateMachine.h>

Inheritance diagram for IAssetStateMachine:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IASSETSTATEMACHINE }
 

Public Member Functions

virtual void InitializeState (IManagedStatus *managedStatus, UID objectUID=kInvalidUID)=0
 
virtual void HandleStateChange (IManagedStatus *managedStatus, UID objectUID=kInvalidUID, bool useCachedData=false)=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 IAssetStateMachine encapsulates the rules for handling asset status changes. This interface represents a convenient abstraction for consolidating the rules for status processing into a single class. Using and providing an implementation for this interface is optional.

Member Function Documentation

virtual void IAssetStateMachine::HandleStateChange (IManagedStatusmanagedStatus,
UID objectUID = kInvalidUID,
bool useCachedData = false 
)
pure virtual

This method processes state changes for an IManagedStatus instance. Suggested usage: called by the IAssetMonitor HandleChangesCmd.

Parameters
managedStatusis a valid pointer to an IManagedStatus instance.
objectUIDis the UID of the document model object associated with the IManagedStatus.
useCachedDatais a control flag; when true, cached status data can be used to handle the state change.
See Also
IManagedStatus.
IAssetMonitor.
virtual void IAssetStateMachine::InitializeState (IManagedStatusmanagedStatus,
UID objectUID = kInvalidUID 
)
pure virtual

This method initializes the state of an IManagedStatus instance. Suggested usage: called during the IAMServiceProvider::enInitialize service.

Parameters
managedStatusis a valid pointer to an IManagedStatus instance.
objectUIDis the UID of the document model object associated with the IManagedStatus.
See Also
IManagedStatus.
IAMServiceProvider.