|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DirectoryService
Field Summary | |
---|---|
static ComponentName |
NAME
|
Method Summary | |
---|---|
List<Directory> |
getDirectories()
Return all the directories registered into the service. |
Directory |
getDirectory(String directoryName)
Return the directory with the name directoryName. |
Directory |
getDirectory(String directoryName,
DocumentModel documentContext)
Return the directory for the specified context. |
String |
getDirectoryIdField(String directoryName)
|
List<String> |
getDirectoryNames()
|
String |
getDirectoryPasswordField(String directoryName)
|
String |
getDirectorySchema(String directoryName)
|
String |
getParentDirectoryName(String directoryName)
Returns the name of the parent directory of specified directory, if applicable. |
Session |
open(String directoryName)
Opens a session on specified directory. |
Session |
open(String directoryName,
DocumentModel documentContext)
Opens a session on the directory for the specified context. |
void |
registerDirectory(String directoryName,
DirectoryFactory factory)
|
void |
unregisterDirectory(String directoryName,
DirectoryFactory factory)
|
Field Detail |
---|
static final ComponentName NAME
Method Detail |
---|
List<String> getDirectoryNames() throws ClientException
ClientException
String getDirectorySchema(String directoryName) throws DirectoryException
DirectoryException
Session open(String directoryName) throws DirectoryException
This method prefers to throw rather than returning null.
directoryName
-
DirectoryException
- in case the session cannot be createdSession open(String directoryName, DocumentModel documentContext) throws DirectoryException
This method prefers to throw rather than returning null.
directoryName
- documentContext
-
DirectoryException
- in case the session cannot be createdDirectory getDirectory(String directoryName, DocumentModel documentContext) throws DirectoryException
If the directoryName is null, return null.
directoryName
- documentContext
-
DirectoryException
Directory getDirectory(String directoryName) throws DirectoryException
If the directoryName is null, return null.
directoryName
-
DirectoryException
List<Directory> getDirectories() throws DirectoryException
DirectoryException
void registerDirectory(String directoryName, DirectoryFactory factory)
void unregisterDirectory(String directoryName, DirectoryFactory factory)
String getDirectoryIdField(String directoryName) throws DirectoryException
DirectoryException
String getDirectoryPasswordField(String directoryName) throws DirectoryException
DirectoryException
String getParentDirectoryName(String directoryName) throws DirectoryException
directoryName
-
DirectoryException
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |