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

void	addLinks(java.util.List<java.lang.String> sourceIds, java.lang.String targetId)
void	addLinks(java.lang.String sourceId, java.util.List<java.lang.String> targetIds)
java.lang.String	getFieldName()
Directory	getSourceDirectory()
java.util.List<java.lang.String>	getSourceIdsForTarget(java.lang.String targetId)
Directory	getTargetDirectory()
java.util.List<java.lang.String>	getTargetIdsForSource(java.lang.String sourceId)
void	removeLinksForSource(java.lang.String sourceId)
void	removeLinksForTarget(java.lang.String targetId)
void	setSourceDirectoryName(java.lang.String sourceDirectoryName)
void	setSourceIdsForTarget(java.lang.String targetId, java.util.List<java.lang.String> sourceIds)
void	setTargetDirectoryName(java.lang.String targetDirectoryName)
void	setTargetIdsForSource(java.lang.String sourceId, java.util.List<java.lang.String> targetIds)

Method Detail

getFieldName

java.lang.String getFieldName()

getSourceDirectory

Directory getSourceDirectory()
                             throws DirectoryException

Throws:

DirectoryException

setSourceDirectoryName

void setSourceDirectoryName(java.lang.String sourceDirectoryName)

getTargetDirectory

Directory getTargetDirectory()
                             throws DirectoryException

Throws:

DirectoryException

setTargetDirectoryName

void setTargetDirectoryName(java.lang.String targetDirectoryName)

addLinks

void addLinks(java.lang.String sourceId,
              java.util.List<java.lang.String> targetIds)
              throws DirectoryException

Throws:

DirectoryException

addLinks

void addLinks(java.util.List<java.lang.String> sourceIds,
              java.lang.String targetId)
              throws DirectoryException

Throws:

DirectoryException

removeLinksForSource

void removeLinksForSource(java.lang.String sourceId)
                          throws DirectoryException

Throws:

DirectoryException

removeLinksForTarget

void removeLinksForTarget(java.lang.String targetId)
                          throws DirectoryException

Throws:

DirectoryException

getTargetIdsForSource

java.util.List<java.lang.String> getTargetIdsForSource(java.lang.String sourceId)
                                                       throws DirectoryException

Throws:

DirectoryException

getSourceIdsForTarget

java.util.List<java.lang.String> getSourceIdsForTarget(java.lang.String targetId)
                                                       throws DirectoryException

Throws:

DirectoryException

setTargetIdsForSource

void setTargetIdsForSource(java.lang.String sourceId,
                           java.util.List<java.lang.String> targetIds)
                           throws DirectoryException

Throws:

DirectoryException

setSourceIdsForTarget

void setSourceIdsForTarget(java.lang.String targetId,
                           java.util.List<java.lang.String> sourceIds)
                           throws DirectoryException

Throws:

DirectoryException