IBlackBoxCommands.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $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 __IBlackBoxCommands__
#define __IBlackBoxCommands__


#include "IPMUnknown.h"
#include "DocFrameworkID.h"
#include "IBlackBoxData.h" // for BlackBoxKey

class XMLReference;

class IBlackBoxCommands : public IPMUnknown {
public:
 enum { kDefaultIID = IID_IBLACKBOXCOMMANDS };

 virtual ErrorCode AddData(const UIDRef& obj, BlackBoxKey key, void *buffer, int32 length) = 0;
 
 virtual ErrorCode AddData(const XMLReference& obj, BlackBoxKey key, void *buffer, int32 length) = 0;
 
 virtual ErrorCode RemoveData(const UIDRef& obj, BlackBoxKey key) = 0;
 
 virtual ErrorCode RemoveData(const XMLReference& obj, BlackBoxKey key) = 0;
 
 virtual int32 GetData(const UIDRef& obj, BlackBoxKey key, void *buffer, int32 amountToRead) = 0;
 
 virtual int32 GetData(const XMLReference& obj, BlackBoxKey key, void *buffer, int32 amountToRead) = 0;
 

};



#endif // __IBlackBoxCommands__