API
Class

com.justep.doc.AbstractDoc (com.justep.doc.AbstractDoc)

使用范围:BIZ

Contents

class com.justep.doc.AbstractDoc (com.justep.doc.AbstractDoc)

文档抽象类,所有和文档相关的类的父类 数据存储部分 依赖com.justep.system.data.Row实现 提供了和文档服务器交互的基本逻辑 这里面有几个关键字段名字: fileID : 对应文档服务器上每个文件的唯一标识符 docID :这个文档对应系统数据库SA_DocNode中的的sid

Constructor Top

  AbstractDoc ()

Methods Top

Table deleteHistoryVersion ( docVersionID)
void download (OutputStream outputStream, String versionID, String partType)
void download (OutputStream outputStream)
String getCacheName ()
void getCommentFileContent (String cacheName)
String getDocFullPath ()
Table getHistorysTable ()
void getRevisionCacheName ()
Row getRow ()
Integer getsDocLiveVersionID ()
String getsDocName ()
String getsDocPath ()
String getsFileID ()
int getsFlag ()
String getsID ()
String getsKind ()
String getsParentID ()
Float getsSize ()
ModifyState getState ()
String getViewUrl ()
String getViewUrl ( versionID, partType)
boolean isPublicDoc ()
void setCacheName (String cacheName)
void setsDocLiveVersionID (Integer sDocLiveVersionID)
void setsDocName (String sDocName)
void setsDocPath (String sDocPath)
void setsFileID (String sFileID)
void setsFlag (int sFlag)
void setsID (String sID)
void setsKind (String sKind)
void setsParentID (String sParentID)
void setSrevisionCacheName (String cacheName)
void setsSize (Float sSize)
ModifyState setState ()
void upload (InputStream inputStream)
void upload (File file)

Constructor details Top

public AbstractDoc ()

文档抽象类,所有和文档相关的类的父类 数据存储部分 依赖com.justep.system.data.Row实现 提供了和文档服务器交互的基本逻辑 这里面有几个关键字段名字: fileID : 对应文档服务器上每个文件的唯一标识符 docID :这个文档对应系统数据库SA_DocNode中的的sid

Methods Detail Top

public Table deleteHistoryVersion ( docVersionID)

删除当前文档的某个历史版本

Parameters

docVersionID

要删除的文档版本ID

Return Value

Table

Throws

com.justep.doc.exception.DocRTException

public void download (OutputStream outputStream, String versionID, String partType)

下载文档

Parameters

OutputStream outputStream

下载文档的输出流

String versionID

文档的版本号,与文档服务器相对应

String partType

文档的类型,与文档服务器相对应('content'|'revision'|'comment')

Return Value

void

Throws

com.justep.doc.exception.DocRTException

连接文档服务器出错

public void download (OutputStream outputStream)

下载最新版本的文档正文

Parameters

OutputStream outputStream

下载文档的输出流

Return Value

void

Throws

com.justep.doc.exception.DocRTException

连接文档服务器出错

public String getCacheName ()

获取文档在文档服务器上修订文档的临时文件的正文的fileID

Return Value

String

public void getCommentFileContent (String cacheName)

获取修订内容

Parameters

String cacheName

Return Value

void

public String getDocFullPath ()

获取文档对应的全路径

Return Value

String

public Table getHistorysTable ()

获取当前文档的历史版本

Return Value

Table

public void getRevisionCacheName ()

获取文档在文档服务器上缓存的临时文件的修订版fileID

Return Value

void

public Row getRow ()

获取当前文档对应的数据映射对象Row

Return Value

Row

public Integer getsDocLiveVersionID ()

获取文档的当前版本号

Return Value

Integer

public String getsDocName ()

获取文档名称

Return Value

String

public String getsDocPath ()

获取文档路径(不包含当前文档)

比如:/a/b/c/d.doc 当我获取d.doc的docPath的时候结果是/a/b/c对应的sid组成的路径 所以根目录的docPath是/ 根目录下的第一级目录的docPath是/defaultDocNameSpace(默认文档服务器下第一级目录的docPath)

Return Value

String

public String getsFileID ()

获取文档服务器对应的id

Return Value

String

public int getsFlag ()

获取flag标识

flag 为0代表被逻辑删除的文件 flag 为1代表正常存在的文件 物理删除的文件在数据库中记录也会被删除

Return Value

int

public String getsID ()

获取ID

Return Value

String

public String getsKind ()

获取文档类型

Return Value

String

public String getsParentID ()

获取父ID

Return Value

String

public Float getsSize ()

获取文档大小

Return Value

Float

public ModifyState getState ()

获取文档类的当前状态

Return Value

ModifyState

public String getViewUrl ()

获取查看文件的url

Return Value

String

public String getViewUrl ( versionID, partType)

获取查看文件的url

Parameters

versionID

文档版本ID

partType

文档类型

Return Value

String

public boolean isPublicDoc ()

是否是公共目录下的文件或者公共目录

Return Value

boolean

public void setCacheName (String cacheName)

设置文档在文档服务器上修订文档的临时文件的正式版的fileID

Parameters

String cacheName

Return Value

void

public void setsDocLiveVersionID (Integer sDocLiveVersionID)

设置文档的当前版本号

Parameters

Integer sDocLiveVersionID

文档版本号

Return Value

void

public void setsDocName (String sDocName)

设置文档名称

Parameters

String sDocName

文档的名称

Return Value

void

public void setsDocPath (String sDocPath)

设置文档路径

Parameters

String sDocPath

文档的路径

Return Value

void

public void setsFileID (String sFileID)

设置文档服务器对应的id

Parameters

String sFileID

文档服务器对应的id

Return Value

void

public void setsFlag (int sFlag)

设置flag标识

Parameters

int sFlag

Return Value

void

public void setsID (String sID)

设置ID

Parameters

String sID

id的值

Return Value

void

public void setsKind (String sKind)

设置文档类型

Parameters

String sKind

文档的类型

Return Value

void

public void setsParentID (String sParentID)

设置父ID

Parameters

String sParentID

父id的值

Return Value

void

public void setSrevisionCacheName (String cacheName)

设置文档在文档服务器上缓存的临时文件的修订版fileID

Parameters

String cacheName

Return Value

void

public void setsSize (Float sSize)

设置文档大小

Parameters

Float sSize

文档的大小

Return Value

void

public ModifyState setState ()

设置文档类的当前状态

Return Value

ModifyState

public void upload (InputStream inputStream)

上传文档

Parameters

InputStream inputStream

上传文档的输入流

Return Value

void

Throws

com.justep.doc.exception.DocRTException

连接文档服务器出错

public void upload (File file)

上传文档

Parameters

File file

上传的文件

Return Value

void

Throws

com.justep.doc.exception.DocRTException

连接文档服务器出错