org.nuxeo.ecm.social.workspace.adapters

Interface SocialWorkspace

All Known Implementing Classes:

SocialWorkspaceAdapter

public interface SocialWorkspace

An object that wraps a DocumentModel having the facet SocialWorkspace.

Since:

5.5

Author:

Thomas Roger

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptSubscriptionRequest(SubscriptionRequest subscriptionRequest) Accepts this subscriptionRequest.
boolean	addAdministrator(Principal principal) Adds a user to this Social Workspace administrators group.
boolean	addMember(Principal principal) Adds a user to this Social Workspace members group.
List<String>	getAdministrators() Gets all administrators of this social workspace.
String	getAdministratorsGroupLabel() Returns this Social Workspace administrators group label.
String	getAdministratorsGroupName() Returns this Social Workspace administrators group name.
String	getDashboardSpacesRootPath() Returns the path of the Dashboard spaces root of this Social Workspace.
DocumentModel	getDocument() Returns the underlying .
String	getId() Returns the id of this Social Workspace.
List<String>	getMembers() Gets all members of this social workspace.
String	getMembersGroupLabel() Returns this Social Workspace members group label.
String	getMembersGroupName() Returns this Social Workspace members group name.
String	getNewsItemsRootPath() Returns the path of the News Items root of this Social Workspace.
String	getPath() Returns the full path of this Social Workspace.
String	getPrivateDashboardSpacePath() Returns the path of the private Dashboard Space of this Social Workspace.
String	getPrivateSectionPath() Returns the path of the private Section of this Social Workspace.
String	getPublicDashboardSpacePath() Returns the path of the public Dashboard Space of this Social Workspace.
String	getPublicSectionPath() Returns the path of the public Section of this Social Workspace.
String	getSubscriptionRequestStatus(Principal principal) Returns status of subscription request for the given principal Values returned are: pending, accepted, rejected or null if there is no subscription request
String	getTitle() Returns the title of this Social Workspace.
List<String>	getUsers() Gets all members and administrators of this social workspace
void	handleSubscriptionRequest(Principal principal) Handles a Subscription Request for the given principal.
boolean	isAdministrator(NuxeoPrincipal principal) Returns true if the given principal is administrator of this Social Workspace, false otherwise.
boolean	isAdministratorOrMember(NuxeoPrincipal principal) Returns true if the given principal is administrator or member of this Social Workspace, false otherwise.
boolean	isMember(NuxeoPrincipal principal) Returns true if the given principal is member of this Social Workspace, false otherwise.
boolean	isMembersNotificationEnabled() Returns true if the social workspace won't send a notification to its members when modifications occurred.
boolean	isPrivate() Returns true if this Social Workspace is private, false otherwise.
boolean	isPublic() Returns true if this Social Workspace is public, false otherwise.
boolean	isSubscriptionRequestPending(Principal principal) Returns true if there is a pending Subscription Request for the given principal, false otherwise.
void	makePrivate() Make this Social Workspace private.
void	makePublic() Make this Social Workspace public.
boolean	mustApproveSubscription() Returns true if the subscriptions to this Social Workspace need an administrator approval, false otherwise.
void	rejectSubscriptionRequest(SubscriptionRequest subscriptionRequest) Rejects this subscriptionRequest.
void	removeAdministrator(Principal principal) Removes a user from this Social Workspace administrators group.
void	removeMember(Principal principal) Removes a user from this Social Workspace members group.
List<String>	searchAdministrators(String pattern) Search through administrators of this social workspace that match with the passed pattern.
List<String>	searchMembers(String pattern) Search through members of this social workspace that match with the passed pattern.
List<String>	searchUsers(String pattern) Search through members and administrators of this social workspace that match with the passed pattern.
void	setDocument(DocumentModel doc) Sets the underlying .
boolean	shouldRequestSubscription(Principal principal) Returns if the principal should be invited

Method Detail

getId

String getId()

Returns the id of this Social Workspace.

getTitle

String getTitle()

Returns the title of this Social Workspace.

getPath

String getPath()

Returns the full path of this Social Workspace.

isPublic

boolean isPublic()

