Package org.nuxeo.ecm.platform.relations.api

Interface DocumentRelationManager

All Known Implementing Classes:
DocumentRelationService
public interface DocumentRelationManager
Create relations between documents
Since:
5.9.2

  • Method Details

    • addRelation

      void addRelation(CoreSession session, DocumentModel from, DocumentModel to, String predicate, boolean inverse)
      Add link between two document
      Parameters:
      from - the document to link from
      to - the document to link to
      predicate - is the type of link
      inverse - if to is related to from ( the event will still be generated with from document )
      Throws:
      RelationAlreadyExistsException - if given relation already exists

    • addRelation

      void addRelation(CoreSession session, DocumentModel from, Node to, String predicate, boolean inverse)
      Add link between two document
      Parameters:
      from - the document to link from
      to - the node to link to
      predicate - is the type of link
      inverse - if to is related to from ( the event will still be generated with from document )
      Throws:
      RelationAlreadyExistsException - if given relation already exists

    • addRelation

      void addRelation(CoreSession session, DocumentModel from, Node to, String predicate)
      Add link between two document
      Parameters:
      from - the document to link from
      to - the node to link to
      predicate - is the type of link
      Throws:
      RelationAlreadyExistsException - if given relation already exists

    • addRelation

      void addRelation(CoreSession session, DocumentModel from, Node to, String predicate, boolean inverse, boolean includeStatementsInEvents)
      Add link between two document
      Parameters:
      from - the document to link from
      to - the node to link to
      predicate - is the type of link
      inverse - if to is related to from ( the event will still be generated with from document )
      includeStatementsInEvents - will add the statement to the events RelationEvents.BEFORE_RELATION_CREATION and RelationEvents.AFTER_RELATION_CREATION
      Throws:
      RelationAlreadyExistsException - if given relation already exists

    • addRelation

      void addRelation(CoreSession session, DocumentModel from, Node to, String predicate, boolean inverse, boolean includeStatementsInEvents, String comment)
      Add link between two document
      Parameters:
      from - the document to link from
      to - the node to link to
      predicate - is the type of link
      inverse - if to is related to from ( the event will still be generated with from document )
      includeStatementsInEvents - will add the statement to the events RelationEvents.BEFORE_RELATION_CREATION and RelationEvents.AFTER_RELATION_CREATION
      comment - of the relation
      Throws:
      RelationAlreadyExistsException - if given relation already exists

    • deleteRelation

      void deleteRelation(CoreSession session, DocumentModel from, DocumentModel to, String predicate)
      Parameters:
      from - document
      to - document
      predicate - relation type

    • deleteRelation

      void deleteRelation(CoreSession session, Statement statement)
      Parameters:
      statement - to delete

    • deleteRelation

      void deleteRelation(CoreSession session, Statement stmt, boolean includeStatementsInEvents)
      Parameters:
      stmt - to delete
      includeStatementsInEvents - add the current statement in event RelationEvents.BEFORE_RELATION_REMOVAL and RelationEvents.AFTER_RELATION_REMOVAL

    • deleteRelation

      void deleteRelation(CoreSession session, DocumentModel from, DocumentModel to, String predicate, boolean includeStatementsInEvents)
      Parameters:
      from - document
      to - document
      predicate - relation type
      includeStatementsInEvents - add the current statement in event RelationEvents.BEFORE_RELATION_REMOVAL and RelationEvents.AFTER_RELATION_REMOVAL