org.nuxeo.ecm.platform.relations.services

Class DocumentRelationService

java.lang.Object

org.nuxeo.ecm.platform.relations.services.DocumentRelationService

All Implemented Interfaces:

DocumentRelationManager

public class DocumentRelationService
extends Object
implements DocumentRelationManager

Since:

5.9.2

Constructor Summary

Constructors

Constructor and Description
DocumentRelationService()

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 toResource, 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 stmt)
void	deleteRelation(CoreSession session, Statement stmt, boolean includeStatementsInEvents)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentRelationService

public DocumentRelationService()

Method Detail

addRelation

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

Description copied from interface: DocumentRelationManager

Add link between two document

Specified by:

addRelation in interface DocumentRelationManager

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

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

Description copied from interface: DocumentRelationManager

Add link between two document

Specified by:

addRelation in interface DocumentRelationManager

from - the document to link from

to - the node to link to

predicate - is the type of link

Throws:

ClientException

RelationAlreadyExistsException

addRelation

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

Description copied from interface: DocumentRelationManager

Add link between two document

Specified by:

addRelation in interface DocumentRelationManager

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

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

Description copied from interface: DocumentRelationManager

Add link between two document

Specified by:

addRelation in interface DocumentRelationManager

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

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

Description copied from interface: DocumentRelationManager

Add link between two document

Specified by:

addRelation in interface DocumentRelationManager

from - the document to link from

toResource - 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

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

Specified by:

deleteRelation in interface DocumentRelationManager

from - document

to - document

predicate - relation type

Throws:

ClientException

deleteRelation

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

Specified by:

deleteRelation in interface DocumentRelationManager

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

deleteRelation

public void deleteRelation(CoreSession session,
                  Statement stmt)
                    throws ClientException

Specified by:

deleteRelation in interface DocumentRelationManager

stmt - to delete

Throws:

ClientException

deleteRelation

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

Specified by:

deleteRelation in interface DocumentRelationManager

stmt - to delete

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

Throws:

ClientException