Returns true if this Social Workspace is public, false otherwise.

isPrivate

boolean isPrivate()

Returns true if this Social Workspace is private, false otherwise.

makePublic

void makePublic()

Make this Social Workspace public.

makePrivate

void makePrivate()

Make this Social Workspace private.

mustApproveSubscription

boolean mustApproveSubscription()

Returns true if the subscriptions to this Social Workspace need an administrator approval, false otherwise.

isMembersNotificationEnabled

boolean isMembersNotificationEnabled()

Returns true if the social workspace won't send a notification to its members when modifications occurred.

addAdministrator

boolean addAdministrator(Principal principal)

Adds a user to this Social Workspace administrators group.

addMember

boolean addMember(Principal principal)

Adds a user to this Social Workspace members group.

Returns:

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

removeAdministrator

void removeAdministrator(Principal principal)

Removes a user from this Social Workspace administrators group.

removeMember

void removeMember(Principal principal)

Removes a user from this Social Workspace members group.

isAdministrator

boolean isAdministrator(NuxeoPrincipal principal)

Returns true if the given principal is administrator of this Social Workspace, false otherwise.

isMember

boolean isMember(NuxeoPrincipal principal)

Returns true if the given principal is member of this Social Workspace, false otherwise.

isAdministratorOrMember

boolean isAdministratorOrMember(NuxeoPrincipal principal)

Returns true if the given principal is administrator or member of this Social Workspace, false otherwise.

searchMembers

List<String> searchMembers(String pattern)

Search through members of this social workspace that match with the passed pattern.

searchAdministrators

List<String> searchAdministrators(String pattern)

Search through administrators of this social workspace that match with the passed pattern.

searchUsers

List<String> searchUsers(String pattern)

Search through members and administrators of this social workspace that match with the passed pattern.

getMembers

List<String> getMembers()

Gets all members of this social workspace.

getAdministrators

List<String> getAdministrators()

Gets all administrators of this social workspace.

getUsers

List<String> getUsers()

Gets all members and administrators of this social workspace

getAdministratorsGroupName

String getAdministratorsGroupName()

Returns this Social Workspace administrators group name.

getAdministratorsGroupLabel

String getAdministratorsGroupLabel()

Returns this Social Workspace administrators group label.

getMembersGroupName

String getMembersGroupName()

Returns this Social Workspace members group name.

getMembersGroupLabel

String getMembersGroupLabel()

Returns this Social Workspace members group label.

getPublicSectionPath

String getPublicSectionPath()

Returns the path of the public Section of this Social Workspace.

getPrivateSectionPath

String getPrivateSectionPath()

Returns the path of the private Section of this Social Workspace.

getNewsItemsRootPath

String getNewsItemsRootPath()

Returns the path of the News Items root of this Social Workspace.

getDashboardSpacesRootPath

String getDashboardSpacesRootPath()

Returns the path of the Dashboard spaces root of this Social Workspace.

getPublicDashboardSpacePath

String getPublicDashboardSpacePath()

Returns the path of the public Dashboard Space of this Social Workspace.

getPrivateDashboardSpacePath

String getPrivateDashboardSpacePath()

Returns the path of the private Dashboard Space of this Social Workspace.

handleSubscriptionRequest

void handleSubscriptionRequest(Principal principal)

Handles a Subscription Request for the given principal.

shouldRequestSubscription

boolean shouldRequestSubscription(Principal principal)

Returns if the principal should be invited

isSubscriptionRequestPending

boolean isSubscriptionRequestPending(Principal principal)

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

getSubscriptionRequestStatus

String getSubscriptionRequestStatus(Principal principal)

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

acceptSubscriptionRequest

void acceptSubscriptionRequest(SubscriptionRequest subscriptionRequest)

Accepts this subscriptionRequest.

rejectSubscriptionRequest

void rejectSubscriptionRequest(SubscriptionRequest subscriptionRequest)

Rejects this subscriptionRequest.

getDocument

DocumentModel getDocument()

Returns the underlying .

setDocument

void setDocument(DocumentModel doc)

Sets the underlying .

Must be the same document (same id), otherwise throw a RuntimeException.