All Known Subinterfaces:

VirtualBackend

All Known Implementing Classes:

AbstractCoreBackend, AbstractVirtualBackend, SearchRootBackend, SearchVirtualBackend, SimpleBackend, SimpleRootBackend
```
public interface Backend
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`canUnlock(DocumentRef ref)`
`DocumentModel`	`copyItem(DocumentModel source, PathRef targetParentRef)`
`DocumentModel`	`createFile(String parentPath, String name)`	Deprecated. since 10.10, unused
`DocumentModel`	`createFile(String parentPath, String name, Blob content)`
`DocumentModel`	`createFolder(String parentPath, String name)`
`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()`	Deprecated. since 10.10, unused
`String`	`getRootUrl()`	Deprecated. since 10.10, unused
`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)`	Deprecated. since 10.10, unused
`boolean`	`isRoot()`	Deprecated. since 10.10, unused
`boolean`	`isVirtual()`
`String`	`lock(DocumentRef ref)`
`DocumentModel`	`moveItem(DocumentModel source, DocumentRef targetParentRef, String name)`
`DocumentModel`	`moveItem(DocumentModel source, PathRef targetParentRef)`	Deprecated. since 10.10, unused
`Path`	`parseLocation(String location)`
`void`	`removeItem(String location)`
`void`	`removeItem(DocumentRef ref)`
`void`	`renameItem(DocumentModel source, String destinationName)`	Deprecated. since 10.10, unused, use `moveItem(org.nuxeo.ecm.core.api.DocumentModel, org.nuxeo.ecm.core.api.PathRef)` instead
`DocumentModel`	`resolveLocation(String location)`
`void`	`saveChanges()`
`boolean`	`unlock(DocumentRef ref)`
`DocumentModel`	`updateDocument(DocumentModel doc, String name, Blob content)`

Method Detail

getRootPath
```
@Deprecated
String getRootPath()
```
Deprecated.
since 10.10, unused

getRootUrl
```
@Deprecated
String getRootUrl()
```
Deprecated.
since 10.10, unused

getSession
```
CoreSession getSession()
```

getSession

CoreSession getSession(boolean synchronize)

getBackendDisplayName
```
String getBackendDisplayName()
```

saveChanges
```
void saveChanges()
```

isLocked
```
boolean isLocked(DocumentRef ref)
```

canUnlock
```
boolean canUnlock(DocumentRef ref)
```

lock
```
String lock(DocumentRef ref)
```

unlock
```
boolean unlock(DocumentRef ref)
```

getCheckoutUser

String getCheckoutUser(DocumentRef ref)

parseLocation

Path parseLocation(String location)

resolveLocation

DocumentModel resolveLocation(String location)

removeItem
```
void removeItem(String location)
```

removeItem
```
void removeItem(DocumentRef ref)
```

renameItem
```
@Deprecated
void renameItem(DocumentModel source,
                String destinationName)
```
Deprecated.
since 10.10, unused, use moveItem(org.nuxeo.ecm.core.api.DocumentModel, org.nuxeo.ecm.core.api.PathRef) instead

moveItem

@Deprecated
DocumentModel moveItem(DocumentModel source,
                       PathRef targetParentRef)

Deprecated.

since 10.10, unused

moveItem

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

updateDocument

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

copyItem

DocumentModel copyItem(DocumentModel source,
                       PathRef targetParentRef)

createFolder

DocumentModel createFolder(String parentPath,
                           String name)

createFile

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

createFile

@Deprecated
DocumentModel createFile(String parentPath,
                         String name)

Deprecated.

since 10.10, unused

getChildren

List<DocumentModel> getChildren(DocumentRef ref)

isRename

@Deprecated
boolean isRename(String source,
                 String destination)

Deprecated.

since 10.10, unused

exists
```
boolean exists(String location)
```

hasPermission

boolean hasPermission(DocumentRef docRef,
                      String permission)

getDisplayName

String getDisplayName(DocumentModel doc)

getVirtualFolderNames

LinkedList<String> getVirtualFolderNames()

getBackend
```
Backend getBackend(String path)
```

isVirtual
```
boolean isVirtual()
```

isRoot
```
@Deprecated
boolean isRoot()
```
Deprecated.
since 10.10, unused

getVirtualPath
```
String getVirtualPath(String path)
```

getDocument

DocumentModel getDocument(String location)

Interface Backend

Method Summary

Method Detail

getRootPath

getRootUrl

getSession

getSession

getBackendDisplayName

saveChanges

isLocked

canUnlock

lock

unlock

getCheckoutUser

parseLocation

resolveLocation

removeItem

removeItem

renameItem

moveItem

moveItem

updateDocument

copyItem

createFolder

createFile

createFile

getChildren

isRename

exists

hasPermission

getDisplayName

getVirtualFolderNames

getBackend

isVirtual

isRoot

getVirtualPath

getDocument