IAssignment.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 _IASSIGNMENT_
#define _IASSIGNMENT_

#include "AssignmentID.h"
#include "PMString.h"

#include "IAssignedStory.h"
#include "URI.h"

class IAssignment : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IASSIGNMENT };

 enum AssignmentExportOptions
 {
 kAssignmentExportFrames = 0,

 kAssignmentExportSpreads,

 kAssignmentExportAll
 };

 enum AssignmentCompatibility
 {
 kAssignmentCS3Compatibility = 0,

 kAssignmentCS4Compatibility,

 kUnassignedCompatibility
 };

 virtual const PMString& GetName() const = 0;

 virtual void SetName(const PMString& name) = 0;
 
 virtual const PMString& GetFile() = 0;

 virtual void SetFile(const PMString& file) = 0;

 
 virtual const URI& GetURI() = 0;

 virtual void SetURI(const URI& uri) = 0;

 virtual const PMString& GetUser() const = 0;

 virtual void SetUser(const PMString& user) = 0;
 
 virtual UID GetColor() const = 0;

 virtual void SetColor(UID color) = 0;

 virtual AssignmentExportOptions GetExportOption() const = 0;

 virtual void SetExportOption(AssignmentExportOptions options) = 0;
 
 virtual AssignmentCompatibility GetCompatibility() const = 0;
 
 virtual bool16 GetDirty() = 0;

 virtual void SetDirty(bool16 dirty) = 0;
 
 virtual UIDList GetStories() const = 0;

 virtual void AddStory(IAssignedStory* story) = 0;

 virtual void RemoveStory(IAssignedStory* story) = 0;

 virtual void DeleteStory(IAssignedStory* story) = 0;

 virtual void MoveStory(IAssignedStory* story, IAssignedStory* beforeStory) = 0;

 virtual ErrorCode SetPropsCmd(const PMString* name, 
 const PMString* file, 
 const PMString* user, 
 const UID* color,
 const AssignmentExportOptions* options, 
 const bool16* dirty,
 const bool16* includeLinkFilesPackaging,
 const URI* uri = nil) = 0;

 virtual ErrorCode RemoveStoryCmd(IAssignedStory* story) = 0;

 virtual ErrorCode MoveStoryCmd(IAssignedStory* story, IAssignedStory* beforeStory) = 0;

 virtual bool16 GetIncludeLinkedFilesWhenPackage() const = 0;

 virtual void SetIncludeLinkedFilesWhenPackage(bool16 includeFlag) = 0;
};

typedef InterfacePtr<IAssignment> IAssignmentPtr;
typedef K2Vector<IAssignment*> IAssignmentList;

#endif //_IASSIGNMENT_