ICusDtLnkFacade.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 __ICusDtLnkFacade_H_DEFINED__
#define __ICusDtLnkFacade_H_DEFINED__

// Interface includes:
#include "IPMUnknown.h"
#include "URI.h"
#include <map>
// Project includes:
#include "CusDtLnkID.h"

// Forward declarations:
class IDocument;
class IDataLink;

class ICusDtLnkFacade : public IPMUnknown
{

public:

 enum { kDefaultIID = IID_ICUSDTLNKFACADE };


 virtual ErrorCode SetKeyValuePair(const IWorkspace *ws, const PMString& key, const PMString& val, const PMIID& iid)=0;


 virtual PMString GetValueFromKey(const IWorkspace *ws, const PMString& key, const PMIID& iid) const=0;


 virtual bool16 IsOurCustomDataLink(const ClassID& classID) const =0;
 
 virtual bool16 IsOurCustomDataLink(const UIDRef& linkUIDRef) const =0;


 virtual ErrorCode AddAdornment(const UIDList& itemList)=0;



 virtual ErrorCode RemoveAdornment(const UIDList& itemList)=0;



 virtual ErrorCode AddAssetDataBase(const IWorkspace *ws, const PMString& dbName, 
 const PMString& fullPath)=0;


 virtual PMString GetNthAssetDataBase(const IWorkspace *ws, int32 index) const =0;


 virtual int32 GetAssetDataBaseCount(const IWorkspace *ws) const=0;


 virtual PMString GetAssetDataBasePath(const IWorkspace *ws, const PMString& dbName) const=0;


 virtual PMString TruncatePath(const PMString& fullPath, 
 bool16 useAnySeparator = kTrue, 
 const PlatformChar& useThisOne = kTextChar_Solidus) const = 0;


 virtual UIDRef ImportImageAndLoadPlaceGun(const UIDRef& docUIDRef, 
 const PMString& path, 
 const PMString& uniqueKey)=0;


 virtual UIDRef ImportImageAndLoadPlaceGun(const UIDRef& docUIDRef, 
 const URI& uri)=0;


 virtual PMString GetCurrentlyChosenUniqueAssetKey(const IWorkspace *ws) const = 0;


 virtual ErrorCode SetCurrentlyChosenUniqueAssetKey(const IWorkspace *ws, const PMString& newKey) = 0;


 virtual ErrorCode InitializeDataLink(const IWorkspace *ws, 
 IDataLink *dl, 
 const IDFile &file, const PMString &formatName,
 const PMString& uniqueAssetKey) = 0;

 virtual bool UniqueKeyToURI(const PMString& uk, URI& uri) const = 0;

 virtual bool URIToIDFile(const URI& uri, IDFile& file) const = 0;


 virtual PMString GetFirstPartOfPath(const PMString& p) const =0;


 virtual IDFile GetLocalFileFromAssetIdentifier(const IWorkspace *ws, const PMString& uniqueAssetKey) const = 0;


 virtual PMString GetAssetDataBaseRecordFieldValue(const IDFile& databaseFile, 
 const PMString& recordID, 
 const PMString& fieldName) const =0;

 virtual uint64 GetAssetSizeFromAssetIdentifier(const IWorkspace *ws, const PMString& uniqueAssetKey) const = 0;

 virtual uint64 GetAssetTimestampFromAssetIdentifier(const IWorkspace *ws, const PMString& uniqueAssetKey) const = 0;

 virtual PMString GetAssetDescriptionFromAssetIdentifier(const IWorkspace *ws, const PMString& uniqueAssetKey) const = 0;
 virtual uint64 GetAssetTimestampFromURI(const URI& uri) const = 0;


 virtual PMString GetFieldValueFromAssetIdentifier(const IWorkspace *ws, const PMString& uniqueAssetKey,
 const PMString& fieldName) const = 0;

 virtual PMString GetAssetDescriptionFromURI(const URI& uri) const = 0;
 
 virtual void StoreUniqueKey(IDataLink* dataLink, const PMString& uniqueAssetKey)=0;

 virtual PMString RetrieveUniqueKey(IDataLink* dataLink) const=0;

 PMString GetRecordFieldValueFromURI(const URI& uri, PMString& whichField) const;

 virtual bool16 NeedsOurAdornment(const UIDRef& pageItemUIDRef) const=0;

 virtual bool16 HasOurAdornment(const UIDRef& pageItemUIDRef) const =0;
};

#endif // __ICusDtLnkFacade_H_DEFINED__