org.nuxeo.ecm.social.workspace.adapters

Class SocialWorkspaceAdapter

java.lang.Object

org.nuxeo.ecm.social.workspace.adapters.BaseAdapter

org.nuxeo.ecm.social.workspace.adapters.SocialWorkspaceAdapter

All Implemented Interfaces:

SocialWorkspace

public class SocialWorkspaceAdapter
extends BaseAdapter
implements SocialWorkspace

Default implementation of SocialWorkspace.

Since:

5.5

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
static String	MEMBER_NOTIFICATION_DISABLED

Constructor Summary

Constructors

Constructor and Description
SocialWorkspaceAdapter(DocumentModel doc)

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

Methods inherited from class java.lang.Object

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

Field Detail

MEMBER_NOTIFICATION_DISABLED

public static final String MEMBER_NOTIFICATION_DISABLED

See Also:

Constant Field Values

Constructor Detail

SocialWorkspaceAdapter

public SocialWorkspaceAdapter(DocumentModel doc)

Method Detail

getId

public String getId()

Description copied from interface: SocialWorkspace

Returns the id of this Social Workspace.

Specified by:

getId in interface SocialWorkspace

getTitle

public String getTitle()

Description copied from interface: SocialWorkspace

Returns the title of this Social Workspace.

Specified by:

getTitle in interface SocialWorkspace

getPath

public String getPath()

Description copied from interface: SocialWorkspace

Returns the full path of this Social Workspace.

Specified by:

getPath in interface SocialWorkspace

isPublic

public boolean isPublic()

Description copied from interface: SocialWorkspace

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

Specified by:

isPublic in interface SocialWorkspace

isPrivate

public boolean isPrivate()

Description copied from interface: SocialWorkspace

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

Specified by:

isPrivate in interface SocialWorkspace

makePublic

public void makePublic()

Description copied from interface: SocialWorkspace

Make this Social Workspace public.

Specified by:

makePublic in interface SocialWorkspace

makePrivate

public void makePrivate()

Description copied from interface: SocialWorkspace

Make this Social Workspace private.

Specified by:

makePrivate in interface SocialWorkspace

mustApproveSubscription

public boolean mustApproveSubscription()

Description copied from interface: SocialWorkspace

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

Specified by:

mustApproveSubscription in interface SocialWorkspace

isMembersNotificationEnabled

public boolean isMembersNotificationEnabled()

Description copied from interface: SocialWorkspace

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

Specified by:

isMembersNotificationEnabled in interface SocialWorkspace

addAdministrator

public boolean addAdministrator(Principal principal)

Description copied from interface: SocialWorkspace

Adds a user to this Social Workspace administrators group.

Specified by:

addAdministrator in interface SocialWorkspace

addMember

public boolean addMember(Principal principal)

Description copied from interface: SocialWorkspace

Adds a user to this Social Workspace members group.

Specified by:

addMember in interface SocialWorkspace

Returns:

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

removeAdministrator

public void removeAdministrator(Principal principal)

Description copied from interface: SocialWorkspace

Removes a user from this Social Workspace administrators group.

Specified by:

removeAdministrator in interface SocialWorkspace

removeMember

public void removeMember(Principal principal)

Description copied from interface: SocialWorkspace

Removes a user from this Social Workspace members group.

Specified by:

removeMember in interface SocialWorkspace

isAdministrator

public boolean isAdministrator(NuxeoPrincipal principal)

Description copied from interface: SocialWorkspace

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

Specified by:

isAdministrator in interface SocialWorkspace

isMember

public boolean isMember(NuxeoPrincipal principal)

Description copied from interface: SocialWorkspace

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

Specified by:

isMember in interface SocialWorkspace

isAdministratorOrMember

public boolean isAdministratorOrMember(NuxeoPrincipal principal)

Description copied from interface: SocialWorkspace

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

Specified by:

isAdministratorOrMember in interface SocialWorkspace

searchMembers

public List<String> searchMembers(String pattern)

Description copied from interface: SocialWorkspace

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

Specified by:

searchMembers in interface SocialWorkspace

searchAdministrators

public List<String> searchAdministrators(String pattern)

Description copied from interface: SocialWorkspace

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

Specified by:

searchAdministrators in interface SocialWorkspace

searchUsers

public List<String> searchUsers(String pattern)

Description copied from interface: SocialWorkspace

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

Specified by:

searchUsers in interface SocialWorkspace

