#include <IAMServiceData.h>

Inheritance diagram for IAMServiceData:

Public Types
enum	{ kDefaultIID = IID_IAMSERVICEDATA }

typedef std::vector< IDFile >	IDFileList

typedef std::vector< UIDRef >	UIDRefList

Public Member Functions
virtual bool16	Get (int32 dataID, IDFile &outFile) const =0

virtual bool16	Get (int32 dataID, int32 &outInt32) const =0

virtual void *	Get (int32 dataID) const =0

virtual bool16	Get (int32 dataID, PMString &outPMString) const =0

virtual bool16	Get (int32 dataID, UIDRef &outUIDRef) const =0

virtual bool16	Get (int32 dataID, UIFlags &outUiFlags) const =0

virtual bool16	Get (int32 dataID, IAMUIService::FollowupAction &outAction) const =0

virtual bool16	Get (IAMServiceData::UIDRefList &outUIDRefList)=0

virtual bool16	Get (IAMServiceData::IDFileList &outIDFileList)=0

virtual bool16	GetFlag (int32 dataID) const =0

virtual void	Set (int32 dataID, const IDFile &inFile)=0

virtual void	Set (int32 dataID, int32 inInt32)=0

virtual void	Set (int32 dataID, void *inInterface)=0

virtual void	Set (int32 dataID, const PMString &inPMString)=0

virtual void	Set (int32 dataID, const UIDRef &inUIDRef)=0

virtual void	Set (int32 dataID, UIFlags inUIFlags)=0

virtual void	Set (int32 dataID, IAMUIService::FollowupAction inAction)=0

virtual void	Set (const IAMServiceData::UIDRefList &inUIDRefList)=0

virtual void	Set (const IAMServiceData::IDFileList &inIDFileList)=0

virtual void	SetFlag (int32 dataID, bool16 b=kTrue)=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 IAMServiceData interface exchanges parameters with IAMService or IAMUIService implementations. The accessors ("Get" methods) and mutators ("Set" methods) of the interface handle the most the commonly used data types. Parameters are identified by specifying a predefined data identifier (dataID) which serves as the key. Predefined data identifiers used by InDesign/InCopy/InDesignServer are defined in IAMService.h and IAMUIService.h. The data type that a particular data identifier is mapped to is determined by the IAMService implementation. For example, "IAMService::enTargetAsset" could refer to a UIDRef, IDFile, or vector of IDFiles. See IAMServiceProvider.h for the currently used mappings.

With the exception of the GetFlag() and Get void * accessors, all of the accessors return kTrue if the parameter could be found, and kFalse otherwise.

See Also: IAMService.; IAMUIService.; IAMServiceProvider.

Member Function Documentation

virtual bool16 IAMServiceData::Get	(	int32	dataID,
		IDFile &	outFile
	)		const

pure virtual

Retrieves a service data parameter of type IDFile.

Parameters

dataID	is a unique key to identify the data.
outFile	will be populated with the IDFile.

Returns: kTrue if the data was found; kFalse otherwise.

virtual bool16 IAMServiceData::Get	(	int32	dataID,
		int32 &	outInt32
	)		const

pure virtual

Retrieves a service data parameter of type int32.

Parameters

dataID	is a unique key to identify the data.
outInt32	will be populated with the int32.

Returns: kTrue if the data was found; kFalse otherwise.

virtual void* IAMServiceData::Get ( int32 dataID ) const

pure virtual

Retrieves a service data parameter of type void *.

Parameters

dataID is a unique key to identify the pointer data.

Returns: non-nil void * pointer if the data was found; nil otherwise.

virtual bool16 IAMServiceData::Get	(	int32	dataID,
		PMString &	outPMString
	)		const

pure virtual

Retrieves a service data parameter of type PMString.

Parameters

dataID	is a unique key to identify the data.
outPMString	will be populated with the PMString.

Returns: kTrue if the data was found; kFalse otherwise.

virtual bool16 IAMServiceData::Get	(	int32	dataID,
		UIDRef &	outUIDRef
	)		const

pure virtual

Retrieves a service data parameter of type UIDRef.

Parameters

dataID	is a unique key to identify the data.
outUIDRef	will be populated with the UIDRef.

Returns: kTrue if the data was found; kFalse otherwise.

virtual bool16 IAMServiceData::Get	(	int32	dataID,
		UIFlags &	outUiFlags
	)		const

pure virtual

