CProxyScript Class Reference

Inheritance diagram for CProxyScript:

Public Member Functions
	CProxyScript (IPMUnknown *boss)
virtual ScriptID	GetObjectType (const RequestContext &context) const
virtual void	SetObjectType (const ScriptID &objectType, const RequestContext &context)
virtual IDataBase *	GetDataBase (const RequestContext &context) const
virtual ScriptObject	GetScriptObject (const RequestContext &context) const
virtual IPMUnknown *	QueryParent (const PMIID &iid, const RequestContext &context) const
virtual bool16	HasBeenDeleted (const RequestContext &context)
virtual bool16	IsEqual (const IScript *script, const RequestContext &context) const
virtual void	SetTag (const ScriptLabelKey &key, const ScriptLabelValue &value)
Public Member Functions inherited from CScript
	CScript (IPMUnknown *boss)
virtual bool16	IsObjectType (const ScriptID &type, const RequestContext &context) const
virtual bool16	IsObjectType (const ScriptElementID &type, const RequestContext &context) const
virtual const ObjectScriptElement *	GetObjectInfo (const RequestContext &context) const
virtual void	RegisterClientObject (ScriptClientObject *clientObject)
virtual void	UnregisterClientObject (ScriptClientObject *clientObject)
virtual void	NotifyClientObjectsToReleaseMe ()
virtual void	SetTag (const ScriptLabelValue &string)
virtual ScriptLabelValue	GetTag () const
virtual ScriptLabelValue	GetTag (const ScriptLabelKey &key) const
virtual void	SetTags (const ScriptLabelKeyValueList &labels)
virtual ScriptLabelKeyValueList	GetTags () const
virtual void	ClearTags ()
virtual void	ReadWrite (IPMStream *s, ImplementationID prop)
Public Member Functions inherited from CPMUnknown< IScript >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Protected Attributes
ScriptID	fObjectType

Additional Inherited Members
Public Types inherited from IScript
enum	{ kDefaultIID = IID_ISCRIPT }
Static Public Attributes inherited from IScriptLabel
static ScriptLabelKey	kDefaultScriptLabelKey
Protected Member Functions inherited from CPMUnknown< IScript >
	CPMUnknown (IPMUnknown *boss)

Member Function Documentation

virtual IDataBase* CProxyScript::GetDataBase ( const RequestContext &  context ) const

virtual

A safe way to determine the appropriate database for this object. Most implementations can simply inherit and use the default implementation { return ::GetDataBase( this ) ; } but some script bosses are non-persistent, and should therefore override this method.

Reimplemented from CScript.

Reimplemented in SnpRunnableScript.

virtual ScriptID CProxyScript::GetObjectType ( const RequestContext &  context ) const

virtual

Return the object's type

Implements CScript.

virtual ScriptObject CProxyScript::GetScriptObject ( const RequestContext &  context ) const

virtual

Return specifier information for this object

Reimplemented from CScript.

Reimplemented in SnpRunnableScript, and PrefsScript.

virtual bool16 CProxyScript::HasBeenDeleted ( const RequestContext &  context )

virtual

Return kTrue if the underlying object that this script object represents has been deleted

Reimplemented from CScript.

Reimplemented in CdlStockScript.

virtual bool16 CProxyScript::IsEqual ( const IScript *  script, const RequestContext &  context  ) const

virtual

Return kTrue if the passed in object is (or represents) the same object

Reimplemented from CScript.

virtual IPMUnknown* CProxyScript::QueryParent ( const PMIID &  iid, const RequestContext &  context  ) const

virtual

Return the parent of this object in the script hierarchy

Implements CScript.

virtual void CProxyScript::SetObjectType ( const ScriptID &  objectType, const RequestContext &  context  )

virtual

Most objects know what type they are. But when supporting generic objects, there are cases where 1) the object can be interpreted as different types and/or 2) it is expensive to constantly figure out what type the object is, so we provide a way for the object to be told what type it is.

Reimplemented from CScript.

virtual void CProxyScript::SetTag ( const ScriptLabelKey &  key, const ScriptLabelValue &  value  )

virtual

Set a user-definable label. NOTE: Since proxy objects are temporary, if you want to set a label on a proxy object, you must override the default implementation in order to transfer the label onto a persistent object!

Parameters

key	is the key
value	is the value

Reimplemented from CScript.