getMembers

public List<String> getMembers()

Description copied from interface: SocialWorkspace

Gets all members of this social workspace.

Specified by:

getMembers in interface SocialWorkspace

getAdministrators

public List<String> getAdministrators()

Description copied from interface: SocialWorkspace

Gets all administrators of this social workspace.

Specified by:

getAdministrators in interface SocialWorkspace

getUsers

public List<String> getUsers()

Description copied from interface: SocialWorkspace

Gets all members and administrators of this social workspace

Specified by:

getUsers in interface SocialWorkspace

getAdministratorsGroupName

public String getAdministratorsGroupName()

Description copied from interface: SocialWorkspace

Returns this Social Workspace administrators group name.

Specified by:

getAdministratorsGroupName in interface SocialWorkspace

getAdministratorsGroupLabel

public String getAdministratorsGroupLabel()

Description copied from interface: SocialWorkspace

Returns this Social Workspace administrators group label.

Specified by:

getAdministratorsGroupLabel in interface SocialWorkspace

getMembersGroupName

public String getMembersGroupName()

Description copied from interface: SocialWorkspace

Returns this Social Workspace members group name.

Specified by:

getMembersGroupName in interface SocialWorkspace

getMembersGroupLabel

public String getMembersGroupLabel()

Description copied from interface: SocialWorkspace

Returns this Social Workspace members group label.

Specified by:

getMembersGroupLabel in interface SocialWorkspace

getPublicSectionPath

public String getPublicSectionPath()

Description copied from interface: SocialWorkspace

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

Specified by:

getPublicSectionPath in interface SocialWorkspace

getPrivateSectionPath

public String getPrivateSectionPath()

Description copied from interface: SocialWorkspace

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

Specified by:

getPrivateSectionPath in interface SocialWorkspace

getNewsItemsRootPath

public String getNewsItemsRootPath()

Description copied from interface: SocialWorkspace

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

Specified by:

getNewsItemsRootPath in interface SocialWorkspace

getDashboardSpacesRootPath

public String getDashboardSpacesRootPath()

Description copied from interface: SocialWorkspace

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

Specified by:

getDashboardSpacesRootPath in interface SocialWorkspace

getPublicDashboardSpacePath

public String getPublicDashboardSpacePath()

Description copied from interface: SocialWorkspace

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

Specified by:

getPublicDashboardSpacePath in interface SocialWorkspace

getPrivateDashboardSpacePath

public String getPrivateDashboardSpacePath()

Description copied from interface: SocialWorkspace

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

Specified by:

getPrivateDashboardSpacePath in interface SocialWorkspace

handleSubscriptionRequest

public void handleSubscriptionRequest(Principal principal)

Description copied from interface: SocialWorkspace

Handles a Subscription Request for the given principal.

Specified by:

handleSubscriptionRequest in interface SocialWorkspace

shouldRequestSubscription

public boolean shouldRequestSubscription(Principal principal)

Description copied from interface: SocialWorkspace

Returns if the principal should be invited

Specified by:

shouldRequestSubscription in interface SocialWorkspace

isSubscriptionRequestPending

public boolean isSubscriptionRequestPending(Principal principal)

Description copied from interface: SocialWorkspace

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

Specified by:

isSubscriptionRequestPending in interface SocialWorkspace

getSubscriptionRequestStatus

public String getSubscriptionRequestStatus(Principal principal)

Description copied from interface: SocialWorkspace

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

Specified by:

getSubscriptionRequestStatus in interface SocialWorkspace

acceptSubscriptionRequest

public void acceptSubscriptionRequest(SubscriptionRequest subscriptionRequest)

Description copied from interface: SocialWorkspace

Accepts this subscriptionRequest.

Specified by:

acceptSubscriptionRequest in interface SocialWorkspace

rejectSubscriptionRequest

public void rejectSubscriptionRequest(SubscriptionRequest subscriptionRequest)

Description copied from interface: SocialWorkspace

Rejects this subscriptionRequest.

Specified by:

rejectSubscriptionRequest in interface SocialWorkspace

getDocument

public DocumentModel getDocument()

Description copied from interface: SocialWorkspace

Returns the underlying .

Specified by:

getDocument in interface SocialWorkspace

setDocument

public void setDocument(DocumentModel doc)

Description copied from interface: SocialWorkspace

Sets the underlying .

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

Specified by:

setDocument in interface SocialWorkspace