DocumentFacable.java

/**
 * Copyright (c)2010-2011 Enterprise Website Content Management System(EWCMS), All rights reserved.
 * EWCMS PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 * http://www.ewcms.com
 */

package com.ewcms.content.document;

import java.util.Date;
import java.util.List;
import java.util.Map;

import com.ewcms.content.document.model.Article;
import com.ewcms.content.document.model.Category;
import com.ewcms.content.document.model.ArticleMain;
import com.ewcms.content.document.model.OperateTrack;
import com.ewcms.content.document.model.Relation;
import com.ewcms.content.document.model.ReviewProcess;
import com.ewcms.core.site.model.Channel;
import com.ewcms.publication.PublishException;

/**
 *
 * @author 吴智俊
 */
public interface DocumentFacable {
	/**
	 * 新增文章分类属性
	 * 
	 * @param category 文章分类属性对象
	 * @return Integer 文章分类属性编号
	 */
	public Long addCategory(Category category);
	
	/**
	 * 修改文章分类属性
	 * 
	 * @param category 文章分类属性对象
	 * @return Integer 文章分类属性编号
	 */
	public Long updCategory(Category category);
	
	/**
	 * 删除文章分类属性
	 * 
	 * @param categoryId 文章分类属性编号
	 */
	public void delCategory(Long categoryId);
	
	/**
	 * 查询文章分类属性
	 * 
	 * @param categoryId 文章分类属性编号
	 * @return Category 文章分类属性对象
	 */
	public Category findCategory(Long categoryId);
	
	/**
	 * 查询所有文章分类属性集合
	 * 
	 * @return List 文章分类属性对象集合
	 */
	public List<Category> findCategoryAll();
	
	/**
	 * 查询文章主体
	 * 
	 * @param articleMainId 文章主体编号
	 * @param channelId 频道编号
	 * @return ArticleMain 文章主体对象
	 */
	public ArticleMain findArticleMainByArticleMainAndChannel(Long articleMainId, Integer channelId);

	/**
	 * 删除文章主体
	 * 
	 * @param articleMainId 文章主体编号
	 * @param channelId 频道编号
	 */
	public void delArticleMain(Long articleMainId, Integer channelId);

	/**
	 * 删除文章主体到回收站
	 * 
	 * @param articleMainId 文章主体编号
	 * @param channelId 频道编号
	 */
	public void delArticleMainToRecycleBin(Long articleMainId, Integer channelId);

	/**
	 * 恢复文章主体
	 * 
	 * @param articleMainId 文章主体编号
	 * @param channelId 频道编号
	 */
	public void restoreArticleMain(Long articleMainId, Integer channelId);

	/**
	 * 提交审核文章主体(只对初稿和重新编辑状态的文章进行发布)
	 * 
	 * @param articleMainId 文章主体编号集合
	 * @param channelId 频道编号
	 * @return Boolean true:提交成功,false:提交失败
	 * @throws BaseExcepiton
	 */
	public void submitReviewArticleMain(List<Long> articleMainIds, Integer channelId) throws BaseException;

	/**
	 * 拷贝文章主体
	 * 
	 * @param articleMainIds 文章主体编号集合
	 * @param channelIds 频道编号集合
	 * @return Boolean true:拷贝成功,false:拷贝失败
	 */
	public Boolean copyArticleMainToChannel(List<Long> articleMainIds, List<Integer> channelIds, Integer source_channelId);

	/**
	 * 从共享库拷贝到频道
	 * 
	 * @param articleMainIds 文章主体编号集合
	 * @param channelIds 频道编号集合
	 */
	public void copyArticleMainFromShare(List<Long> articleMainIds, List<Integer> channelIds);

	/**
	 * 从共享库引用文章
	 * 
	 * @param articleMainIds 文章主体编号集合　
	 * @param channelIds 频道编号集合
	 */
	public void refenceArticleMainFromShare(List<Long> articleMainIds, List<Integer> channelIds);
	
	/**
	 * 移动文章主体
	 * 
	 * @param articleMainIds 文章主体编号集合
	 * @param channelIds 频道编号集合
	 * @return Boolean true:移动成功,false:移动失败
	 */
	public Boolean moveArticleMainToChannel(List<Long> articleMainIds, List<Integer> channelIds, Integer source_channelId);

	/**
	 * 查询文章主体集合
	 * 
	 * @param channelId 频道编号
	 * @return List 文章主体集合
	 */
	public List<ArticleMain> findArticleMainByChannel(Integer channelId);

	/**
	 * 发布文章主体
	 * 
	 * @param channelId 频道编号
	 * @param again 是否重复发布
	 * @param children 是否发布子频道
	 * @throws PublishException 
	 */
	public void pubArticleMainByChannel(Integer channelId, Boolean again, Boolean children) throws PublishException;

