IItemStrand.h

//========================================================================================
// 
// $File$
// 
// Owner: emenning
// 
// $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 __IItemStrand__
#define __IItemStrand__
#include "IPMUnknown.h"
#include "PMTypes.h"
#include "TextID.h"
#include "K2Vector.h"
#include "OwnedItemDataList.h"

class UIDList;
class IOwnedItem;
typedef K2Vector<ClassID> ClassList;


class IItemStrand : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IITEMSTRAND };

 virtual void SetOwnedUID(TextIndex position, ClassID objectType, UID object) = 0;

 virtual UID GetOwnedUID(TextIndex position, ClassID objectType, int32 *count = nil, TextIndex *runBegin = nil) = 0;

 virtual void GetAllItems(TextIndex position, int32 length, UIDList *uidListToFill, ClassList* classListToFill = nil) = 0;

 virtual int32 CountOwnedItems(TextIndex position, int32 *count = nil, TextIndex *runBegin = nil) = 0;

 virtual UID GetNthOwnedUID(TextIndex position, int32 n, ClassID *objectType, int32 *count = nil, TextIndex *runBegin = nil) = 0;

 virtual TextIndex GetOwnedItemIndex(ClassID objectType, UID object, TextIndex hint = 0) = 0;

 virtual TextIndex GetOwnedItemIndex(const IOwnedItem* ownedItem) const = 0;

 virtual void CollectOwnedItems(TextIndex start, int32 len, OwnedItemDataList* resultList) const = 0;
};

#endif //__IItemStrand__