BPISuiteCSB.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __BPISuiteCSB_h__
#define __BPISuiteCSB_h__

class IBPISuite;
class WideString;

class BPISuiteCSB : public CPMUnknown<IBPISuite>
{
public:
 BPISuiteCSB (IPMUnknown* boss);
 
 virtual ~BPISuiteCSB (void);

// Suite Member functions
public:
 virtual bool16 CanApplyBPIData (void);

 virtual ErrorCode ApplyBPIData(const WideString& value);

 virtual bool16 CanGetBPIData (void);

 virtual void GetBPIData(K2Vector<WideString>& values);

// Selection Extension functions 
public:
 virtual void Startup (void);

 virtual void Shutdown (void);

 virtual void SelectionChanged (SuiteBroadcastData*, const PMIID&, void*);

 virtual void SelectionAttributeChanged (SuiteBroadcastData*, const PMIID&, void*);

 virtual void HandleIntegratorSuiteMessage (void*, const ClassID&, ISubject*, const PMIID&, void*);

 virtual ProtocolCollection* CreateObserverProtocolCollection (void);

// Member functions to be overriden by each CSB sub-class.
protected:
 virtual UIDList GetTarget(void) = 0;
 
private:
 virtual bool16 IntersectsTarget(const UIDList& itemList); 
};

#endif