org.nuxeo.ecm.social.mini.message

Interface MiniMessageService

All Known Implementing Classes:

MiniMessageServiceImpl

public interface MiniMessageService

Service handling mini messages.

Since:

5.5

Author:

Thomas Roger

Method Summary

Methods

Modifier and Type	Method and Description
MiniMessage	addMiniMessage(Principal principal, String message) Add a new mini message.
MiniMessage	addMiniMessage(Principal principal, String message, Date publishedDate) Add a new mini message.
MiniMessage	addMiniMessage(Principal principal, String message, Date publishedDate, String contextActivityObject) Add a new mini message for the given context.
MiniMessage	getMiniMessage(Serializable miniMessageId) Returns the mini message for the given miniMessageId, or null if no mini message exists with the given miniMessageId.
ActivitiesList	getMiniMessageActivitiesFor(String actorActivityObject, RelationshipKind relationshipKind, long offset, long limit) Returns the mini messages, as a list of Activity, for the given actorActivityObject.
ActivitiesList	getMiniMessageActivitiesFor(String actorActivityObject, RelationshipKind relationshipKind, String contextActivityObject, long offset, long limit) Returns the mini messages, as a list of Activity, for the given actorActivityObject and contextActivityObject.
ActivitiesList	getMiniMessageActivitiesFrom(String actorActivityObject, long offset, long limit) Returns the mini messages, as a list of Activity, from the given actorActivityObject.
List<MiniMessage>	getMiniMessageFor(String actorActivityObject, RelationshipKind relationshipKind, long offset, long limit) Returns the mini messages for the given actorActivityObject.
List<MiniMessage>	getMiniMessageFor(String actorActivityObject, RelationshipKind relationshipKind, String contextActivityObject, long offset, long limit) Returns the mini messages for the given actorActivityObject and contextActivityObject.
List<MiniMessage>	getMiniMessageFrom(String actorActivityObject, long offset, long limit) Returns the mini messages from the given actorActivityObject.
void	removeMiniMessage(MiniMessage miniMessage) Remove a mini message.

Method Detail

addMiniMessage

MiniMessage addMiniMessage(Principal principal,
                         String message,
                         Date publishedDate)

Add a new mini message.

Returns:

the newly created MiniMessage object.

addMiniMessage

MiniMessage addMiniMessage(Principal principal,
                         String message,
                         Date publishedDate,
                         String contextActivityObject)

Add a new mini message for the given context.

Returns:

the newly created MiniMessage object.

addMiniMessage

MiniMessage addMiniMessage(Principal principal,
                         String message)

Add a new mini message.

Returns:

the newly created MiniMessage object.

removeMiniMessage

void removeMiniMessage(MiniMessage miniMessage)

Remove a mini message.

getMiniMessage

MiniMessage getMiniMessage(Serializable miniMessageId)

Returns the mini message for the given miniMessageId, or null if no mini message exists with the given miniMessageId.

Since:

5.6

getMiniMessageFor

List<MiniMessage> getMiniMessageFor(String actorActivityObject,
                                  RelationshipKind relationshipKind,
                                  long offset,
                                  long limit)

Returns the mini messages for the given actorActivityObject. The relationshipKind is used to find people with whom the actor has a relation.

Parameters:

offset - the offset (starting at 0) into the list of mini messages.

limit - the maximum number of mini messages to retrieve, or 0 for all of them.

getMiniMessageFor

List<MiniMessage> getMiniMessageFor(String actorActivityObject,
                                  RelationshipKind relationshipKind,
                                  String contextActivityObject,
                                  long offset,
                                  long limit)

Returns the mini messages for the given actorActivityObject and contextActivityObject. The relationshipKind is used to find people with whom the actor has a relation.

Parameters:

offset - the offset (starting at 0) into the list of mini messages.

limit - the maximum number of mini messages to retrieve, or 0 for all of them.

getMiniMessageFrom

List<MiniMessage> getMiniMessageFrom(String actorActivityObject,
                                   long offset,
                                   long limit)

Returns the mini messages from the given actorActivityObject.

Parameters:

offset - the offset (starting at 0) into the list of mini messages.

limit - the maximum number of mini messages to retrieve, or 0 for all of them.

getMiniMessageActivitiesFor

ActivitiesList getMiniMessageActivitiesFor(String actorActivityObject,
                                         RelationshipKind relationshipKind,
                                         long offset,
                                         long limit)

Returns the mini messages, as a list of Activity, for the given actorActivityObject. The relationshipKind is used to find people with whom the actor has a relation.

Parameters:

offset - the offset (starting at 0) into the list of mini messages.

limit - the maximum number of mini messages to retrieve, or 0 for all of them.

Since:

5.6

getMiniMessageActivitiesFor

ActivitiesList getMiniMessageActivitiesFor(String actorActivityObject,
                                         RelationshipKind relationshipKind,
                                         String contextActivityObject,
                                         long offset,
                                         long limit)

Returns the mini messages, as a list of Activity, for the given actorActivityObject and contextActivityObject. The relationshipKind is used to find people with whom the actor has a relation.

Parameters:

offset - the offset (starting at 0) into the list of mini messages.

limit - the maximum number of mini messages to retrieve, or 0 for all of them.

Since:

5.6

getMiniMessageActivitiesFrom

ActivitiesList getMiniMessageActivitiesFrom(String actorActivityObject,
                                          long offset,
                                          long limit)

Returns the mini messages, as a list of Activity, from the given actorActivityObject.

Parameters:

offset - the offset (starting at 0) into the list of mini messages.

limit - the maximum number of mini messages to retrieve, or 0 for all of them.

Since:

5.6