Retrieves a service data parameter of type UIFlags.

Parameters

dataID	is a unique key to identify the data.
outUiFlags	will be populated with the UIFlags.

Returns: kTrue if the data was found; kFalse otherwise.

virtual bool16 IAMServiceData::Get	(	int32	dataID,
		IAMUIService::FollowupAction &	outAction
	)		const

pure virtual

Retrieves a service data parameter of type IAMUIService::FollowupAction.

Parameters

dataID	is a unique key to identify the data.
outAction	will be populated with the IAMUIService::FollowupAction.

Returns: kTrue if the data was found; kFalse otherwise.

virtual bool16 IAMServiceData::Get ( IAMServiceData::UIDRefList & outUIDRefList )

pure virtual

Retrieves an IAMService::enTargetAsset service data parameter of type IAMServiceData::UIDRefList.

Parameters

outUIDRefList will be populated with one or more UIDRefs.

Returns: kTrue if the data was found; kFalse otherwise.

virtual bool16 IAMServiceData::Get ( IAMServiceData::IDFileList & outIDFileList )

pure virtual

Retrieves an IAMService::enTargetAsset service data parameter of type IAMServiceData::IDFileList.

Parameters

outIDFileList will be populated with one or more IDFiles.

Returns: kTrue if the data was found; kFalse otherwise.

virtual bool16 IAMServiceData::GetFlag ( int32 dataID ) const

pure virtual

Retrieves a binary flag value (kTrue or kFalse).

Parameters

dataID is a unique key to identify the flag.

Returns: kTrue if the flag is set; kFalse otherwise.

virtual void IAMServiceData::Set	(	int32	dataID,
		const IDFile &	inFile
	)

pure virtual

Sets the value of a service data parameter of type IDFile.

Parameters

dataID	is a unique key to identify the data.
inFile	the contents of this are copied and saved.

virtual void IAMServiceData::Set	(	int32	dataID,
		int32	inInt32
	)

pure virtual

Sets the value of a service data parameter of type int32.

Parameters

dataID	is a unique key to identify the data.
inInt32	the contents of this are copied and saved.

virtual void IAMServiceData::Set	(	int32	dataID,
		void *	inInterface
	)

pure virtual

Sets the value of a service data parameter of type void *.

Parameters

dataID	is a unique key to identify the pointer.
inInterface	the contents of this are copied and saved.

virtual void IAMServiceData::Set	(	int32	dataID,
		const PMString &	inPMString
	)

pure virtual

Sets the value of a service data parameter of type PMString.

Parameters

dataID	is a unique key to identify the data.
inPMString	the contents of this are copied and saved.

virtual void IAMServiceData::Set	(	int32	dataID,
		const UIDRef &	inUIDRef
	)

pure virtual

Sets the value of a service data parameter of type UIDRef.

Parameters

dataID	is a unique key to identify the data.
inUIDRef	the contents of this are copied and saved.

virtual void IAMServiceData::Set	(	int32	dataID,
		UIFlags	inUIFlags
	)

pure virtual

Sets the value of a service data parameter of type UIFlags.

Parameters

dataID	is a unique key to identify the data.
inUiFlags	the contents of this are copied and saved.

virtual void IAMServiceData::Set	(	int32	dataID,
		IAMUIService::FollowupAction	inAction
	)

pure virtual

Sets the value of a service data parameter of type IAMUIService::FollowupAction.

Parameters

dataID	is a unique key to identify the data.
inAction	the contents of this are copied and saved.

virtual void IAMServiceData::Set ( const IAMServiceData::UIDRefList & inUIDRefList )

pure virtual

Sets the value of a service data parameter of type IAMServiceData::UIDRefList. The dataID is implicitly IAMService::enTargetAsset.

Parameters

inUIDRefList the contents of this list are copied and saved.

virtual void IAMServiceData::Set ( const IAMServiceData::IDFileList & inIDFileList )

pure virtual

Sets the value of a service data parameter of type IAMServiceData::IDFileList. The dataID is implicitly IAMService::enTargetAsset.

Parameters

inIDFileList the contents of this list are copied and saved.

virtual void IAMServiceData::SetFlag	(	int32	dataID,
		bool16	b = `kTrue`
	)

pure virtual

Sets or clears a flag service data parameter.

Parameters

dataID	is a unique key to identify the flag.
b	flag value; specify kTrue to set the flag, or kFalse to clear it.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation