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 Summary

Methods

Modifier and Type	Method and Description
void	addRelation(CoreSession session, DocumentModel from, DocumentModel to, String predicate, boolean inverse) Add link between two document
void	addRelation(CoreSession session, DocumentModel from, Node to, String predicate) Add link between two document
void	addRelation(CoreSession session, DocumentModel from, Node to, String predicate, boolean inverse) Add link between two document
void	addRelation(CoreSession session, DocumentModel from, Node to, String predicate, boolean inverse, boolean includeStatementsInEvents) Add link between two document
void	addRelation(CoreSession session, DocumentModel from, Node to, String predicate, boolean inverse, boolean includeStatementsInEvents, String comment) Add link between two document
void	deleteRelation(CoreSession session, DocumentModel from, DocumentModel to, String predicate)
void	deleteRelation(CoreSession session, DocumentModel from, DocumentModel to, String predicate, boolean includeStatementsInEvents)
void	deleteRelation(CoreSession session, Statement statement)
void	deleteRelation(CoreSession session, Statement stmt, boolean includeStatementsInEvents)

Method Detail

addRelation

void addRelation(CoreSession session,
               DocumentModel from,
               DocumentModel to,
               String predicate,
               boolean inverse)
                 throws ClientException

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:

ClientException

RelationAlreadyExistsException

addRelation

void addRelation(CoreSession session,
               DocumentModel from,
               Node to,
               String predicate,
               boolean inverse)
                 throws ClientException

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:

ClientException

RelationAlreadyExistsException

addRelation

void addRelation(CoreSession session,
               DocumentModel from,
               Node to,
               String predicate)
                 throws ClientException

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:

ClientException

RelationAlreadyExistsException

addRelation

void addRelation(CoreSession session,
               DocumentModel from,
               Node to,
               String predicate,
               boolean inverse,
               boolean includeStatementsInEvents)
                 throws ClientException

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:

ClientException

RelationAlreadyExistsException

addRelation

void addRelation(CoreSession session,
               DocumentModel from,
               Node to,
               String predicate,
               boolean inverse,
               boolean includeStatementsInEvents,
               String comment)
                 throws ClientException

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:

ClientException

RelationAlreadyExistsException

deleteRelation

void deleteRelation(CoreSession session,
                  DocumentModel from,
                  DocumentModel to,
                  String predicate)
                    throws ClientException

Parameters:

from - document

to - document

predicate - relation type

Throws:

ClientException

deleteRelation

void deleteRelation(CoreSession session,
                  Statement statement)
                    throws ClientException

Parameters:

statement - to delete

Throws:

ClientException

deleteRelation

void deleteRelation(CoreSession session,
                  Statement stmt,
                  boolean includeStatementsInEvents)
                    throws ClientException

Parameters:

stmt - to delete

includeStatementsInEvents - add the current statement in event RelationEvents.BEFORE_RELATION_REMOVAL and RelationEvents.AFTER_RELATION_REMOVAL

Throws:

ClientException

deleteRelation

void deleteRelation(CoreSession session,
                  DocumentModel from,
                  DocumentModel to,
                  String predicate,
                  boolean includeStatementsInEvents)
                    throws ClientException

Parameters:

from - document

to - document

predicate - relation type

includeStatementsInEvents - add the current statement in event RelationEvents.BEFORE_RELATION_REMOVAL and RelationEvents.AFTER_RELATION_REMOVAL

Throws:

ClientException