CScriptRequestData Class Reference

Inheritance diagram for CScriptRequestData:

Public Member Functions
	CScriptRequestData (IPMUnknown *boss)
virtual ErrorCode	InsertRequestData (const ScriptID dataLocation, const ScriptData &data)
virtual ErrorCode	InsertRequestData (const ScriptRecordData &record)
virtual ErrorCode	ExtractRequestData (const ScriptID dataLocation, ScriptData &data) const
virtual bool16	HasRequestData (const ScriptID dataLocation) const
virtual ScriptRecordData	GetRequestData () const
virtual void	ClearReturnData (const IScript *target)
virtual void	ClearReturnData (const ScriptList &targets)
virtual void	AppendReturnData (const IScript *target, const ScriptID requestID, const ErrorCode errorCode)
virtual void	AppendReturnData (const ScriptList &targets, const ScriptID requestID, const ErrorCode errorCode)
virtual void	AppendReturnData (const IScript *target, const ScriptID requestID, const ScriptData &returnValue)
virtual void	AppendReturnData (const ScriptList &targets, const ScriptID requestID, const ScriptData &returnValue)
virtual void	AppendReturnData (const IScript *target, const ScriptReturnData &data)
virtual void	AppendReturnData (const ScriptList &targets, const ScriptReturnData &data)
virtual void	ReplaceReturnData (const IScript *target, const ScriptReturnDataList &data)
virtual void	ReplaceReturnData (const ScriptList &targets, const ScriptReturnDataList &data)
virtual void	AppendReturnData (const IScript *target, const ScriptReturnDataList &data)
virtual void	AppendReturnData (const ScriptList &targets, const ScriptReturnDataList &data)
virtual uint32	GetNumReturnData (const IScript *target) const
virtual uint32	GetNumReturnData (const ScriptList &targets) const
virtual ScriptReturnData	GetNthReturnData (const IScript *target, uint32 n) const
virtual ScriptReturnData	GetNthReturnData (const ScriptList &targets, uint32 n) const
virtual ScriptReturnDataList	GetAllReturnData (const IScript *target) const
virtual ScriptReturnDataList	GetAllReturnData (const ScriptList &targets) const
virtual void	SetErrorPolicy (ErrorPolicy policy)
virtual ErrorPolicy	GetErrorPolicy () const
virtual void	SetSetPropertiesOrderPolicy (SetPropertiesOrderPolicy policy)
virtual SetPropertiesOrderPolicy	GetSetPropertiesOrderPolicy () const
virtual void	SetTargetInfo (const ScriptElementID objectID)
virtual void	SetTargetInfo (const ObjectScriptElement *pObject)
virtual const ObjectScriptElement *	GetTargetInfo () const
virtual const ScriptID	GetDesiredType () const
virtual RequestType	GetRequestType () const
virtual const ScriptElement *	GetRequestInfo () const
virtual void	SetMethod (const ScriptElementID methodID)
virtual void	SetMethod (const MethodScriptElement *pMethod)
virtual bool16	IsMethod () const
virtual void	SetMethodWithProperties (bool16 withProperties)
virtual bool16	IsMethodWithProperties () const
virtual void	SetPropertyGet (const ScriptElementID propID)
virtual void	SetPropertyGet (const PropertyScriptElement *pProp)
virtual bool16	IsPropertyGet () const
virtual void	SetPropertyPut (const ScriptElementID propID)
virtual void	SetPropertyPut (const PropertyScriptElement *pProp)
virtual bool16	IsPropertyPut () const
virtual void	SetFindCollection (const ScriptElementID objID)
virtual void	SetFindCollection (const ObjectScriptElement *pObj)
virtual bool16	IsFindCollection () const
virtual void	SetGetObject (const ScriptElementID objID, SpecifierForm accessorForm, const ScriptData &accessorData)
virtual void	SetGetObject (const ObjectScriptElement *pObj, SpecifierForm accessorForm, const ScriptData &accessorData)
virtual bool16	IsGetObject () const
virtual SpecifierForm	GetAccessorForm () const
virtual ScriptData	GetAccessorData () const
virtual void	SetTargetHandlingPolicy (TargetHandlingPolicy policy)
virtual TargetHandlingPolicy	GetTargetHandlingPolicy () const
virtual void	SetRequestedDataType (const ScriptID requestedType)
virtual const ScriptID	GetRequestedDataType () const
virtual void	SetFormTestCaseSensitive (bool16 caseSensitive)
virtual bool16	GetFormTestCaseSensitive () const
virtual const EngineContext &	GetRequestContext () const
virtual void	SetRequestContext (const EngineContext &context)
virtual void	CloneRequestData (IScriptRequestData *other) const
virtual void	Reset ()
virtual void	Release () const
Public Member Functions inherited from CPMUnknown< IScriptRequestData >
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 Member Functions
virtual const ScriptRecordData &	InternalGetRequestData () const
Protected Member Functions inherited from CPMUnknown< IScriptRequestData >
	CPMUnknown (IPMUnknown *boss)

