org.nuxeo.ecm.social.workspace.service

Interface SocialWorkspaceService

All Known Implementing Classes:

SocialWorkspaceServiceImpl

public interface SocialWorkspaceService

Service interface for Social Workspace.

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptSubscriptionRequest(SocialWorkspace socialWorkspace, SubscriptionRequest subscriptionRequest) Deprecated. since 5.6 see SocialWorkspace
boolean	addSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace, Principal principal) Adds a user to the socialWorkspace administrators group.
boolean	addSocialWorkspaceMember(SocialWorkspace socialWorkspace, Principal principal) Adds a user to the socialWorkspace members group.
List<String>	addSocialWorkspaceMembers(SocialWorkspace socialWorkspace, List<String> principals) Add several users to the socialWorkspace members group.
List<String>	addSocialWorkspaceMembers(SocialWorkspace socialWorkspace, String groupName) Add all group's users to the socialWorkspace members groups
List<SocialWorkspace>	getDetachedPublicSocialWorkspaces(CoreSession session) Return all public Social Workspaces.
SocialWorkspace	getDetachedSocialWorkspace(CoreSession session, DocumentRef docRef) Returns the SocialWorkspace container of the given document ref if it is in a Social Workspace even if the user does not have right on it, null otherwise.
SocialWorkspace	getDetachedSocialWorkspace(DocumentModel doc) Returns the SocialWorkspace container of the given document if it is in a Social Workspace even if the user does not have right on it, null otherwise.
SocialWorkspace	getSocialWorkspace(DocumentModel doc) Returns the SocialWorkspace container of the given document if it is part of a Social Workspace, null otherwise.
DocumentModel	getSocialWorkspaceContainer(CoreSession session) Returns Social Workspace Container and create it if needed.
SocialWorkspaceContainerDescriptor	getSocialWorkspaceContainerDescriptor() Returns the configured SocialWorkspaceContainerDescriptor that contains the path, title and description of the container.
String	getSubscriptionRequestStatus(SocialWorkspace socialWorkspace, Principal principal) Deprecated.
int	getValidationDays() Gets the number of days before a social workspace expires without validation.
void	handleSocialWorkspaceCreation(SocialWorkspace socialWorkspace, Principal principal) Handles a Social Workspace creation: create related groups put specific ACLs
void	handleSocialWorkspaceDeletion(SocialWorkspace socialWorkspace) Handles a Social Workspace deletion: remove related groups
void	handleSubscriptionRequest(SocialWorkspace socialWorkspace, Principal principal) Handles a Subscription Request on socialWorkspace for the given principal.
boolean	isSubscriptionRequestPending(SocialWorkspace socialWorkspace, Principal principal) Deprecated. since 5.6 see SocialWorkspace
void	makeSocialWorkspacePrivate(SocialWorkspace socialWorkspace) Makes the given socialWorkspace private.
void	makeSocialWorkspacePublic(SocialWorkspace socialWorkspace) Makes the given socialWorkspace public.
void	rejectSubscriptionRequest(SocialWorkspace socialWorkspace, SubscriptionRequest subscriptionRequest) Deprecated. since 5.6 see SocialWorkspace
void	removeSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace, Principal principal) Removes a user from the @{code socialWorkspace} administrators group.
void	removeSocialWorkspaceMember(SocialWorkspace socialWorkspace, Principal principal) Removes a user from the @{code socialWorkspace} members group.
List<String>	searchAdministrators(SocialWorkspace socialWorkspace, String pattern) Returns all matching administrators from a Social Workspace, or an empty list.
List<SocialWorkspace>	searchDetachedPublicSocialWorkspaces(CoreSession session, String pattern) Return matching public social workspace according the given pattern.
List<String>	searchMembers(SocialWorkspace socialWorkspace, String pattern) Returns all matching members from a Social Workspace, or an empty list.
List<String>	searchUsers(SocialWorkspace socialWorkspace, RelationshipKind kind, String pattern) Returns all matching users from a Social Workspace, or an empty list.

Method Detail

handleSocialWorkspaceCreation

void handleSocialWorkspaceCreation(SocialWorkspace socialWorkspace,
                                 Principal principal)

Handles a Social Workspace creation:

• create related groups
• put specific ACLs

Parameters:

principal - the Principal initializing the Social Workspace

handleSocialWorkspaceDeletion

void handleSocialWorkspaceDeletion(SocialWorkspace socialWorkspace)

Handles a Social Workspace deletion:

• remove related groups

getDetachedSocialWorkspace

SocialWorkspace getDetachedSocialWorkspace(DocumentModel doc)

Returns the SocialWorkspace container of the given document if it is in a Social Workspace even if the user does not have right on it, null otherwise.

The underlying DocumentModel is detached.

getDetachedSocialWorkspace

SocialWorkspace getDetachedSocialWorkspace(CoreSession session,
                                         DocumentRef docRef)

Returns the SocialWorkspace container of the given document ref if it is in a Social Workspace even if the user does not have right on it, null otherwise.

The underlying DocumentModel is detached.

