com.openkm.frontend.client.service

Interface OKMDocumentService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

DocumentServlet

@RemoteServiceRelativePath(value="Document")
public interface OKMDocumentService
extends com.google.gwt.user.client.rpc.RemoteService

Author:

jllort

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelCheckout(String docPath)
void	checkout(String docPath)
String	convertToPdf(String docPath)
void	copy(String docPath, String fldPath)
GWTDocument	createFromTemplate(String docPath, String destinationPath, List<GWTFormElement> formProperties, Map<String,List<Map<String,String>>> tableProperties)
void	createFromTemplate(String docPath, String fldPath, String name, GWTExtendedAttributes attributes)
void	delete(String docPath)
void	forceCancelCheckout(String docPath)
void	forceUnlock(String docPath)
GWTDocument	get(String docPath)
List<GWTDocument>	getAllTemplates()
List<GWTDocument>	getChilds(String fldId, Map<String,GWTFilter> mapFilter)
List<GWTVersion>	getVersionHistory(String docPath)
Long	getVersionHistorySize(String docPath)
Boolean	isValid(String docPath)
void	lock(String docPath)
void	mergePdf(String docName, List<String> paths)
void	move(String docPath, String destPath)
void	purge(String docPath)
void	purgeVersionHistory(String docPath)
GWTDocument	rename(String docPath, String newName)
void	restoreVersion(String docPath, String versionId)
void	unlock(String docPath)
String	updateFromTemplate(String docPath, String destinationPath, List<GWTFormElement> formProperties, Map<String,List<Map<String,String>>> tableProperties)

Method Detail

getChilds

List<GWTDocument> getChilds(String fldId,
                          Map<String,GWTFilter> mapFilter)
                            throws OKMException

Throws:

OKMException

getVersionHistory

List<GWTVersion> getVersionHistory(String docPath)
                                   throws OKMException

Throws:

OKMException

delete

void delete(String docPath)
            throws OKMException

Throws:

OKMException

checkout

void checkout(String docPath)
              throws OKMException

Throws:

OKMException

cancelCheckout

void cancelCheckout(String docPath)
                    throws OKMException

Throws:

OKMException

lock

void lock(String docPath)
          throws OKMException

Throws:

OKMException

unlock

void unlock(String docPath)
            throws OKMException

Throws:

OKMException

rename

GWTDocument rename(String docPath,
                 String newName)
                   throws OKMException

Throws:

OKMException

move

void move(String docPath,
        String destPath)
          throws OKMException

Throws:

OKMException

purge

void purge(String docPath)
           throws OKMException

Throws:

OKMException

restoreVersion

void restoreVersion(String docPath,
                  String versionId)
                    throws OKMException

Throws:

OKMException

get

GWTDocument get(String docPath)
                throws OKMException

Throws:

OKMException

copy

void copy(String docPath,
        String fldPath)
          throws OKMException

Throws:

OKMException

isValid

Boolean isValid(String docPath)
                throws OKMException

Throws:

OKMException

getVersionHistorySize

Long getVersionHistorySize(String docPath)
                           throws OKMException

Throws:

OKMException

purgeVersionHistory

void purgeVersionHistory(String docPath)
                         throws OKMException

Throws:

OKMException

forceUnlock

void forceUnlock(String docPath)
                 throws OKMException

Throws:

OKMException

forceCancelCheckout

void forceCancelCheckout(String docPath)
                         throws OKMException

Throws:

OKMException

createFromTemplate

GWTDocument createFromTemplate(String docPath,
                             String destinationPath,
                             List<GWTFormElement> formProperties,
                             Map<String,List<Map<String,String>>> tableProperties)
                               throws OKMException

Throws:

OKMException

updateFromTemplate

String updateFromTemplate(String docPath,
                        String destinationPath,
                        List<GWTFormElement> formProperties,
                        Map<String,List<Map<String,String>>> tableProperties)
                          throws OKMException

Throws:

OKMException

convertToPdf

String convertToPdf(String docPath)
                    throws OKMException

Throws:

OKMException

mergePdf

void mergePdf(String docName,
            List<String> paths)
              throws OKMException

Throws:

OKMException

getAllTemplates

List<GWTDocument> getAllTemplates()
                                  throws OKMException

Throws:

OKMException

createFromTemplate

void createFromTemplate(String docPath,
                      String fldPath,
                      String name,
                      GWTExtendedAttributes attributes)
                        throws OKMException

Throws:

OKMException