IScriptRequestData Class Reference

#include <IScriptRequestData.h>

Inheritance diagram for IScriptRequestData:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTREQUESTDATA }
enum	RequestType {   kUnknownRequest, kMethodRequest, kGetPropertyRequest, kPutPropertyRequest,   kGetObjectRequest, kFindCollectionRequest }
enum	TargetHandlingPolicy { kDefault, kIndividually, kCollectively }

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

Static Public Member Functions
static ScriptListData	ConvertToScriptListData (const ScriptReturnDataList &srdl)
static ScriptRecordData	ConvertToScriptRecordData (const ScriptReturnDataList &srdl)

Detailed Description

Used to pass data into and out of a scripting request.

Member Enumeration Documentation

enum IScriptRequestData::RequestType

Script request types

enum IScriptRequestData::TargetHandlingPolicy

Used to express a preference for how a script provider should handle a request on multiple targets.

Member Function Documentation

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

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

Copy this request data into another request data interface

Implemented in CScriptRequestData.

static ScriptListData IScriptRequestData::ConvertToScriptListData ( const ScriptReturnDataList &  srdl )

inlinestatic

Convert the return data into a list of return values

static ScriptRecordData IScriptRequestData::ConvertToScriptRecordData ( const ScriptReturnDataList &  srdl )

inlinestatic

Convert the return data into a list of request ID/return value pairs

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

pure virtual

Extract data out of the script request

Parameters

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

Implemented in CScriptRequestData.

virtual ScriptData IScriptRequestData::GetAccessorData ( ) const

pure virtual

Retrieve accessor data for a get objects request.

Implemented in CScriptRequestData.

virtual SpecifierForm IScriptRequestData::GetAccessorForm ( ) const

pure virtual

Retrieve accessor form for a get objects request.

Implemented in CScriptRequestData.

virtual const ScriptID IScriptRequestData::GetDesiredType ( ) const

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

virtual const EngineContext& IScriptRequestData::GetRequestContext ( ) const

pure virtual

Access to the request context for this request

Implemented in CScriptRequestData.

virtual ScriptRecordData IScriptRequestData::GetRequestData ( ) const

pure virtual

Access to all the request data

Implemented in CScriptRequestData.

virtual const ScriptElement* IScriptRequestData::GetRequestInfo ( ) const

pure virtual

Returns the request

Implemented in CScriptRequestData.

virtual RequestType IScriptRequestData::GetRequestType ( ) const

pure virtual

Returns the request type

Implemented in CScriptRequestData.

virtual const ObjectScriptElement* IScriptRequestData::GetTargetInfo ( ) const

pure virtual

Retrieve the object at which this request is targeted.

Implemented in CScriptRequestData.

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

pure virtual

Returns kTrue if there is request data at the specified location

Parameters

dataLocation

is the key that specifies the desired parameter

Implemented in CScriptRequestData.

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

pure virtual

Insert request data

Implemented in CScriptRequestData.

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

pure virtual

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

Parameters

record

is the list of data to insert

Implemented in CScriptRequestData.

virtual bool16 IScriptRequestData::IsFindCollection ( ) const

pure virtual

Returns kTrue if this request is to find a collection.

Implemented in CScriptRequestData.

virtual bool16 IScriptRequestData::IsGetObject ( ) const

pure virtual

Returns kTrue if this request is to get objects.

Implemented in CScriptRequestData.

virtual bool16 IScriptRequestData::IsMethod ( ) const

pure virtual

Returns kTrue if this request is to handle a method.

Implemented in CScriptRequestData.

virtual bool16 IScriptRequestData::IsPropertyGet ( ) const

pure virtual

Returns kTrue if this request is to get a property.

Implemented in CScriptRequestData.

virtual bool16 IScriptRequestData::IsPropertyPut ( ) const

pure virtual

Returns kTrue if this request is to set a property.

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetErrorPolicy ( ErrorPolicy  policy )

pure virtual

Access to the error policy for handling multiple requests.

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetFindCollection ( const ScriptElementID  objID )

pure virtual

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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetFormTestCaseSensitive ( bool16  caseSensitive )

pure virtual

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

Implemented in CScriptRequestData.

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

pure 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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetMethod ( const ScriptElementID  methodID )

pure virtual

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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetMethodWithProperties ( bool16  withProperties )

pure virtual

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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetPropertyGet ( const ScriptElementID  propID )

pure virtual

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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetPropertyPut ( const ScriptElementID  propID )

pure virtual

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

Implemented in CScriptRequestData.

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

pure virtual

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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetRequestedDataType ( const ScriptID  requestedType )

pure virtual

The format in which to return a result.

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetSetPropertiesOrderPolicy ( SetPropertiesOrderPolicy  policy )

pure virtual

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

Implemented in CScriptRequestData.

virtual void IScriptRequestData::SetTargetInfo ( const ScriptElementID  objectID )

pure 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.

Implemented in CScriptRequestData.