IPropertyTable.h

//========================================================================================
// 
// $File$
// 
// Owner: Hardeep
// 
// $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.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __IPropertyTable__
#define __IPropertyTable__

#include "IPMUnknown.h"

//Interfaces

//Utils & IDs
#include "LibraryProviderID.h"
#include "PMString.h"

typedef K2Vector<UID> PropUIDList;

class IPropertyTable : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPROPERTYTABLE };
 
 // ----- Storing Properties -----
 virtual void StoreItemProperty(UID item, IPMUnknown* propertyValue) = 0;

 virtual IPMUnknown* QueryItemProperty(UID item) = 0;
 
 virtual bool16 DeleteItemProperty(UID item) = 0;

 // ----- Properties as strings-----

 virtual PMString GetItemPropertyAsString(UID item) = 0;

 // ----- Comparing Properties -----
 virtual int32 GetPropertyComparatorCount() const = 0;

 virtual PMString GetNthPropertyComparatorName(int32 compareIndex) const = 0;

 virtual bool16 IsComparatorNegative(int32 compareIndex) const = 0;
 
 virtual void Delete() = 0;

 // ----- Searching for Properties -----
 virtual void GetItemsMatchingCriteria( PropUIDList& items, int32 whichComparator, IPMUnknown* propertyValue, PropUIDList* fromList = nil) = 0;
};

#endif