IAMUIEnablementRules Class Reference

#include <IAMUIEnablementRules.h>

Inheritance diagram for IAMUIEnablementRules:

Public Types
enum	{ kDefaultIID = IID_IAMUIENABLEMENTRULES }
enum	WGUICommandID {   enInvalidCommandID = 0, enDisplayVersions = kWorkgroupPrefix + 1, enSaveVersion = kWorkgroupPrefix + 2, enRevertToProject = kWorkgroupPrefix + 3,   enCheckOut = kWorkgroupPrefix + 4, enCheckIn = kWorkgroupPrefix + 5, enCancelCheckOut = kWorkgroupPrefix + 6 }

Public Member Functions
virtual bool16	IsCommandEnabled (int32 commandID, UIDRef assetRef, UIDRef itemRef)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

The IAMUIEnablementRules interface is responsible for handling the rules that enable commands that are invoked through the User Interface.

Developer hint: implementations of this interface may find it useful to incorporate the use of the IAMService::VerifyContext() method into the rules logic.

Member Enumeration Documentation

enum IAMUIEnablementRules::WGUICommandID

The WGUICommandID enum defines the UI commands that are tested for enablement.

Member Function Documentation

virtual bool16 IAMUIEnablementRules::IsCommandEnabled ( int32  commandID, UIDRef  assetRef, UIDRef  itemRef  )

pure virtual

This method invokes the enablement rule.

Parameters

commandID	is a predefined WGUICommandID or any unique integer (when called by one of the public workgroup facades, this will always be a WGUICommandID).
assetRef	is a UIDRef of a boss that aggregates the IManageableAsset interface.
itemRef	is a UIDRef of a model boss associated with the IManageableAsset.

See Also

IManageableAsset.