com.openkm.rest.endpoint

Class DocumentService

java.lang.Object

com.openkm.rest.endpoint.DocumentService

public class DocumentService
extends Object

Constructor Summary

Constructors

Constructor and Description
DocumentService()

Method Summary

Modifier and Type	Method and Description
void	cancelCheckout(String docId)
Version	checkin(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts)
void	checkout(String docId)
void	copy(String docId, String dstId)
Document	create(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts)
Document	createSimple(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts)
void	delete(String docId)
void	forceCancelCheckout(String docId)
void	forceUnlock(String docId)
DocumentList	getChildren(String dstId)
javax.ws.rs.core.Response	getContent(String docId)
javax.ws.rs.core.Response	getContentByVersion(String docId, String versionId)
LockInfo	getLockInfo(String docId)
String	getPath(String uuid)
Document	getProperties(String docId)
VersionList	getVersionHistory(String docId)
long	getVersionHistorySize(String docId)
boolean	isCheckedOut(String docId)
boolean	isLocked(String docId)
boolean	isValid(String docId)
LockInfo	lock(String docId)
void	move(String docId, String dstId)
void	purge(String docId)
void	purgeVersionHistory(String docId)
Document	rename(String docId, String newName)
void	restoreVersion(String docId, String versionId)
void	setProperties(Document doc)
void	unlock(String docId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentService

public DocumentService()

Method Detail

create

@Path(value="/create")
public Document create(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts)
                                       throws GenericException

Throws:

GenericException

createSimple

@Path(value="/createSimple")
public Document createSimple(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts)
                                                   throws GenericException

Throws:

GenericException

delete

@Path(value="/delete")
public void delete(String docId)
                                   throws GenericException

Throws:

GenericException

getProperties

@Path(value="/getProperties")
public Document getProperties(String docId)
                                                     throws GenericException

Throws:

GenericException

getContent

@Path(value="/getContent")
public javax.ws.rs.core.Response getContent(String docId)
                                                                throws GenericException

Throws:

GenericException

getContentByVersion

@Path(value="/getContentByVersion")
public javax.ws.rs.core.Response getContentByVersion(String docId,
                                                                                         String versionId)
                                                                                  throws GenericException

Throws:

GenericException

getChildren

@Path(value="/getChildren")
public DocumentList getChildren(String dstId)
                                                     throws GenericException

Throws:

GenericException

rename

@Path(value="/rename")
public Document rename(String docId,
                                              String newName)
                                       throws GenericException

Throws:

GenericException

setProperties

@Path(value="/setProperties")
public void setProperties(Document doc)
                                                 throws GenericException

Throws:

GenericException

checkout

@Path(value="/checkout")
public void checkout(String docId)
                                       throws GenericException

Throws:

GenericException

cancelCheckout

@Path(value="/cancelCheckout")
public void cancelCheckout(String docId)
                                                   throws GenericException

Throws:

GenericException

forceCancelCheckout

@Path(value="/forceCancelCheckout")
public void forceCancelCheckout(String docId)
                                                             throws GenericException

Throws:

GenericException

isCheckedOut

@Path(value="/isCheckedOut")
public boolean isCheckedOut(String docId)
                                                  throws GenericException

Throws:

GenericException

checkin

@Path(value="/checkin")
public Version checkin(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts)
                                        throws GenericException

Throws:

GenericException

getVersionHistory

@Path(value="/getVersionHistory")
public VersionList getVersionHistory(String docId)
                                                                throws GenericException

Throws:

GenericException

lock

@Path(value="/lock")
public LockInfo lock(String docId)
                                   throws GenericException

Throws:

GenericException

unlock

@Path(value="/unlock")
public void unlock(String docId)
                                   throws GenericException

Throws:

GenericException

forceUnlock

@Path(value="/forceUnlock")
public void forceUnlock(String docId)
                                             throws GenericException

Throws:

GenericException

isLocked

@Path(value="/isLocked")
public boolean isLocked(String docId)
                                          throws GenericException

Throws:

GenericException

getLockInfo

@Path(value="/getLockInfo")
public LockInfo getLockInfo(String docId)
                                                 throws GenericException

Throws:

GenericException

purge

@Path(value="/purge")
public void purge(String docId)
                                 throws GenericException

Throws:

GenericException

move

@Path(value="/move")
public void move(String docId,
                                      String dstId)
                               throws GenericException

Throws:

GenericException

copy

@Path(value="/copy")
public void copy(String docId,
                                      String dstId)
                               throws GenericException

Throws:

GenericException

restoreVersion

@Path(value="/restoreVersion")
public void restoreVersion(String docId,
                                                          String versionId)
                                                   throws GenericException

Throws:

GenericException

purgeVersionHistory

@Path(value="/purgeVersionHistory")
public void purgeVersionHistory(String docId)
                                                             throws GenericException

Throws:

GenericException

getVersionHistorySize

@Path(value="/getVersionHistorySize")
public long getVersionHistorySize(String docId)
                                                                 throws GenericException

Throws:

GenericException

isValid

@Path(value="/isValid")
public boolean isValid(String docId)
                                        throws GenericException

Throws:

GenericException

getPath

@Path(value="/getPath/{uuid}")
public String getPath(String uuid)
                                              throws GenericException

Throws:

GenericException