BPISuiteASB Class Reference

Inheritance diagram for BPISuiteASB:

Public Member Functions
	BPISuiteASB (IPMUnknown *boss)
virtual	~BPISuiteASB (void)
virtual bool16	CanApplyBPIData (void)
virtual ErrorCode	ApplyBPIData (const WideString &value)
virtual bool16	CanGetBPIData (void)
virtual void	GetBPIData (K2Vector< WideString > &values)
Public Member Functions inherited from CPMUnknown< IBPISuite >
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

Additional Inherited Members
Public Types inherited from IBPISuite
enum	{ kDefaultIID = IID_IBPISUITE }
Protected Member Functions inherited from CPMUnknown< IBPISuite >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IBPISuite >
HelperInterface	fHelperInterface

Detailed Description

Integrator IBPISuite implementation on the abstract selection boss (ASB) that forwards client calls to CSB suite(s) that have a selection.

The purpose of this integrator suite is to determine how to forward the client request on to the CSB suite(s). Note that the client does not interact with the CSB (which has all the real implementation of the suite) directly, the client interacts with the ASB only. Also note that the suite API shouldn't contain model data that is specific to a selection format (layout uidLists, text model/range, etc) so that the client code can be completely decoupled from the underlying CSB.

See Also

Selection fundamentals chapter in Programming Guide

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * BPISuiteASB::BPISuiteASB

(

IPMUnknown *

boss

)

Constructor.

Parameters

boss	interface ptr from boss object on which this interface is aggregated.

BPISuiteASB::~BPISuiteASB ( void  )

virtual

Destructor.

Member Function Documentation

ErrorCode BPISuiteASB::ApplyBPIData ( const WideString &  value )

virtual

Create or join a command sequence and call CSB suites on active CSBs to process it's commands.

See Also

IBPISuite::ApplyBPIData

Implements IBPISuite.

bool16 BPISuiteASB::CanApplyBPIData ( void  )

virtual

Returns

kTrue if any CSB suites on active CSBs allow adding IBPIData, kFalse otherwise.

See Also

IBPISuite::CanApplyBPIData

Implements IBPISuite.

bool16 BPISuiteASB::CanGetBPIData ( void  )

virtual

Returns

kTrue if any of the CSB suites on active CSBs allow getting of IBPIData, kFalse otherwise.

See Also

IBPISuite::CanGetBPIData

Implements IBPISuite.

void BPISuiteASB::GetBPIData ( K2Vector< WideString > &  values )

virtual

Call CSB suites on active CSB's to GetBPIData

Parameters

values

OUT vector of the IBPIData values of the selected objects.

See Also

IBPISuite::GetBPIData

Implements IBPISuite.