org.nuxeo.ecm.social.relationship.service

Class RelationshipServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.social.relationship.service.RelationshipServiceImpl

All Implemented Interfaces:

RelationshipService, Adaptable, Component, Extensible, TimestampedService

public class RelationshipServiceImpl
extends DefaultComponent
implements RelationshipService

Default implementation of RelationshipService.

Since:

5.5

Author:

Arnaud Kervern

Field Summary

Fields

Modifier and Type	Field and Description
static String	KINDS_EXTENSION_POINT

Constructor Summary

Constructors

Constructor and Description
RelationshipServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
Boolean	addRelation(String actorId, String targetId, RelationshipKind kind) Adds a relation between two entities.
void	deactivate(ComponentContext context) Deactivates the component.
List<RelationshipKind>	getRegisteredKinds(String group) Gets registered (contributed with the extension point) relationship kinds depending of a group
List<RelationshipKind>	getRelationshipKinds(String actorId, String targetId) Gets all existing relationship kinds between an actor and a target.
List<String>	getTargets(String actorId) Gets all targets of an actor.
List<String>	getTargetsOfKind(String actorId, RelationshipKind kind) Gets all targets of a specific relation.
List<String>	getTargetsWithFulltext(String actorId, RelationshipKind kind, String targetPattern) Gets all targets that match the targetPattern with the given kind.
List<String>	getTargetsWithFulltext(String actorId, String targetPattern) Gets all targets that match the targetPattern.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
Boolean	removeRelation(String actorId, String targetId, RelationshipKind kind) Removes a relationship composed by parameters

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

KINDS_EXTENSION_POINT

public static final String KINDS_EXTENSION_POINT

See Also:

Constant Field Values

Constructor Detail

RelationshipServiceImpl

public RelationshipServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

getRelationshipKinds

public List<RelationshipKind> getRelationshipKinds(String actorId,
                                          String targetId)

Description copied from interface: RelationshipService

Gets all existing relationship kinds between an actor and a target.

Specified by:

getRelationshipKinds in interface RelationshipService

getTargetsOfKind

public List<String> getTargetsOfKind(String actorId,
                            RelationshipKind kind)

Description copied from interface: RelationshipService

Gets all targets of a specific relation.

Specified by:

getTargetsOfKind in interface RelationshipService

kind - if null, it will return all targets RelationshipService.getTargets(java.lang.String), it can be only filled with the group or the name

getTargets

public List<String> getTargets(String actorId)

Description copied from interface: RelationshipService

Gets all targets of an actor.

Specified by:

getTargets in interface RelationshipService

getTargetsWithFulltext

public List<String> getTargetsWithFulltext(String actorId,
                                  String targetPattern)

Description copied from interface: RelationshipService

Gets all targets that match the targetPattern.

Specified by:

getTargetsWithFulltext in interface RelationshipService

getTargetsWithFulltext

public List<String> getTargetsWithFulltext(String actorId,
                                  RelationshipKind kind,
                                  String targetPattern)

Description copied from interface: RelationshipService

Gets all targets that match the targetPattern with the given kind.

Specified by:

getTargetsWithFulltext in interface RelationshipService

getRegisteredKinds

public List<RelationshipKind> getRegisteredKinds(String group)

Description copied from interface: RelationshipService

Gets registered (contributed with the extension point) relationship kinds depending of a group

Specified by:

getRegisteredKinds in interface RelationshipService

Parameters:

group - can be null, or empty if you want to get all kinds

Returns:

an UnmodifiableList with all user relationship types

addRelation

public Boolean addRelation(String actorId,
                  String targetId,
                  RelationshipKind kind)

Description copied from interface: RelationshipService

Adds a relation between two entities.

Specified by:

addRelation in interface RelationshipService

Returns:

true if a new relation is created, false otherwise.

removeRelation

public Boolean removeRelation(String actorId,
                     String targetId,
                     RelationshipKind kind)

Description copied from interface: RelationshipService

Removes a relationship composed by parameters

Specified by:

removeRelation in interface RelationshipService

Returns:

true if a relation has been deleted, false otherwise