org.nuxeo.ecm.directory

Interface Reference

All Known Implementing Classes:

AbstractReference, InverseReference, LDAPReference, LDAPTreeReference, MultiReference, TableReference

public interface Reference

Base interface for references between directory fields.

References are used to leverage SQL joins or attributes that store a list of distinguished names in LDAP servers (e.g. uniqueMember).

In nuxeo directories, references are special entry fields that are string list of entry ids of a target directory.

Author:

ogrisel

Method Summary

Methods

Modifier and Type	Method and Description
void	addLinks(List<String> sourceIds, String targetId)
void	addLinks(String sourceId, List<String> targetIds)
Reference	clone() Returns a clone, added for hot reload support.
String	getFieldName()
Directory	getSourceDirectory()
List<String>	getSourceIdsForTarget(String targetId)
Directory	getTargetDirectory()
List<String>	getTargetIdsForSource(String sourceId)
void	removeLinksForSource(String sourceId)
void	removeLinksForTarget(String targetId)
void	setSourceDirectoryName(String sourceDirectoryName)
void	setSourceIdsForTarget(String targetId, List<String> sourceIds)
void	setTargetDirectoryName(String targetDirectoryName)
void	setTargetIdsForSource(String sourceId, List<String> targetIds)

Method Detail

getFieldName

String getFieldName()

getSourceDirectory

Directory getSourceDirectory()
                             throws DirectoryException

Throws:

DirectoryException

setSourceDirectoryName

void setSourceDirectoryName(String sourceDirectoryName)

getTargetDirectory

Directory getTargetDirectory()
                             throws DirectoryException

Throws:

DirectoryException

setTargetDirectoryName

void setTargetDirectoryName(String targetDirectoryName)

addLinks

void addLinks(String sourceId,
            List<String> targetIds)
              throws DirectoryException

Throws:

DirectoryException

addLinks

void addLinks(List<String> sourceIds,
            String targetId)
              throws DirectoryException

Throws:

DirectoryException

removeLinksForSource

void removeLinksForSource(String sourceId)
                          throws DirectoryException

Throws:

DirectoryException

removeLinksForTarget

void removeLinksForTarget(String targetId)
                          throws DirectoryException

Throws:

DirectoryException

getTargetIdsForSource

List<String> getTargetIdsForSource(String sourceId)
                                   throws DirectoryException

Throws:

DirectoryException

getSourceIdsForTarget

List<String> getSourceIdsForTarget(String targetId)
                                   throws DirectoryException

Throws:

DirectoryException

setTargetIdsForSource

void setTargetIdsForSource(String sourceId,
                         List<String> targetIds)
                           throws DirectoryException

Throws:

DirectoryException

setSourceIdsForTarget

void setSourceIdsForTarget(String targetId,
                         List<String> sourceIds)
                           throws DirectoryException

Throws:

DirectoryException

clone

Reference clone()

Returns a clone, added for hot reload support.

Since:

5.6