	/**
	 * 关联发布
	 * 
	 * @param channelId 频道编号
	 * @throws PpublishException
	 */
	public void associateRelease(Integer channelId) throws PublishException;
	
	/**
	 * 审核是否可以进行，通过流程定义的用户或用户组判断
	 * 
	 * @param articleMainId 文章主体编号
	 * @param channelId 频道编号
	 * @Param Boolean true:是,false:否
	 */
	public Boolean reviewArticleMainIsEffective(Long articleMainId, Integer channelId);
	
	/**
	 * 审核文章主体
	 * 
	 * @param articleMainIds 文章主体编号
	 * @param channelId 频道编号
	 * @param review 审核标志(0:通过,1:未通过)
	 * @param reason 原因
	 */
	public void reviewArticleMain(Long articleMainId, Integer channelId, Integer review, String reason);
	
	/**
	 * 文章主体进行排序
	 * 
	 * @param articleMainId 文章主体编号
	 * @param channelId 频道编号
	 * @param sort 排序号
	 * @param isInsert 是否插入(0:插入,1:替换)
	 * @param isTop 是否置顶(true:是,false:否)
	 */
	public void moveArticleMainSort(Long articleMainId, Integer channelId, Long sort, Integer isInsert, Boolean isTop);
	
	/**
	 * 查询文章主体
	 * 
	 * @param channelId 频道编号
	 * @param sort 排序号
	 * @param isTop 是否置顶(true:是,false:否)
	 * @return Boolean true:存在,false:不存在
	 */
	public Boolean findArticleMainByChannelAndEqualSort(Integer channelId, Long sort, Boolean isTop);

	/**
	 * 清除文章主体排序
	 * 
	 * @param articleMainIds 文章主体编号集合
	 * @param channelId 频道编号
	 */
	public void clearArticleMainSort(List<Long> articleMainIds, Integer channelId);
	
	/**
	 * 文章退回到重新编辑状态
	 * 
	 * @param articleMianId 文章主体编号
	 * @param channelId 频道编号
	 * @throws BaseException
	 */
	public void breakArticleMain(List<Long> articleMianIds, Integer channelId) throws BaseException;
	
	/**
	 * 查询操作轨迹原因
	 * 
	 * @param trackId 操作轨迹编号
	 * @return String 原因
	 */
	public String getArticleOperateTrack(Long trackId);
	
	/**
	 * 文章主体是否置顶
	 * 
	 * @param articleMainIds 文章主体编号集合
	 * @param top 是否置顶(true:置顶,false:不置顶)
	 * @param channelId 频道编号
	 */
	public void topArticleMain(List<Long> articleMainIds, Boolean top, Integer channelId);
	
	/**
	 * 待审核文章显示
	 * 
	 * @param userName 用户名
	 * @return Map
	 */
	public Map<Channel, Long> findBeApprovalArticleMain(String userName);
	
	/**
	 * 新增文章信息
	 * 
	 * @param article 文章信息对象
	 * @param channelId 频道编号
	 * @param published 发布时间
	 * @return Long 文章主体编号
	 */
	public Long addArticle(Article article, Integer channelId, Date published);
	
	/**
	 * 修改文章信息
	 * 
	 * @param article 文章信息对象
	 * @param articleMainId 文章主体编号
	 * @param channelId 频道编号
	 * @param published 发布时间
	 * @return Long 文章主体编号
	 */
	public Long updArticle(Article article, Long articleMainId, Integer channelId, Date published);

	/**
	 * 文章与文章分类属性是否有关联
	 * 
	 * @param articleId 文章信息编号
	 * @param categoryId 文章分类属性编号
	 * @return Boolean true:是,false:否
	 */
	public Boolean findArticleIsEntityByArticleAndCategory(Long articleId, Long categoryId);

	/**
	 * 保存相关文章
	 * 
	 * @param articleId 文章信息编号
	 * @param relationArticleIds 相关文章编号集合
	 */
	public void saveRelation(Long articleId, Long[] relationArticleIds);
	
	/**
	 * 删除相关文章
	 * 
	 * @param articleId 文章信息编号
	 * @param relationArticleIds 相关文章编号集合
	 */
	public void deleteRelation(Long articleId, Long[] relationArticleIds);
	
	/**
	 * 相关文章向上移动一位
	 * 
	 * @param articleId 文章信息编号
	 * @param relationArticleIds 相关文章编号集合
	 */
	public void upRelation(Long articleId, Long[] relationArticleIds);

	/**
	 * 相关文章向下移动一位
	 * 
	 * @param articleId 文章信息编号
	 * @param relationArticleIds 相关文章编号集合
	 */
	public void downRelation(Long articleId, Long[] relationArticleIds);
	
