org.nuxeo.ecm.directory

Interface Reference

All Known Implementing Classes:

AbstractReference, InverseReference, LDAPReference, LDAPTreeReference, MongoDBReference, 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

Modifier and Type	Method and Description
void	addLinks(List<String> sourceIds, String targetId)
void	addLinks(List<String> sourceIds, String targetId, Session session) Adds the links between the source ids and the target id
void	addLinks(String sourceId, List<String> targetIds)
void	addLinks(String sourceId, List<String> targetIds, Session session) Adds the links between the source id and the target ids
String	getFieldName()
Directory	getSourceDirectory()
List<String>	getSourceIdsForTarget(String targetId)
Directory	getTargetDirectory()
List<String>	getTargetIdsForSource(String sourceId)
void	removeLinksForSource(String sourceId)
void	removeLinksForSource(String sourceId, Session session) Removes all the links for a given source id
void	removeLinksForTarget(String targetId)
void	removeLinksForTarget(String targetId, Session session) Removes all the links for a given target id
void	setSourceDirectoryName(String sourceDirectoryName)
void	setSourceIdsForTarget(String targetId, List<String> sourceIds)
void	setSourceIdsForTarget(String targetId, List<String> sourceIds, Session session) Sets all source ids to be associated to the given target id
void	setTargetDirectoryName(String targetDirectoryName) Deprecated. since 9.2 (unused)
void	setTargetIdsForSource(String sourceId, List<String> targetIds)
void	setTargetIdsForSource(String sourceId, List<String> targetIds, Session session) Sets all target ids to be associated to the given source id

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

@Deprecated
void setTargetDirectoryName(String targetDirectoryName)

Deprecated. since 9.2 (unused)

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

addLinks

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

Adds the links between the source id and the target ids

Parameters:

sourceId - the source id

targetIds - the target ids

session - the session

Throws:

DirectoryException

Since:

9.2

addLinks

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

Adds the links between the source ids and the target id

Parameters:

sourceIds - the source ids

targetId - the target id

session - the session

Throws:

DirectoryException

Since:

9.2

setSourceIdsForTarget

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

Sets all source ids to be associated to the given target id

Parameters:

targetId - the target id

sourceIds - the source ids

session - the session

Throws:

DirectoryException

Since:

9.2

setTargetIdsForSource

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

Sets all target ids to be associated to the given source id

Parameters:

sourceId - the source id

targetIds - the target ids

session - the session

Throws:

DirectoryException

Since:

9.2

removeLinksForTarget

void removeLinksForTarget(String targetId,
                          Session session)
                   throws DirectoryException

Removes all the links for a given target id

Parameters:

targetId - the target id

session - the session

Throws:

DirectoryException

Since:

9.2

removeLinksForSource

void removeLinksForSource(String sourceId,
                          Session session)
                   throws DirectoryException

Removes all the links for a given source id

Parameters:

sourceId - the source id

session - the session

Throws:

DirectoryException

Since:

9.2