IAMServiceData.h

//========================================================================================
// 
// $File$
// 
// Owner: Bill Tislar
// 
// $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 __IAMSERVICEDATA__
#define __IAMSERVICEDATA__

#include "IPMUnknown.h"
#include "workgroupid.h"
#include "IAMUIService.h"

#include "IDFile.h"
#include "PMString.h"
#include "UIDRef.h"

#include <vector>


class IAMServiceData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IAMSERVICEDATA };

 typedef std::vector<IDFile> IDFileList;
 typedef std::vector<UIDRef> UIDRefList;
 
 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;
 
}; // end IAMServiceData interface

#endif // __IAMSERVICEDATA__