IArticleFacade.h

//========================================================================================
// 
// ADOBE CONFIDENTIAL
// 
// $File$
// 
// Owner: Paresh Goel
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 2010 Adobe Systems Incorporated
// All Rights Reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================

#ifndef _IARTICLEFACADE_
#define _IARTICLEFACADE_

#include "ArticleID.h"
#include "UIDList.h"

namespace Facade
{
 class IArticleFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IARTICLEFACADE };

 public:

 virtual UID CreateArticle(IDataBase* database , const PMString& name) = 0; 

 virtual ErrorCode AddArticle(const UIDList& articleList , int32 pos = -1) = 0;
 
 virtual UID CreateAndAddArticle(IDataBase* database, const PMString& name, int32 pos = -1) = 0;
 
 virtual ErrorCode RemoveArticles(const UIDList& articleList) = 0;
 
 virtual ErrorCode DeleteArticle(const UIDList& articleList) = 0;
 
 virtual ErrorCode MoveArticles(const UIDList& articleList, int32 toPos) = 0;
 
 virtual ErrorCode SetArticleName(const UIDRef& article, const PMString& name) = 0;

 virtual ErrorCode SetArticleExportStatus(const UIDList& articleList, bool16 useForExport) = 0;

 virtual ErrorCode AddMembers(const UIDRef& article, const UIDList& memberList, int32 pos = -1) = 0 ;
 
 virtual ErrorCode AutoPopulateArticle(const UIDList& articleList) = 0;

 virtual ErrorCode RemoveMembers(const UIDRef& article, const UIDList& memberList) = 0 ;
 
 virtual ErrorCode MoveMembers(const UIDRef& article, const UIDList& memberList, int32 toPos = -1) = 0 ;

 virtual ErrorCode AddChildren(const UIDRef& group, const UIDList& childList, int32 pos = -1) = 0 ;
 
 virtual ErrorCode RemoveChildren(const UIDRef& group, const UIDList& childList) = 0 ;
 
 virtual ErrorCode MoveChildren(const UIDRef& group, const UIDList& childList, int32 toPos = -1) = 0 ;

 };
}
#endif // _IARTICLEFACADE_