getSocialWorkspace

SocialWorkspace getSocialWorkspace(DocumentModel doc)

Returns the SocialWorkspace container of the given document if it is part of a Social Workspace, null otherwise.

addSocialWorkspaceAdministrator

boolean addSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace,
                                      Principal principal)

Adds a user to the socialWorkspace administrators group.

Returns:

true if the user was successfully added to the administrators group, false otherwise.

addSocialWorkspaceMember

boolean addSocialWorkspaceMember(SocialWorkspace socialWorkspace,
                               Principal principal)

Adds a user to the socialWorkspace members group.

Returns:

true if the user was successfully added to the members group, false otherwise.

addSocialWorkspaceMembers

List<String> addSocialWorkspaceMembers(SocialWorkspace socialWorkspace,
                                     String groupName)
                                       throws ClientException

Add all group's users to the socialWorkspace members groups

Parameters:

groupName - of an existing group.

Returns:

List<String> containing imported users, or an empty one.

Throws:

ClientException - when groupName doesn't exist

addSocialWorkspaceMembers

List<String> addSocialWorkspaceMembers(SocialWorkspace socialWorkspace,
                                     List<String> principals)
                                       throws ClientException

Add several users to the socialWorkspace members group.

Parameters:

principals -

Returns:

List<String> contains the email of user added, or an empty one.

Throws:

ClientException

removeSocialWorkspaceAdministrator

void removeSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace,
                                      Principal principal)

Removes a user from the @{code socialWorkspace} administrators group.

removeSocialWorkspaceMember

void removeSocialWorkspaceMember(SocialWorkspace socialWorkspace,
                               Principal principal)

Removes a user from the @{code socialWorkspace} members group.

makeSocialWorkspacePublic

void makeSocialWorkspacePublic(SocialWorkspace socialWorkspace)

Makes the given socialWorkspace public.

Puts the correct rights so that non-members can view public documents and public dashboard.

makeSocialWorkspacePrivate

void makeSocialWorkspacePrivate(SocialWorkspace socialWorkspace)

Makes the given socialWorkspace private.

Restricts rights for non-members users.

getValidationDays

int getValidationDays()

Gets the number of days before a social workspace expires without validation.

Returns:

number of days

handleSubscriptionRequest

void handleSubscriptionRequest(SocialWorkspace socialWorkspace,
                             Principal principal)

Handles a Subscription Request on socialWorkspace for the given principal.

isSubscriptionRequestPending

@Deprecated
boolean isSubscriptionRequestPending(SocialWorkspace socialWorkspace,
                                              Principal principal)

Deprecated. since 5.6 see SocialWorkspace

Returns true if there is a pending Subscription Request for the given principal, false otherwise.

getSubscriptionRequestStatus

@Deprecated
String getSubscriptionRequestStatus(SocialWorkspace socialWorkspace,
                                             Principal principal)

Deprecated.

Returns status of subscription request for the given principal Values returned are: pending, accepted, rejected or null if there is no subscription request

acceptSubscriptionRequest

@Deprecated
void acceptSubscriptionRequest(SocialWorkspace socialWorkspace,
                                        SubscriptionRequest subscriptionRequest)

Deprecated. since 5.6 see SocialWorkspace

Accepts the subscriptionRequest for socialWorkspace.

rejectSubscriptionRequest

@Deprecated
void rejectSubscriptionRequest(SocialWorkspace socialWorkspace,
                                        SubscriptionRequest subscriptionRequest)

Deprecated. since 5.6 see SocialWorkspace

Rejects the subscriptionRequest for socialWorkspace.

searchDetachedPublicSocialWorkspaces

List<SocialWorkspace> searchDetachedPublicSocialWorkspaces(CoreSession session,
                                                         String pattern)

Return matching public social workspace according the given pattern.

getDetachedPublicSocialWorkspaces

List<SocialWorkspace> getDetachedPublicSocialWorkspaces(CoreSession session)

Return all public Social Workspaces.

searchUsers

List<String> searchUsers(SocialWorkspace socialWorkspace,
                       RelationshipKind kind,
                       String pattern)

Returns all matching users from a Social Workspace, or an empty list.

Parameters:

kind - can be null or empty to search through all users.

pattern - can be blank.

searchMembers

List<String> searchMembers(SocialWorkspace socialWorkspace,
                         String pattern)

Returns all matching members from a Social Workspace, or an empty list.

Parameters:

pattern - can be blank.

searchAdministrators

List<String> searchAdministrators(SocialWorkspace socialWorkspace,
                                String pattern)

Returns all matching administrators from a Social Workspace, or an empty list.

Parameters:

pattern - can be blank.

getSocialWorkspaceContainer

DocumentModel getSocialWorkspaceContainer(CoreSession session)

Returns Social Workspace Container and create it if needed.

Parameters:

session -

getSocialWorkspaceContainerDescriptor

SocialWorkspaceContainerDescriptor getSocialWorkspaceContainerDescriptor()

Returns the configured SocialWorkspaceContainerDescriptor that contains the path, title and description of the container.