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 Details

    • getFieldName

      String getFieldName()

    • getSourceDirectory

      Directory getSourceDirectory()

    • setSourceDirectoryName

      void setSourceDirectoryName(String sourceDirectoryName)

    • getTargetDirectory

      Directory getTargetDirectory()

    • setTargetDirectoryName

      void setTargetDirectoryName(String targetDirectoryName)

    • addLinks

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

    • addLinks

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

    • removeLinksForSource

      void removeLinksForSource(String sourceId)

    • removeLinksForTarget

      void removeLinksForTarget(String targetId)

    • getTargetIdsForSource

      List<String> getTargetIdsForSource(String sourceId)

    • getSourceIdsForTarget

      List<String> getSourceIdsForTarget(String targetId)

    • setTargetIdsForSource

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

    • setSourceIdsForTarget

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

    • 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 id
      targetIds - the target ids
      session - 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 ids
      targetId - the target id
      session - 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 id
      sourceIds - the source ids
      session - 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 id
      targetIds - the target ids
      session - 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 id
      session - the session
      Since:
      9.2

    • removeLinksForSource

      void removeLinksForSource(String sourceId, Session session)
      Removes all the links for a given source id
      Parameters:
      sourceId - the source id
      session - the session
      Since:
      9.2