IAssignmentMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: Jon Pugh
// 
// $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 _IAssignmentMgr_
#define _IAssignmentMgr_

#include "AssignmentID.h"

#include "IAssignment.h"
#include "IAssignedDocument.h"

class IDocument;
class PMString;
class IINXImportPolicy;


class IAssignmentMgr : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IASSIGNMENTMGR };

 typedef enum { 
 kNotExported, 
 kAssigned, 
 kUnassigned, 
 kUnknown
 } FrameStatus;

 
 virtual bool16 IsAssigned(const UIDRef& object) const = 0;

 // assignment data access
 
 virtual ErrorCode SaveAssignments(IDocument* document, UIFlags uiFlags = kFullUI, bool16 forceSave = kFalse) = 0;
 
 virtual ErrorCode SaveAssignment(IAssignment* assignment, UIFlags uiFlags = kFullUI) = 0;
 
 virtual ErrorCode OpenAssignmentWithProxy(const PMString& assignFile, InterfacePtr<IAssignment>& assignment, UIFlags uiFlags = kFullUI) = 0;
 
 virtual ErrorCode ImportAssignment(IPMStream* stream, IINXImportPolicy* policy = nil, UIFlags uiFlags = kFullUI) = 0;
 
 virtual ErrorCode ExportAssignment(const IAssignment* assignment, IPMStream* stream, UIFlags uiFlags = kFullUI) = 0;
 
 virtual IAssignment* CreateAssignmentCmd(IAssignedDocument* doc, const PMString& assignFile, bool16 saveAssignment=kFalse, UIDList* objects = nil) = 0;

 virtual IAssignedStory* CreateAssignedStory(const UIDRef& story) = 0;

 virtual IAssignment* QueryAssignment(IAssignedDocument* doc, const PMString& assignFile) const = 0;

 virtual bool16 IsTextStory(IAssignedDocument* docInfo, const PMString& assignPath, const PMString& storyPath) const = 0;

 virtual bool16 IsTextStory(const UIDRef& itemRef) const = 0;

 virtual IAssignedDocument* GetAssignedDocument(IDataBase* db) const = 0;

 virtual IAssignedDocument* GetAssignedDocument(const PMString& docPath) const = 0;

 virtual void QueryAssignmentAndAssignedStory(const UIDRef& storyref, InterfacePtr<IAssignment>& iAssignmentRef, InterfacePtr<IAssignedStory>& iAssignedStoryRef) const = 0;
 
 virtual void GetStoryListOnDoc(IAssignedDocument* docInfo, UIDList& storyList) const = 0;
 
 virtual void GetStoryListOnAssignment(IAssignment* assignment, UIDList& storyList) const = 0;

 virtual ErrorCode AddToAssignmentCmd(IAssignment* assignment, UIDList& objects, IAssignedStory* beforeStory = nil, bool16 notifyPanel = kTrue) = 0;

 virtual ErrorCode DirtySpreadCmd(UIDRef spreadRef) = 0;

 virtual ErrorCode AddToAssignmentCmd(IAssignedDocument* docInfo, const PMString& assignPath, UIDList& objects, bool16 notifyPanel = kTrue) = 0;

 virtual IAssignmentMgr::FrameStatus GetFrameStatus(const UIDRef& object) const = 0;

 virtual bool16 UpdateAssignmentOptions(IAssignment *assignment, const PMString& assignName, const PMString &file, const PMString& assignWriter, const IAssignment::AssignmentExportOptions exportOption, 
 const UID uiColor, const bool16 includeLinkFilesPackaging, UIFlags uiFlags = kFullUI) = 0;
 
 virtual void NotifyPanel(ClassID theChange = kAssignmentMgrChangedNotifyMsg) = 0;

 virtual ErrorCode PackageAssignment(IAssignment* assignment, const IDFile& packageFile, UIFlags uiFlags = kFullUI) = 0;

 virtual bool16 IsAssignmentPackaged(IAssignment* assignment) = 0;

 virtual bool16 IsAssignmentPackageUpToDate(IAssignment* assignment) = 0;

 virtual ErrorCode ReturnPackageAssignment(IAssignment* assignment, const IDFile& packageFile, UIFlags uiFlags = kFullUI, bool16 includeAdded = kTrue) = 0;

 virtual ErrorCode ExplodeInCopyPackageForOpen(const IDFile& packageFile, UIFlags uiFlags, IDFile& assignmentFileToOpen) = 0;

 virtual IDFile GetAssignmentFileToOpenFromPackage(const IDFile& packageFile) = 0;

 virtual ErrorCode ForwardPackageAssignment(IAssignment* assignment, const IDFile& packageFile, UIFlags uiFlags = kFullUI, bool16 includeAdded = kTrue) = 0;

 virtual ErrorCode ExplodeInDesignPackageForOpen(const IDFile& packageFile, const UIDRef& assignmentRef, UIFlags uiFlags) = 0;

 virtual ErrorCode ExplodeInDesignPackageToFolder(const IDFile& packageFile, const IDFile& targetFolder, UIFlags uiFlags) = 0;
};

typedef InterfacePtr<IAssignmentMgr> IAssignmentMgrPtr;

#endif //_IAssignmentMgr_