Package 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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description 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 idsvoid
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 idString
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 idvoid
removeLinksForTarget(String targetId)
void
removeLinksForTarget(String targetId, Session session)
Removes all the links for a given target idvoid
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 idvoid
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()
-
setSourceDirectoryName
void setSourceDirectoryName(String sourceDirectoryName)
-
getTargetDirectory
Directory getTargetDirectory()
-
setTargetDirectoryName
@Deprecated void setTargetDirectoryName(String targetDirectoryName)
Deprecated.since 9.2 (unused)
-
removeLinksForSource
void removeLinksForSource(String sourceId)
-
removeLinksForTarget
void removeLinksForTarget(String targetId)
-
addLinks
void addLinks(String sourceId, List<String> targetIds, Session session)
Adds the links between the source id and the target ids- Parameters:
sourceId
- the source idtargetIds
- the target idssession
- the session- Since:
- 9.2
-
addLinks
void addLinks(List<String> sourceIds, String targetId, Session session)
Adds the links between the source ids and the target id- Parameters:
sourceIds
- the source idstargetId
- the target idsession
- the session- Since:
- 9.2
-
setSourceIdsForTarget
void setSourceIdsForTarget(String targetId, List<String> sourceIds, Session session)
Sets all source ids to be associated to the given target id- Parameters:
targetId
- the target idsourceIds
- the source idssession
- the session- Since:
- 9.2
-
setTargetIdsForSource
void setTargetIdsForSource(String sourceId, List<String> targetIds, Session session)
Sets all target ids to be associated to the given source id- Parameters:
sourceId
- the source idtargetIds
- the target idssession
- the session- Since:
- 9.2
-
removeLinksForTarget
void removeLinksForTarget(String targetId, Session session)
Removes all the links for a given target id- Parameters:
targetId
- the target idsession
- the session- Since:
- 9.2
-
-