Additional Inherited Members
Public Types inherited from IScriptRequestData
enum	{ kDefaultIID = IID_ISCRIPTREQUESTDATA }
enum	RequestType {   kUnknownRequest, kMethodRequest, kGetPropertyRequest, kPutPropertyRequest,   kGetObjectRequest, kFindCollectionRequest }
enum	TargetHandlingPolicy { kDefault, kIndividually, kCollectively }
Static Public Member Functions inherited from IScriptRequestData
static ScriptListData	ConvertToScriptListData (const ScriptReturnDataList &srdl)
static ScriptRecordData	ConvertToScriptRecordData (const ScriptReturnDataList &srdl)
Protected Attributes inherited from CPMUnknown< IScriptRequestData >
HelperInterface	fHelperInterface

Member Function Documentation

virtual void CScriptRequestData::AppendReturnData ( const IScript *  target, const ScriptID  requestID, const ErrorCode  errorCode  )

virtual

Append one item of return data for a particular target - the target (must be non-nil)

Implements IScriptRequestData.

virtual void CScriptRequestData::AppendReturnData ( const IScript *  target, const ScriptReturnDataList &  data  )

virtual

Append multiple items of return data for a particular target - the target (must be non-nil)

Implements IScriptRequestData.

virtual void CScriptRequestData::AppendReturnData ( const ScriptList &  targets, const ScriptReturnDataList &  data  )

virtual

Append multiple items of return data for a particular set of targets - the targets (must be 1 or more)

Implements IScriptRequestData.

virtual void CScriptRequestData::ClearReturnData ( const IScript *  target )

virtual

Clear all return data for a particular target - the target (must be non-nil)

Implements IScriptRequestData.

virtual void CScriptRequestData::ClearReturnData ( const ScriptList &  targets )

virtual

Clear all return data for a particular set of targets - the targets (must be 1 or more)

Implements IScriptRequestData.

virtual void CScriptRequestData::CloneRequestData ( IScriptRequestData *  other ) const

virtual

Copy this request data into another request data interface

Implements IScriptRequestData.

virtual ErrorCode CScriptRequestData::ExtractRequestData ( const ScriptID  dataLocation, ScriptData &  data  ) const

virtual

Extract data out of the script request

Parameters

dataLocation	is the key that specifies the desired parameter
data	is the extracted data

Implements IScriptRequestData.

virtual ScriptData CScriptRequestData::GetAccessorData ( ) const

virtual

Retrieve accessor data for a get objects request.

Implements IScriptRequestData.

virtual SpecifierForm CScriptRequestData::GetAccessorForm ( ) const

virtual

Retrieve accessor form for a get objects request.

Implements IScriptRequestData.

virtual const ScriptID CScriptRequestData::GetDesiredType ( ) const

virtual

For a get object or find collection request, equivalent to GetRequestInfo()->GetScriptID(). For all other requests, equivalent to GetTargetInfo()->GetScriptID().

Implements IScriptRequestData.

virtual uint32 CScriptRequestData::GetNumReturnData ( const IScript *  target ) const

virtual

Retrieve the return data for a particular target - the target (must be non-nil)

Implements IScriptRequestData.

virtual const EngineContext& CScriptRequestData::GetRequestContext ( ) const

virtual

Access to the request context for this request

Implements IScriptRequestData.

virtual ScriptRecordData CScriptRequestData::GetRequestData ( ) const

virtual

Access to all the request data

Implements IScriptRequestData.

virtual const ScriptElement* CScriptRequestData::GetRequestInfo ( ) const

virtual

Returns the request

Implements IScriptRequestData.

virtual RequestType CScriptRequestData::GetRequestType ( ) const

virtual

Returns the request type

Implements IScriptRequestData.

virtual const ObjectScriptElement* CScriptRequestData::GetTargetInfo ( ) const

virtual

Retrieve the object at which this request is targeted.

Implements IScriptRequestData.

virtual bool16 CScriptRequestData::HasRequestData ( const ScriptID  dataLocation ) const

virtual

Returns kTrue if there is request data at the specified location

Parameters

dataLocation

is the key that specifies the desired parameter

Implements IScriptRequestData.

virtual ErrorCode CScriptRequestData::InsertRequestData ( const ScriptID  dataLocation, const ScriptData &  data  )

virtual

Insert request data

Implements IScriptRequestData.

