org.nuxeo.ecm.platform.wi.backend

Interface Backend

All Known Subinterfaces:

VirtualBackend

All Known Implementing Classes:

AbstractCoreBackend, AbstractVirtualBackend, SearchRootBackend, SearchVirtualBackend, SimpleBackend, SimpleRootBackend

public interface Backend

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canUnlock(DocumentRef ref)
DocumentModel	copyItem(DocumentModel source, PathRef targetParentRef)
DocumentModel	createFile(String parentPath, String name)
DocumentModel	createFile(String parentPath, String name, Blob content)
DocumentModel	createFolder(String parentPath, String name)
void	destroy()
void	discardChanges()
boolean	exists(String location)
Backend	getBackend(String path)
String	getBackendDisplayName()
String	getCheckoutUser(DocumentRef ref)
List<DocumentModel>	getChildren(DocumentRef ref)
String	getDisplayName(DocumentModel doc)
DocumentModel	getDocument(String location)
String	getRootPath()
String	getRootUrl()
CoreSession	getSession()
CoreSession	getSession(boolean synchronize)
LinkedList<String>	getVirtualFolderNames()
String	getVirtualPath(String path)
boolean	hasPermission(DocumentRef docRef, String permission)
boolean	isLocked(DocumentRef ref)
boolean	isRename(String source, String destination)
boolean	isRoot()
boolean	isVirtual()
String	lock(DocumentRef ref)
DocumentModel	moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
DocumentModel	moveItem(DocumentModel source, PathRef targetParentRef)
Path	parseLocation(String location)
void	removeItem(DocumentRef ref)
void	removeItem(String location)
void	renameItem(DocumentModel source, String destinationName)
DocumentModel	resolveLocation(String location)
void	saveChanges()
void	setSession(CoreSession session)
boolean	unlock(DocumentRef ref)
DocumentModel	updateDocument(DocumentModel doc, String name, Blob content)

Method Detail

getRootPath

String getRootPath()

getRootUrl

String getRootUrl()

getSession

CoreSession getSession()
                       throws ClientException

Throws:

ClientException

setSession

void setSession(CoreSession session)

getSession

CoreSession getSession(boolean synchronize)
                       throws ClientException

Throws:

ClientException

getBackendDisplayName

String getBackendDisplayName()

saveChanges

void saveChanges()
                 throws ClientException

Throws:

ClientException

discardChanges

void discardChanges()
                    throws ClientException

Throws:

ClientException

isLocked

boolean isLocked(DocumentRef ref)
                 throws ClientException

Throws:

ClientException

canUnlock

boolean canUnlock(DocumentRef ref)
                  throws ClientException

Throws:

ClientException

lock

String lock(DocumentRef ref)
            throws ClientException

Throws:

ClientException

unlock

boolean unlock(DocumentRef ref)
               throws ClientException

Throws:

ClientException

getCheckoutUser

String getCheckoutUser(DocumentRef ref)
                       throws ClientException

Throws:

ClientException

parseLocation

Path parseLocation(String location)

resolveLocation

DocumentModel resolveLocation(String location)
                              throws ClientException

Throws:

ClientException

removeItem

void removeItem(String location)
                throws ClientException

Throws:

ClientException

removeItem

void removeItem(DocumentRef ref)
                throws ClientException

Throws:

ClientException

renameItem

void renameItem(DocumentModel source,
              String destinationName)
                throws ClientException

Throws:

ClientException

moveItem

DocumentModel moveItem(DocumentModel source,
                     PathRef targetParentRef)
                       throws ClientException

Throws:

ClientException

moveItem

DocumentModel moveItem(DocumentModel source,
                     DocumentRef targetParentRef,
                     String name)
                       throws ClientException

Throws:

ClientException

updateDocument

DocumentModel updateDocument(DocumentModel doc,
                           String name,
                           Blob content)
                             throws ClientException

Throws:

ClientException

copyItem

DocumentModel copyItem(DocumentModel source,
                     PathRef targetParentRef)
                       throws ClientException

Throws:

ClientException

createFolder

DocumentModel createFolder(String parentPath,
                         String name)
                           throws ClientException

Throws:

ClientException

createFile

DocumentModel createFile(String parentPath,
                       String name,
                       Blob content)
                         throws ClientException

Throws:

ClientException

createFile

DocumentModel createFile(String parentPath,
                       String name)
                         throws ClientException

Throws:

ClientException

getChildren

List<DocumentModel> getChildren(DocumentRef ref)
                                throws ClientException

Throws:

ClientException

isRename

boolean isRename(String source,
               String destination)

exists

boolean exists(String location)

hasPermission

boolean hasPermission(DocumentRef docRef,
                    String permission)
                      throws ClientException

Throws:

ClientException

getDisplayName

String getDisplayName(DocumentModel doc)

getVirtualFolderNames

LinkedList<String> getVirtualFolderNames()
                                         throws ClientException

Throws:

ClientException

getBackend

Backend getBackend(String path)

isVirtual

boolean isVirtual()

isRoot

boolean isRoot()

destroy

void destroy()

getVirtualPath

String getVirtualPath(String path)
                      throws ClientException

Throws:

ClientException

getDocument

DocumentModel getDocument(String location)
                          throws ClientException

Throws:

ClientException