ILibraryFilterData.h

//========================================================================================
// 
// $File$
// 
// Owner: Tim Gogolin
// 
// $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.
// 
// 
// Reviewed: 9/25/98
// 
// Purpose:
// Store and retrieve information needed to create a Library query on a catalog
// of assets. The "Show Subset" dialog will fill in these fields and they can be
// retrieved to create a database query.
// 
//========================================================================================

#ifndef __ILibraryFilterData__
#define __ILibraryFilterData__

#include "IPMUnknown.h"
#include "LibraryProviderID.h"
#include "ILibraryAssetMetaData.h"


class GlobalTime;


class ILibrarySimpleFilterData : public IPMUnknown
{
 public: 
 
 typedef enum
 {
 Field_Type,
 Field_Date,
 Field_Name,
 Field_Description
 } EField;
 
 typedef enum
 {
 Condition_Equal,
 Condition_NotEqual,
 Condition_GreaterThan,
 Condition_LessThan,
 Condition_Contains,
 Condition_DoesNotContain,
 Condition_Undefined
 } ECondition;
 
 virtual void SetNameFilter(ECondition inCondition, const PMString& inString) = 0;

 virtual void SetDescriptionFilter(ECondition inCondition, const PMString& inString) = 0;

 virtual void SetDateFilter(ECondition inCondition, const GlobalTime& inTime) = 0;

 virtual void SetTypeFilter(ECondition inCondition, ILibraryAssetMetaData::UserType inType) = 0;
 
 virtual EField GetFilterField() = 0;
 
 virtual void GetNameFilter(ECondition& outCondition, PMString& outString) = 0;
 
 virtual void GetDescriptionFilter(ECondition& outCondition, PMString& outString) = 0;
 
 virtual void GetDateFilter(ECondition& outCondition, GlobalTime& outTime) = 0;
 
 virtual void GetTypeFilter(ECondition& outCondition, ILibraryAssetMetaData::UserType& outType) = 0;
 
 virtual bool16 PassFilter(ILibraryAssetMetaData* inAssetData) = 0;
};


class ILibraryComplexFilterData : public IPMUnknown
{
 public:
 typedef enum
 {
 Conjunction_And,
 Conjunction_Or
 } EConjunction;

 virtual void SetConjunction(EConjunction inConjunction) = 0;

 virtual EConjunction GetConjunction() = 0;
 
 virtual UIDRef AppendNewSimpleFilter() = 0;
 
 virtual int32 GetNumSimpleFilters() = 0;
 
 virtual UIDRef GetSimpleFilterAt(int32 i) = 0;
 
 virtual bool16 PassFilter(ILibraryAssetMetaData* inAssetData) = 0;
};

#endif // __ILibraryFilterData__