virtual ErrorCode CScriptRequestData::InsertRequestData ( const ScriptRecordData &  record )

virtual

Insert all of the data from a ScriptRecordData into the request data

Parameters

record

is the list of data to insert

Implements IScriptRequestData.

virtual const ScriptRecordData& CScriptRequestData::InternalGetRequestData ( ) const

protectedvirtual

Override in subclass if you need to translate client-specific request data before request data is accessed. Return const& internally for performance.

virtual bool16 CScriptRequestData::IsFindCollection ( ) const

virtual

Returns kTrue if this request is to find a collection.

Implements IScriptRequestData.

virtual bool16 CScriptRequestData::IsGetObject ( ) const

virtual

Returns kTrue if this request is to get objects.

Implements IScriptRequestData.

virtual bool16 CScriptRequestData::IsMethod ( ) const

virtual

Returns kTrue if this request is to handle a method.

Implements IScriptRequestData.

virtual bool16 CScriptRequestData::IsPropertyGet ( ) const

virtual

Returns kTrue if this request is to get a property.

Implements IScriptRequestData.

virtual bool16 CScriptRequestData::IsPropertyPut ( ) const

virtual

Returns kTrue if this request is to set a property.

Implements IScriptRequestData.

virtual void CScriptRequestData::Release ( ) const

virtual

Decrease the ref count by one. Every call to QueryInterface or AddRef must be matched by a call to Release. Usually you do not need to call either QueryInterface or Release directly; this is something that InterfacePtr will do for you.

Implements IPMUnknown.

virtual void CScriptRequestData::ReplaceReturnData ( const IScript *  target, const ScriptReturnDataList &  data  )

virtual

Replace all return data for a particular target - the target (must be non-nil)

Implements IScriptRequestData.

virtual void CScriptRequestData::ReplaceReturnData ( const ScriptList &  targets, const ScriptReturnDataList &  data  )

virtual

Replace all return data for a particular set of targets - the targets (must be 1 or more)

Implements IScriptRequestData.

virtual void CScriptRequestData::SetErrorPolicy ( ErrorPolicy  policy )

virtual

Access to the error policy for handling multiple requests.

Implements IScriptRequestData.

virtual void CScriptRequestData::SetFindCollection ( const ScriptElementID  objID )

virtual

Set if the request is to find a collection. May be retrieved via GetRequestInfo().

Implements IScriptRequestData.

virtual void CScriptRequestData::SetFormTestCaseSensitive ( bool16  caseSensitive )

virtual

Indicates whether to ignore case when comparing strings. Note: The value of this option is not currently honored.

Implements IScriptRequestData.

virtual void CScriptRequestData::SetGetObject ( const ScriptElementID  objID, SpecifierForm  accessorForm, const ScriptData &  accessorData  )

virtual

Set if the request is to get objects.

Parameters

objID/pObj	is the object to get. May be retrieved via GetRequestInfo().
accessorForm	is the key specifying which objects to get
accessorData	is the additional data required by some specifiers

Implements IScriptRequestData.

virtual void CScriptRequestData::SetMethod ( const ScriptElementID  methodID )

virtual

Set if the request is to handle a method. May be retrieved via GetRequestInfo().

Implements IScriptRequestData.

virtual void CScriptRequestData::SetMethodWithProperties ( bool16  withProperties )

virtual

Indicates whether a method that creates an object includes data to initialize its properties

Implements IScriptRequestData.

virtual void CScriptRequestData::SetPropertyGet ( const ScriptElementID  propID )

virtual

Set if the request is to get a property. May be retrieved via GetRequestInfo().

Implements IScriptRequestData.

virtual void CScriptRequestData::SetPropertyPut ( const ScriptElementID  propID )

virtual

Set if the request is to set a property. May be retrieved via GetRequestInfo().

Implements IScriptRequestData.

virtual void CScriptRequestData::SetRequestContext ( const EngineContext &  context )

virtual

Called during creation of the interface to set the request context for the request

Implements IScriptRequestData.

virtual void CScriptRequestData::SetRequestedDataType ( const ScriptID  requestedType )

virtual

The format in which to return a result.

Implements IScriptRequestData.

virtual void CScriptRequestData::SetSetPropertiesOrderPolicy ( SetPropertiesOrderPolicy  policy )

virtual

Access to the policy for the order to set properties when setting multiple properties at once

Implements IScriptRequestData.

virtual void CScriptRequestData::SetTargetInfo ( const ScriptElementID  objectID )

virtual

Set the object at which a request is targeted. For a regular method or property request, the target is the object being manipulated. For a method request on a collection, the target is the object being counted or created (not the parent). For a get object or find collection request, the target is the parent.

Implements IScriptRequestData.