	/**
	 * 查询相关文章集合
	 * 
	 * @param articleId 文章信息编号
	 * @return List 相关文章集合
	 */
	public List<Relation> findRelationByArticle(Long articleId);
	
	/**
	 * 新增审核流程
	 * 
	 * @param channelId 频道编号
	 * @param reviewProcess 审核流程对象
	 * @param userNames 用户名集合
	 * @param groupNames 用户组集合
	 * @return Long 审核流程编号
	 */
	public Long addReviewProcess(Integer channelId, ReviewProcess reviewProcess, List<String> userNames, List<String> groupNames) throws BaseException;
	
	/**
	 * 修改审核流程
	 * 
	 * @param reviewProcess 审核流程对象
	 * @param userNames 用户名集合
	 * @param groupNames 用户组集合
	 * @return Long 审核流程编号
	 */
	public Long updReviewProcess(ReviewProcess reviewProcess, List<String> userNames, List<String> groupNames) throws BaseException;
	
	/**
	 * 删除审核流程
	 * 
	 * @param reviewProcessId 审核流程编号
	 */
	public void delReviewProcess(Long reviewProcessId);
	
	/**
	 * 审核流程上移一位
	 * 
	 * @param channelId 频道编号
	 * @param reviewProcessId 审核流程编号
	 */
	public void upReivewProcess(Integer channelId, Long reviewProcessId);
	
	/**
	 * 审核流程下移一位
	 * 
	 * @param channelId 频道编号
	 * @param reviewProcessId 审核流程编号
	 */
	public void downReviewProcess(Integer channelId, Long reviewProcessId);
	
	/**
	 * 查询审核流程
	 * 
	 * @param reviewProcessId 审核流程编号
	 * @return ReviewProcess 审核流程对象
	 */
	public ReviewProcess findReviewProcess(Long reviewProcessId);
	
	/**
	 * 查询频道下的所有审核流程
	 * 
	 * @param channelId 频道编号
	 * @return List 审核流程对象集合
	 */
	public List<ReviewProcess> findReviewProcessByChannel(Integer channelId);
	
	/**
	 * 查询频道下的审核流程第一个节点
	 * 
	 * @param channelId 频道编号
	 * @return ReviewProcess 审核流程对象
	 */
	public ReviewProcess findFirstReviewProcessByChannel(Integer channelId);
	
	/**
	 * 查询频道下的审核流程数
	 * 
	 * @param channelId 频道编号
	 * @return Long 个数
	 */
	public Long findReviewProcessCountByChannel(Integer channelId);
	
	public Boolean findReviewUserIsEntityByProcessIdAndUserName(Long reviewProcessId, String userName);

	public Boolean findReviewGroupIsEntityByProcessIdAndUserName(Long reviewProcessId, String goupName);
	
	/**
	 * 通过文章主体编号查询所有操作过程
	 * 
	 * @param articleMainId 文章主体编号
	 * @return List 操作过程集合
	 */
	public List<OperateTrack> findOperateTrackByArticleMainId(Long articleMainId);
	
	/**
	 * 根据年份查询所有月的新建文章数，供FusionCharts使用
	 * 
	 * @param year
	 * @return
	 */
	public Map<Integer, Long> findCreateArticleFcfChart(Integer year, Integer siteId);
	
	/**
	 * 根据年份查询所有月的发布文章数，供FusionCharts使用
	 * 
	 * @param year 年份
	 * @return Map
	 */
	public Map<Integer, Long> findReleaseArticleFcfChart(Integer year, Integer siteId);
	
	/**
	 * 根据年份查询建立者的发布文章数，供FusionCharts使用
	 * 
	 * @param year 年份
	 * @return Map
	 */
	public Map<String, Long> findReleaseArticlePersonFcfChart(Integer year, Integer siteId);
	
	/**
	 * 查询文章主体
	 * 
	 * @param articleMainId 文章主体编号
	 * @return ArticleMain
	 */
	public ArticleMain findArticleMainById(Long articleMainId);
	
	/**
	 * 引用文章主体
	 * 
	 * @param channelId 栏目编号
	 * @param articleMain 文章主体编号数组
	 */
	public void referArticleMain(Integer channelId, Long[] articleMainIds);

	/**
	 * 移除文章主体（直接删除）
	 * 
	 * @param articleMainId 文章主体编号数组
	 */
	public void removeArticleMain(Long[] articleMainIds);
	
	/**
	 * 文章是否共享
	 * 
	 * @param articleMainIds 文章主体编号
	 * @param share 是否共享(true:共享,false:不共享)
	 */
	public void shareArticleMain(List<Long> articleMainIds, Boolean share, Integer channelId);
}