org.exoplatform.social.core.space.spi

Interface SpaceService

public interface SpaceService

Provides methods to work with Space.

Since:

Aug 29, 2008

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPACES_APP_ID Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptInvitation(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	acceptInvitation(String spaceId, String userId) Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	activateApplication(org.exoplatform.social.core.space.model.Space space, String appId) Activates an installed application in a space.
void	activateApplication(String spaceId, String appId) Activates an installed application in a space.
void	addInvitedUser(org.exoplatform.social.core.space.model.Space space, String userId) Adds a user to the list of users who are invited to join a space.
void	addMember(org.exoplatform.social.core.space.model.Space space, String userId) Adds a user to a space.
void	addMember(String spaceId, String userId) Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	addPendingUser(org.exoplatform.social.core.space.model.Space space, String userId) Adds a user to the list of pending requests for joining a space.
org.exoplatform.social.core.space.model.Space	createSpace(org.exoplatform.social.core.space.model.Space space, String creatorUserId) Creates a new space: creating a group, its group navigation with pages for installing space applications.
org.exoplatform.social.core.space.model.Space	createSpace(org.exoplatform.social.core.space.model.Space space, String creator, String invitedGroupId) Creates a new space and invites all users from invitedGroupId to join this newly created space.
void	deactivateApplication(org.exoplatform.social.core.space.model.Space space, String appId) Deactivates an installed application in a space.
void	deactivateApplication(String spaceId, String appId) Deactivates an installed application in a space.
void	declineRequest(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	declineRequest(String spaceId, String userId) Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	deInitApps(org.exoplatform.social.core.space.model.Space space) Deprecated. Will be removed by 4.0.x.
void	deleteSpace(org.exoplatform.social.core.space.model.Space space) Deletes a space.
void	deleteSpace(String spaceId) Deprecated. Use deleteSpace(org.exoplatform.social.core.space.model.Space) instead. Will be removed by 4.0.x.
void	denyInvitation(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	denyInvitation(String spaceId, String userId) Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.space.model.Space>	getAccessibleSpaces(String userId) Deprecated. Use getAccessibleSpacesWithListAccess(String) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.space.model.Space>	getAccessibleSpacesByFilter(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets a list access containing all spaces that a user has the access permission.
ListAccess<org.exoplatform.social.core.space.model.Space>	getAccessibleSpacesWithListAccess(String userId) Gets a list access containing all spaces that a user has the access permission.
List<org.exoplatform.social.core.space.model.Space>	getAllSpaces() Deprecated. Use getAllSpacesWithListAccess() instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.space.model.Space>	getAllSpacesByFilter(org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets a list access that contains all spaces matching with a filter.
ListAccess<org.exoplatform.social.core.space.model.Space>	getAllSpacesWithListAccess() Gets a list access that contains all spaces.
List<org.exoplatform.social.core.space.model.Space>	getEditableSpaces(String userId) Deprecated. Use getSettingableSpaces(String) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.space.model.Space>	getInvitedSpaces(String userId) Deprecated. Use getInvitedSpacesWithListAccess(String) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.space.model.Space>	getInvitedSpacesByFilter(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets a list access containing all spaces that a user is invited to join.
ListAccess<org.exoplatform.social.core.space.model.Space>	getInvitedSpacesWithListAccess(String userId) Gets a list access containing all spaces that a user is invited to join.
ListAccess<org.exoplatform.social.core.space.model.Space>	getLastAccessedSpace(String remoteId, String appId) Gets a list of the most recently accessed spaces of a user.
List<org.exoplatform.social.core.space.model.Space>	getLastAccessedSpace(String remoteId, String appId, int offset, int limit) Gets a list of the most recently accessed spaces of a user.
List<org.exoplatform.social.core.space.model.Space>	getLastSpaces(int limit) Gets the last spaces that have been created.
List<String>	getMembers(org.exoplatform.social.core.space.model.Space space) Deprecated. Use Space.getMembers() instead. Will be removed by 4.0.x.
List<String>	getMembers(String spaceId) Deprecated. Use Space.getMembers() instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.space.model.Space>	getMemberSpaces(String userId) Gets a list access containing all spaces that a user has the "member" role.
ListAccess<org.exoplatform.social.core.space.model.Space>	getMemberSpacesByFilter(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets a list access containing all spaces that a user has the "member" role.
List<org.exoplatform.social.core.space.model.Space>	getPendingSpaces(String userId) Deprecated. Use getPendingSpacesWithListAccess(String) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.space.model.Space>	getPendingSpacesByFilter(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets a list access containing all spaces that a user sent a request for joining a space.
ListAccess<org.exoplatform.social.core.space.model.Space>	getPendingSpacesWithListAccess(String userId) Gets a list access containing all spaces that a user sent a request for joining a space.
String[]	getPortletsPrefsRequired() Deprecated. Will be removed by 4.0.x.
List<org.exoplatform.social.core.space.model.Space>	getPublicSpaces(String userId) Deprecated. Use getPublicSpacesWithListAccess(String) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.space.model.Space>	getPublicSpacesByFilter(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets a list access containing all spaces that a user can request to join.
ListAccess<org.exoplatform.social.core.space.model.Space>	getPublicSpacesWithListAccess(String userId) Gets a list access containing all spaces that a user can request to join.
ListAccess<org.exoplatform.social.core.space.model.Space>	getSettingabledSpacesByFilter(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets a list access containing all spaces that a user has the setting permission.
ListAccess<org.exoplatform.social.core.space.model.Space>	getSettingableSpaces(String userId) Gets a list access containing all spaces that a user has the setting permission.
org.exoplatform.social.core.space.SpaceApplicationConfigPlugin	getSpaceApplicationConfigPlugin() Gets the space application config plugin.
org.exoplatform.social.core.space.model.Space	getSpaceByDisplayName(String spaceDisplayName) Gets a space by its display name.
org.exoplatform.social.core.space.model.Space	getSpaceByGroupId(String groupId) Gets a space by its group Id.
org.exoplatform.social.core.space.model.Space	getSpaceById(String spaceId) Gets a space by its Id.
org.exoplatform.social.core.space.model.Space	getSpaceByName(String spaceName) Deprecated. Use getSpaceByPrettyName(String) instead. Will be removed at 4.0.x.
org.exoplatform.social.core.space.model.Space	getSpaceByPrettyName(String spacePrettyName) Gets a space by its pretty name.
org.exoplatform.social.core.space.model.Space	getSpaceByUrl(String spaceUrl) Gets a space by its URL.
List<org.exoplatform.social.core.space.model.Space>	getSpaces(String userId) Deprecated. Use getMemberSpaces(String) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.space.model.Space>	getSpacesByFirstCharacterOfName(String firstCharacterOfName) Deprecated. Use getAllSpacesByFilter(org.exoplatform.social.core.space.SpaceFilter) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.space.model.Space>	getSpacesBySearchCondition(String condition) Deprecated. Use getAllSpacesByFilter(org.exoplatform.social.core.space.SpaceFilter) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.space.SpaceListAccess	getUnifiedSearchSpacesWithListAccess(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Provides the Unified Search feature to get spaces that a user can see.
List<org.exoplatform.social.core.space.model.Space>	getVisibleSpaces(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets spaces that a given user can see.
org.exoplatform.social.core.space.SpaceListAccess	getVisibleSpacesWithListAccess(String userId, org.exoplatform.social.core.space.SpaceFilter spaceFilter) Gets spaces that a given user can see.
ListAccess<org.exoplatform.social.core.space.model.Space>	getVisitedSpaces(String remoteId, String appId) Gets the list of spaces which are visited by users
boolean	hasAccessPermission(org.exoplatform.social.core.space.model.Space space, String userId) Checks if a given user can access a space or not.
boolean	hasAccessPermission(String spaceId, String userId) Deprecated. Use hasAccessPermission(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	hasEditPermission(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use hasSettingPermission(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	hasEditPermission(String spaceId, String userId) Deprecated. Use hasSettingPermission(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	hasSettingPermission(org.exoplatform.social.core.space.model.Space space, String userId) Checks if a given user has the setting permission to a space or not.
void	initApp(org.exoplatform.social.core.space.model.Space space) Deprecated. Will be removed by 4.0.x.
void	initApps(org.exoplatform.social.core.space.model.Space space) Deprecated. Will be removed by 4.0.x.
void	installApplication(org.exoplatform.social.core.space.model.Space space, String appId) Installs an application in a space.
void	installApplication(String spaceId, String appId) Installs an application in a space.
void	inviteMember(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use addInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	inviteMember(String spaceId, String userId) Deprecated. Use addInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isInvited(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use isInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isInvited(String spaceId, String userId) Deprecated. Use isInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isInvitedUser(org.exoplatform.social.core.space.model.Space space, String userId) Checks if a user is in the list of users who are invited to join a space.
boolean	isLeader(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use isManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isLeader(String spaceId, String userId) Deprecated. Use isManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isManager(org.exoplatform.social.core.space.model.Space space, String userId) Checks if a given user has the "manager" role in a space.
boolean	isMember(org.exoplatform.social.core.space.model.Space space, String userId) Checks if a given user is member of space or not.
boolean	isMember(String spaceId, String userId) Deprecated. Use isMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isOnlyLeader(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use isOnlyManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isOnlyLeader(String spaceId, String userId) Deprecated. Use isOnlyManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isOnlyManager(org.exoplatform.social.core.space.model.Space space, String userId) Checks if a given user is the only one who has the "manager" role in a space.
boolean	isPending(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use isPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isPending(String spaceId, String userId) Deprecated. Use isPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
boolean	isPendingUser(org.exoplatform.social.core.space.model.Space space, String userId) Checks if a user is in the list of pending requests for joining a space.
void	registerSpaceLifeCycleListener(org.exoplatform.social.core.space.spi.SpaceLifeCycleListener listener) Deprecated. Will be removed by 4.0.x.
void	registerSpaceListenerPlugin(org.exoplatform.social.core.space.SpaceListenerPlugin spaceListenerPlugin) Registers a space listener plugin to listen to space lifecyle events: creating, updating, installing an application, and more.
void	removeApplication(org.exoplatform.social.core.space.model.Space space, String appId, String appName) Removes an installed application from a space.
void	removeApplication(String spaceId, String appId, String appName) Removes an installed application from a space.
void	removeInvitedUser(org.exoplatform.social.core.space.model.Space space, String userId) Removes a user from the list of users who are invited to join a space.
void	removeMember(org.exoplatform.social.core.space.model.Space space, String userId) Removes a member from a space.
void	removeMember(String spaceId, String userId) Deprecated. Use removeMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	removePendingUser(org.exoplatform.social.core.space.model.Space space, String userId) Removes a user from a list of pending requests for joining a space.
void	renameSpace(org.exoplatform.social.core.space.model.Space space, String newDisplayName) Renames a space.
void	renameSpace(String remoteId, org.exoplatform.social.core.space.model.Space space, String newDisplayName) Renames a space by an identity who has rights of super admin.
void	requestJoin(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use addPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	requestJoin(String spaceId, String userId) Deprecated. Use addPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	revokeInvitation(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	revokeInvitation(String spaceId, String userId) Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	revokeRequestJoin(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	revokeRequestJoin(String spaceId, String userId) Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	saveSpace(org.exoplatform.social.core.space.model.Space space, boolean isNew) Deprecated. Use updateSpace(org.exoplatform.social.core.space.model.Space) instead. Will be removed by 4.0.x.
void	setLeader(org.exoplatform.social.core.space.model.Space space, String userId, boolean isLeader) Deprecated. Use setManager(org.exoplatform.social.core.space.model.Space, String, boolean) instead. Will be removed by 4.0.x.
void	setLeader(String spaceId, String userId, boolean isLeader) Deprecated. Use setManager(org.exoplatform.social.core.space.model.Space, String, boolean) instead. Will be removed by 4.0.x.
void	setManager(org.exoplatform.social.core.space.model.Space space, String userId, boolean isManager) Assigns the "manager" role to a user in a space.
void	setPortletsPrefsRequired(org.exoplatform.social.core.application.PortletPreferenceRequiredPlugin portletPrefsRequiredPlugin) Deprecated. Use SpaceApplicationConfigPlugin instead. Will be removed by 4.0.x.
void	setSpaceApplicationConfigPlugin(org.exoplatform.social.core.space.SpaceApplicationConfigPlugin spaceApplicationConfigPlugin) Sets a space application config plugin for configuring the home and space applications.
void	unregisterSpaceLifeCycleListener(org.exoplatform.social.core.space.spi.SpaceLifeCycleListener listener) Deprecated. Will be removed by 4.0.x.
void	unregisterSpaceListenerPlugin(org.exoplatform.social.core.space.SpaceListenerPlugin spaceListenerPlugin) Unregisters an existing space listener plugin.
org.exoplatform.social.core.space.model.Space	updateSpace(org.exoplatform.social.core.space.model.Space existingSpace) Updates information of a space.
void	updateSpaceAccessed(String remoteId, org.exoplatform.social.core.space.model.Space space) Updates the most recently accessed space of a user to the top of spaces list.
org.exoplatform.social.core.space.model.Space	updateSpaceAvatar(org.exoplatform.social.core.space.model.Space existingSpace) Updates a space's avatar.
void	validateRequest(org.exoplatform.social.core.space.model.Space space, String userId) Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.
void	validateRequest(String spaceId, String userId) Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Field Detail

SPACES_APP_ID

@Deprecated
static final String SPACES_APP_ID

Deprecated.

Will be removed by 4.0.x.

See Also:

Constant Field Values

Method Detail

getSpaceByDisplayName

org.exoplatform.social.core.space.model.Space getSpaceByDisplayName(String spaceDisplayName)

Gets a space by its display name.

Parameters:

spaceDisplayName - The space display name.

Returns:

The space.

Since:

1.2.0-GA

Level API:

Platform

getSpaceByPrettyName

org.exoplatform.social.core.space.model.Space getSpaceByPrettyName(String spacePrettyName)

Gets a space by its pretty name.

Parameters:

spacePrettyName - The space's pretty name.

Returns:

The space.

Since:

1.2.0-GA

Level API:

Platform

getSpaceByGroupId

org.exoplatform.social.core.space.model.Space getSpaceByGroupId(String groupId)

Gets a space by its group Id.

Parameters:

groupId - The group Id.

Returns:

The space.

Since:

1.2.0-GA

Level API:

Platform

getSpaceById

org.exoplatform.social.core.space.model.Space getSpaceById(String spaceId)

Gets a space by its Id.

Parameters:

spaceId - Id of the space.

Returns:

The space.

Since:

1.2.0-GA

Level API:

Platform

getSpaceByUrl

org.exoplatform.social.core.space.model.Space getSpaceByUrl(String spaceUrl)

Gets a space by its URL.

Parameters:

spaceUrl - URL of the space.

Returns:

The space.

Since:

1.2.0-GA

Level API:

Platform

getAllSpacesWithListAccess

ListAccess<org.exoplatform.social.core.space.model.Space> getAllSpacesWithListAccess()

Gets a list access that contains all spaces.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getAllSpacesByFilter

ListAccess<org.exoplatform.social.core.space.model.Space> getAllSpacesByFilter(org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets a list access that contains all spaces matching with a filter.

Parameters:

spaceFilter - The space filter.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getMemberSpaces

ListAccess<org.exoplatform.social.core.space.model.Space> getMemberSpaces(String userId)

Gets a list access containing all spaces that a user has the "member" role.

Parameters:

userId - The remote user Id.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getMemberSpacesByFilter

ListAccess<org.exoplatform.social.core.space.model.Space> getMemberSpacesByFilter(String userId,
                                                                                org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets a list access containing all spaces that a user has the "member" role. This list access matches with the provided space filter.

Parameters:

userId - The remote user Id.

spaceFilter - The space filter.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getAccessibleSpacesWithListAccess

ListAccess<org.exoplatform.social.core.space.model.Space> getAccessibleSpacesWithListAccess(String userId)

Gets a list access containing all spaces that a user has the access permission.

Parameters:

userId - The remote user Id.

Returns:

The space list access.

Since:

1.2.0-GA

Level API:

Platform

getAccessibleSpacesByFilter

ListAccess<org.exoplatform.social.core.space.model.Space> getAccessibleSpacesByFilter(String userId,
                                                                                    org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets a list access containing all spaces that a user has the access permission. This list access matches with the provided space filter.

Parameters:

userId - The remote user Id.

spaceFilter - The provided space filter.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getSettingableSpaces

ListAccess<org.exoplatform.social.core.space.model.Space> getSettingableSpaces(String userId)

Gets a list access containing all spaces that a user has the setting permission.

Parameters:

userId - The remote user Id.

Returns:

The space list access.

Since:

1.2.0-GA

Level API:

Platform

getSettingabledSpacesByFilter

ListAccess<org.exoplatform.social.core.space.model.Space> getSettingabledSpacesByFilter(String userId,
                                                                                      org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets a list access containing all spaces that a user has the setting permission. This list access matches with the provided space filter.

Parameters:

userId - The remote user Id.

spaceFilter - The provided space filter.

Returns:

The space list access.

Since:

1.2.0-GA

Level API:

Platform

getInvitedSpacesWithListAccess

ListAccess<org.exoplatform.social.core.space.model.Space> getInvitedSpacesWithListAccess(String userId)

Gets a list access containing all spaces that a user is invited to join.

Parameters:

userId - The remote user Id.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getInvitedSpacesByFilter

ListAccess<org.exoplatform.social.core.space.model.Space> getInvitedSpacesByFilter(String userId,
                                                                                 org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets a list access containing all spaces that a user is invited to join. This list access matches with the provided space filter.

Parameters:

userId - The remote user Id.

spaceFilter - The provided space filter.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getPublicSpacesWithListAccess

ListAccess<org.exoplatform.social.core.space.model.Space> getPublicSpacesWithListAccess(String userId)

Gets a list access containing all spaces that a user can request to join.

Parameters:

userId - The remote user Id.

Returns:

The space list access.

Since:

1.2.0-GA

Level API:

Platform

getPublicSpacesByFilter

ListAccess<org.exoplatform.social.core.space.model.Space> getPublicSpacesByFilter(String userId,
                                                                                org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets a list access containing all spaces that a user can request to join. This list access matches with the provided space filter.

Parameters:

userId - The remote user Id.

spaceFilter - The provided space filter.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getPendingSpacesWithListAccess

ListAccess<org.exoplatform.social.core.space.model.Space> getPendingSpacesWithListAccess(String userId)

Gets a list access containing all spaces that a user sent a request for joining a space.

Parameters:

userId - The remote user Id.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getPendingSpacesByFilter

ListAccess<org.exoplatform.social.core.space.model.Space> getPendingSpacesByFilter(String userId,
                                                                                 org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets a list access containing all spaces that a user sent a request for joining a space. This list access matches with the provided space filter.

Parameters:

userId - The remote user Id.

spaceFilter - The provided space filter.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

createSpace

org.exoplatform.social.core.space.model.Space createSpace(org.exoplatform.social.core.space.model.Space space,
                                                        String creatorUserId)

Creates a new space: creating a group, its group navigation with pages for installing space applications.

Parameters:

space - The space to be created.

creatorUserId - The remote user Id.

Returns:

The created space.

Level API:

Platform

updateSpace

org.exoplatform.social.core.space.model.Space updateSpace(org.exoplatform.social.core.space.model.Space existingSpace)

Updates information of a space.

Parameters:

existingSpace - The existing space to be updated.

Returns:

The updated space.

Since:

1.2.0-GA

Level API:

Platform

updateSpaceAvatar

org.exoplatform.social.core.space.model.Space updateSpaceAvatar(org.exoplatform.social.core.space.model.Space existingSpace)

Updates a space's avatar.

Parameters:

existingSpace - The existing space to be updated.

Returns:

The updated space.

Since:

1.2.0-GA

Level API:

Platform

deleteSpace

void deleteSpace(org.exoplatform.social.core.space.model.Space space)

Deletes a space. When a space is deleted, all of its page navigations and its group will be deleted.

Parameters:

space - The space to be deleted.

Level API:

Platform

addPendingUser

void addPendingUser(org.exoplatform.social.core.space.model.Space space,
                  String userId)

Adds a user to the list of pending requests for joining a space.

Parameters:

space - The exising space.

userId - The remote user Id.

Since:

1.2.0-GA

Level API:

Platform

removePendingUser

void removePendingUser(org.exoplatform.social.core.space.model.Space space,
                     String userId)

Removes a user from a list of pending requests for joining a space.

Parameters:

space - The existing space.

userId - The remote user Id.

Since:

1.2.0-GA

Level API:

Platform

isPendingUser

boolean isPendingUser(org.exoplatform.social.core.space.model.Space space,
                    String userId)

Checks if a user is in the list of pending requests for joining a space.

Parameters:

space - The existing space.

userId - The remote user Id.

Returns:

TRUE if the user request is pending. Otherwise, it is FALSE.

Since:

1.2.0-GA

Level API:

Platform

addInvitedUser

void addInvitedUser(org.exoplatform.social.core.space.model.Space space,
                  String userId)

Adds a user to the list of users who are invited to join a space.

Parameters:

space - The existing space.

userId - The remote user Id.

Since:

1.2.0-GA

Level API:

Platform

removeInvitedUser

void removeInvitedUser(org.exoplatform.social.core.space.model.Space space,
                     String userId)

Removes a user from the list of users who are invited to join a space.

Parameters:

space - The existing space.

userId - The remote user Id.

Since:

1.2.0-GA

Level API:

Platform

isInvitedUser

boolean isInvitedUser(org.exoplatform.social.core.space.model.Space space,
                    String userId)

Checks if a user is in the list of users who are invited to join a space.

Parameters:

space - The existing space.

userId - The remote user Id.

Returns:

TRUE if the user is in the list of invited users. Otherwise, it is FALSE.

Since:

1.2.0-GA

Level API:

Platform

addMember

void addMember(org.exoplatform.social.core.space.model.Space space,
             String userId)

Adds a user to a space. The user will get the "member" role in a space.

Parameters:

space - The existing space.

userId - The remote user Id.

Level API:

Platform

removeMember

void removeMember(org.exoplatform.social.core.space.model.Space space,
                String userId)

Removes a member from a space.

Parameters:

space - The existing space.

userId - The remote user Id.

Level API:

Platform

isMember

boolean isMember(org.exoplatform.social.core.space.model.Space space,
               String userId)

Checks if a given user is member of space or not.

Parameters:

space - The existing space.

userId - The remote user Id.

Returns:

TRUE if the user is member. Otherwise, it is FALSE.

Level API:

Platform

setManager

void setManager(org.exoplatform.social.core.space.model.Space space,
              String userId,
              boolean isManager)

Assigns the "manager" role to a user in a space.

Parameters:

space - The space that its user is assigned to manager.

userId - The remote user Id.

isManager - "True" if the user gets the "manager" role. "False" if the user only gets the "member" role.

Since:

1.2.0-GA

Level API:

Platform

isManager

boolean isManager(org.exoplatform.social.core.space.model.Space space,
                String userId)

Checks if a given user has the "manager" role in a space.

Parameters:

space - The space that its user is checked if he has the "manager" role or not.

userId - The remote user Id.

Returns:

"True" if the user has the "manager" role. Otherwise, it returns "false".

Since:

1.2.0-GA

Level API:

Platform

isOnlyManager

boolean isOnlyManager(org.exoplatform.social.core.space.model.Space space,
                    String userId)

Checks if a given user is the only one who has the "manager" role in a space.

Parameters:

space - The space that its user is checked if he is the only manager or not.

userId - The remote user Id.

Returns:

"True" if the user Id is the only one who has "manager" role in the space. Otherwise, it returns "false".

Since:

1.2.0-GA

Level API:

Platform

hasAccessPermission

boolean hasAccessPermission(org.exoplatform.social.core.space.model.Space space,
                          String userId)

Checks if a given user can access a space or not.

Parameters:

space - The space that its user is checked if he can access it.

userId - The remote user Id.

Returns:

"True" if the access permission is allowed. Otherwise, it returns "false".

Level API:

Platform

hasSettingPermission

boolean hasSettingPermission(org.exoplatform.social.core.space.model.Space space,
                           String userId)

Checks if a given user has the setting permission to a space or not.

Parameters:

space - The space that its user is checked if he has the setting permission or not.

userId - The remote user Id.

Returns:

If the user is root or the space's member, "true" is returned. Otherwise, it returns "false".

Since:

1.2.0-GA

Level API:

Platform

registerSpaceListenerPlugin

void registerSpaceListenerPlugin(org.exoplatform.social.core.space.SpaceListenerPlugin spaceListenerPlugin)

Registers a space listener plugin to listen to space lifecyle events: creating, updating, installing an application, and more.

Parameters:

spaceListenerPlugin - The space listener plugin to be registered.

Since:

1.2.0-GA

Level API:

Platform

unregisterSpaceListenerPlugin

void unregisterSpaceListenerPlugin(org.exoplatform.social.core.space.SpaceListenerPlugin spaceListenerPlugin)

Unregisters an existing space listener plugin.

Parameters:

spaceListenerPlugin - The space listener plugin to be unregistered.

Since:

1.2.0-GA

Level API:

Platform

setSpaceApplicationConfigPlugin

void setSpaceApplicationConfigPlugin(org.exoplatform.social.core.space.SpaceApplicationConfigPlugin spaceApplicationConfigPlugin)

Sets a space application config plugin for configuring the home and space applications.

By configuring this, the space service will know how to create a new page node with title, URL and portlet.

Parameters:

spaceApplicationConfigPlugin - The space application config plugin to be set.

Since:

1.2.0-GA

Level API:

Platform

getSpaceApplicationConfigPlugin

org.exoplatform.social.core.space.SpaceApplicationConfigPlugin getSpaceApplicationConfigPlugin()

Gets the space application config plugin.

Returns:

The space application config plugin.

Level API:

Platform

getAllSpaces

@Deprecated
List<org.exoplatform.social.core.space.model.Space> getAllSpaces()
                                                                 throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getAllSpacesWithListAccess() instead. Will be removed by 4.0.x.

Gets all spaces in Social.

Returns:

The list of spaces in Social.

Throws:

org.exoplatform.social.core.space.SpaceException - with code SpaceException.Code.ERROR_DATASTORE

Level API:

Provisional

getSpaceByName

org.exoplatform.social.core.space.model.Space getSpaceByName(String spaceName)
                                                             throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getSpaceByPrettyName(String) instead. Will be removed at 4.0.x.

Gets a space by its space name.

Parameters:

spaceName - The space name.

Returns:

The stored space.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

getSpacesByFirstCharacterOfName

@Deprecated
List<org.exoplatform.social.core.space.model.Space> getSpacesByFirstCharacterOfName(String firstCharacterOfName)
                                                                                    throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getAllSpacesByFilter(org.exoplatform.social.core.space.SpaceFilter) instead. Will be removed by 4.0.x.

Gets all spaces which have the name starting with the input character.

Returns:

All spaces in which their first characters match with the input string.

Throws:

org.exoplatform.social.core.space.SpaceException - with code SpaceException.Code.ERROR_DATASTORE

Level API:

Provisional

getSpacesBySearchCondition

List<org.exoplatform.social.core.space.model.Space> getSpacesBySearchCondition(String condition)
                                                                               throws Exception

Deprecated. Use getAllSpacesByFilter(org.exoplatform.social.core.space.SpaceFilter) instead. Will be removed by 4.0.x.

Gets all spaces that their names or descriptions match with the input condition.

Parameters:

condition - The input condition.

Returns:

The list of spaces.

Throws:

Exception

Level API:

Provisional

getSpaces

@Deprecated
List<org.exoplatform.social.core.space.model.Space> getSpaces(String userId)
                                                              throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getMemberSpaces(String) instead. Will be removed by 4.0.x.

Gets spaces that a given user is member.

Parameters:

userId - Id of the user.

Returns:

All spaces that the user is member.

Throws:

org.exoplatform.social.core.space.SpaceException - with code SpaceException.Code.ERROR_DATASTORE

Level API:

Provisional

getAccessibleSpaces

List<org.exoplatform.social.core.space.model.Space> getAccessibleSpaces(String userId)
                                                                        throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getAccessibleSpacesWithListAccess(String) instead. Will be removed by 4.0.x.

Gets spaces that a given user has the access permission.

Parameters:

userId - Id of the user.

Returns:

The list of spaces.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

getVisibleSpaces

List<org.exoplatform.social.core.space.model.Space> getVisibleSpaces(String userId,
                                                                   org.exoplatform.social.core.space.SpaceFilter spaceFilter)
                                                                     throws org.exoplatform.social.core.space.SpaceException

Gets spaces that a given user can see.

Parameters:

userId - Id of the user.

spaceFilter - Condition by which spaces are filtered.

Returns:

The list of spaces.

Throws:

org.exoplatform.social.core.space.SpaceException

Since:

1.2.5-GA

Level API:

Platform

getVisibleSpacesWithListAccess

org.exoplatform.social.core.space.SpaceListAccess getVisibleSpacesWithListAccess(String userId,
                                                                               org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Gets spaces that a given user can see.

Parameters:

userId - Id of the user.

spaceFilter - The condition by which spaces are filtered.

Returns:

The list of spaces.

Since:

1.2.5-GA

Level API:

Platform

getUnifiedSearchSpacesWithListAccess

org.exoplatform.social.core.space.SpaceListAccess getUnifiedSearchSpacesWithListAccess(String userId,
                                                                                     org.exoplatform.social.core.space.SpaceFilter spaceFilter)

Provides the Unified Search feature to get spaces that a user can see.

Parameters:

userId - Id of the user.

spaceFilter - The condition by which spaces are filtered.

Returns:

The list of spaces.

Since:

4.0.0-GA

Level API:

Platform

getEditableSpaces

@Deprecated
List<org.exoplatform.social.core.space.model.Space> getEditableSpaces(String userId)
                                                                      throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getSettingableSpaces(String) instead. Will be removed by 4.0.x.

Gets spaces that a given user has the edit permission.

Parameters:

userId - Id of the user.

Returns:

The list of spaces.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

getInvitedSpaces

@Deprecated
List<org.exoplatform.social.core.space.model.Space> getInvitedSpaces(String userId)
                                                                     throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getInvitedSpacesWithListAccess(String) instead. Will be removed by 4.0.x.

Gets all spaces that a given user is invited and can accept or deny requests.

Parameters:

userId - Id of the user.

Returns:

The list of spaces that the user is invited.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

getPublicSpaces

@Deprecated
List<org.exoplatform.social.core.space.model.Space> getPublicSpaces(String userId)
                                                                    throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getPublicSpacesWithListAccess(String) instead. Will be removed by 4.0.x.

Gets public spaces which a given user can request to join.

Parameters:

userId - Id of the user.

Returns:

The list of spaces that the user can request to join.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

getPendingSpaces

@Deprecated
List<org.exoplatform.social.core.space.model.Space> getPendingSpaces(String userId)
                                                                     throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use getPendingSpacesWithListAccess(String) instead. Will be removed by 4.0.x.

Gets pending spaces which a given user can revoke requests.

Parameters:

userId - Id of the user.

Returns:

The list of pending spaces.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

createSpace

org.exoplatform.social.core.space.model.Space createSpace(org.exoplatform.social.core.space.model.Space space,
                                                        String creator,
                                                        String invitedGroupId)
                                                          throws org.exoplatform.social.core.space.SpaceException

Creates a new space and invites all users from invitedGroupId to join this newly created space.

Parameters:

space - The space to be created.

creator - The user who creates the space.

invitedGroupId - Id of group who is invited to join the space.

Returns:

The space.

Throws:

org.exoplatform.social.core.space.SpaceException - with possible code SpaceException.Code.SPACE_ALREADY_EXIST; UNABLE_TO_ADD_CREATOR

Level API:

Platform

saveSpace

void saveSpace(org.exoplatform.social.core.space.model.Space space,
             boolean isNew)
               throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use updateSpace(org.exoplatform.social.core.space.model.Space) instead. Will be removed by 4.0.x.

Saves a new space or updates a space.

Parameters:

space - The space to be saved or updated.

isNew - "True" if a new space is created. "False" if an existing space is updated.

Throws:

org.exoplatform.social.core.space.SpaceException - with code: SpaceException.Code.ERROR_DATASTORE

Level API:

Provisional

renameSpace

void renameSpace(org.exoplatform.social.core.space.model.Space space,
               String newDisplayName)
                 throws org.exoplatform.social.core.space.SpaceException

Renames a space.

Parameters:

space - The space to be renamed.

newDisplayName - New name of the space.

Throws:

org.exoplatform.social.core.space.SpaceException

Since:

1.2.8

Level API:

Platform

renameSpace

void renameSpace(String remoteId,
               org.exoplatform.social.core.space.model.Space space,
               String newDisplayName)
                 throws org.exoplatform.social.core.space.SpaceException

Renames a space by an identity who has rights of super admin.

Parameters:

remoteId - The identity who has renamed a space.

space - The space to be renamed.

newDisplayName - New name of the space.

Throws:

org.exoplatform.social.core.space.SpaceException

Since:

4.0.0

Level API:

Platform

deleteSpace

@Deprecated
void deleteSpace(String spaceId)
                 throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use deleteSpace(org.exoplatform.social.core.space.model.Space) instead. Will be removed by 4.0.x.

Deletes a space by its Id.

Parameters:

spaceId - Id of the deleted space.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

initApp

@Deprecated
void initApp(org.exoplatform.social.core.space.model.Space space)
             throws org.exoplatform.social.core.space.SpaceException

Deprecated. Will be removed by 4.0.x.

Does nothing, just for compatible.

Parameters:

space - The space.

Throws:

org.exoplatform.social.core.space.SpaceException - with code SpaceException.Code.UNABLE_INIT_APP

Level API:

Provisional

initApps

@Deprecated
void initApps(org.exoplatform.social.core.space.model.Space space)
              throws org.exoplatform.social.core.space.SpaceException

Deprecated. Will be removed by 4.0.x.

Does nothing, just for compatible.

Parameters:

space - The space.

Throws:

org.exoplatform.social.core.space.SpaceException - with code SpaceException.Code.UNABLE_INIT_APP

Level API:

Provisional

deInitApps

@Deprecated
void deInitApps(org.exoplatform.social.core.space.model.Space space)
                throws org.exoplatform.social.core.space.SpaceException

Deprecated. Will be removed by 4.0.x.

Does nothing, just for compatible.

Parameters:

space - The space.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

addMember

@Deprecated
void addMember(String spaceId,
                        String userId)
               throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Adds a user to space as "member".

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

removeMember

@Deprecated
void removeMember(String spaceId,
                           String userId)
                  throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removeMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Removes a member from space.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

getMembers

@Deprecated
List<String> getMembers(org.exoplatform.social.core.space.model.Space space)
                        throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use Space.getMembers() instead. Will be removed by 4.0.x.

Gets a list of members from a given space.

Parameters:

space - The space.

Returns:

The list of space members.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

getMembers

@Deprecated
List<String> getMembers(String spaceId)
                        throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use Space.getMembers() instead. Will be removed by 4.0.x.

Gets a list of members from a given space.

Parameters:

spaceId - Id of the space.

Returns:

The list of space members.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

setLeader

@Deprecated
void setLeader(org.exoplatform.social.core.space.model.Space space,
                        String userId,
                        boolean isLeader)
               throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use setManager(org.exoplatform.social.core.space.model.Space, String, boolean) instead. Will be removed by 4.0.x.

Sets a space member to manager or vice versa.

Parameters:

space - The space.

userId - Id of the user (remoteId).

isLeader - If "true", the space member is set to manager. If "false", the space manager is set to member.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

setLeader

@Deprecated
void setLeader(String spaceId,
                        String userId,
                        boolean isLeader)
               throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use setManager(org.exoplatform.social.core.space.model.Space, String, boolean) instead. Will be removed by 4.0.x.

Sets a space member to manager or vice versa.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

isLeader - If "true", the space member is set to manager. If "false", the space manager is set to member.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isLeader

@Deprecated
boolean isLeader(org.exoplatform.social.core.space.model.Space space,
                          String userId)
                 throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a given user is space manager or not.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Returns:

"True" if the user is space manager. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isLeader

@Deprecated
boolean isLeader(String spaceId,
                          String userId)
                 throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a given user is space manager or not.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Returns:

"True" if the user is space manager. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isOnlyLeader

@Deprecated
boolean isOnlyLeader(org.exoplatform.social.core.space.model.Space space,
                              String userId)
                     throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isOnlyManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a given user is the only manager of space or not.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Returns:

"True" if the user is the only space manager. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isOnlyLeader

@Deprecated
boolean isOnlyLeader(String spaceId,
                              String userId)
                     throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isOnlyManager(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a given user is the only manager of space or not.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Returns:

"True" if the user is the only space manager. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isMember

@Deprecated
boolean isMember(String spaceId,
                          String userId)
                 throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a given user is space member or not.

Parameters:

spaceId - Id of the space.

userId - Id of user (remoteId).

Returns:

"True" if the user is space member. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

hasAccessPermission

@Deprecated
boolean hasAccessPermission(String spaceId,
                                     String userId)
                            throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use hasAccessPermission(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a user can access a space or not. If the user is root or the space's member, the "true" value is returned.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Returns:

"True" if the user has the access permission. "False" if the user does not have the access permission.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

hasEditPermission

@Deprecated
boolean hasEditPermission(org.exoplatform.social.core.space.model.Space space,
                                   String userId)
                          throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use hasSettingPermission(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a user has the edit permission on a space or not. If the user is root or the space's manager, "true" is returned.

Parameters:

space - The provided space.

userId - Id of the user (remoteId).

Returns:

"True" if the user has the edit permission. "False" if the user does not have the edit permission.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

hasEditPermission

@Deprecated
boolean hasEditPermission(String spaceId,
                                   String userId)
                          throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use hasSettingPermission(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a user has the edit permission on a space. If user is root or the space's manager, "true" is returned.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Returns:

"True" if the user has the edit permission. "False" if the user does not have the edit permission.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isInvited

@Deprecated
boolean isInvited(org.exoplatform.social.core.space.model.Space space,
                           String userId)
                  throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a user is in the list of invited users of a space.

Parameters:

space - The provided space.

userId - Id of the user (remoteId).

Returns:

"True" if the user is in the list of invited users. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isInvited

@Deprecated
boolean isInvited(String spaceId,
                           String userId)
                  throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a user is in the list of invited users of a space.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Returns:

"True" if the user is in the list of invited users. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isPending

@Deprecated
boolean isPending(org.exoplatform.social.core.space.model.Space space,
                           String userId)
                  throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a user is in the list of pending users of a space or not.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Returns:

"True" if the user is in the list of pending users. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

isPending

@Deprecated
boolean isPending(String spaceId,
                           String userId)
                  throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use isPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Checks if a user is in the list of pending users of a space.

Parameters:

spaceId - Id of the user.

userId - Id of the user (remoteId).

Returns:

"True" if the user is in the list of pending users. Otherwise, it returns "false".

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

installApplication

void installApplication(String spaceId,
                      String appId)
                        throws org.exoplatform.social.core.space.SpaceException

Installs an application in a space.

Parameters:

spaceId - Id of the space that the application is installed.

appId - Id of the application which is installed.

Throws:

org.exoplatform.social.core.space.SpaceException - with code SpaceException.Code.ERROR_DATA_STORE

Level API:

Platform

installApplication

void installApplication(org.exoplatform.social.core.space.model.Space space,
                      String appId)
                        throws org.exoplatform.social.core.space.SpaceException

Installs an application in a space.

Parameters:

space - The space that the application is installed.

appId - Id of the installed application.

Throws:

org.exoplatform.social.core.space.SpaceException - with code SpaceException.Code.ERROR_DATA_STORE

Level API:

Platform

activateApplication

void activateApplication(org.exoplatform.social.core.space.model.Space space,
                       String appId)
                         throws org.exoplatform.social.core.space.SpaceException

Activates an installed application in a space.

Parameters:

space - The space that the installed application is activated.

appId - Id of the installed application.

Throws:

org.exoplatform.social.core.space.SpaceException - with possible code: SpaceException.Code.UNABLE_TO_ADD_APPLICATION, SpaceExeption.Code.ERROR_DATA_STORE

Level API:

Platform

activateApplication

void activateApplication(String spaceId,
                       String appId)
                         throws org.exoplatform.social.core.space.SpaceException

Activates an installed application in a space.

Parameters:

spaceId - Id of the space that the installed application is activated.

appId - Id of the installed application.

Throws:

org.exoplatform.social.core.space.SpaceException - with possible code: SpaceException.Code.UNABLE_TO_ADD_APPLICATION, SpaceExeption.Code.ERROR_DATA_STORE

Level API:

Platform

deactivateApplication

void deactivateApplication(org.exoplatform.social.core.space.model.Space space,
                         String appId)
                           throws org.exoplatform.social.core.space.SpaceException

Deactivates an installed application in a space.

Parameters:

space - The space that the installed application is deactivated.

appId - Id of the installed application.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Platform

deactivateApplication

void deactivateApplication(String spaceId,
                         String appId)
                           throws org.exoplatform.social.core.space.SpaceException

Deactivates an installed application in a space.

Parameters:

spaceId - Id of the space that the installed application is deactivated.

appId - Id of the installed application.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Platform

removeApplication

void removeApplication(org.exoplatform.social.core.space.model.Space space,
                     String appId,
                     String appName)
                       throws org.exoplatform.social.core.space.SpaceException

Removes an installed application from a space.

Parameters:

space - The space that the installed application is removed.

appId - Id of the installed application.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Platform

removeApplication

void removeApplication(String spaceId,
                     String appId,
                     String appName)
                       throws org.exoplatform.social.core.space.SpaceException

Removes an installed application from a space.

Parameters:

spaceId - Id of the space that the installed application is removed.

appId - Id of the installed application.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Platform

updateSpaceAccessed

void updateSpaceAccessed(String remoteId,
                       org.exoplatform.social.core.space.model.Space space)
                         throws org.exoplatform.social.core.space.SpaceException

Updates the most recently accessed space of a user to the top of spaces list.

Parameters:

remoteId - The remote Id of the user.

space - The last accessed space of the user.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Platform

getLastAccessedSpace

List<org.exoplatform.social.core.space.model.Space> getLastAccessedSpace(String remoteId,
                                                                       String appId,
                                                                       int offset,
                                                                       int limit)
                                                                         throws org.exoplatform.social.core.space.SpaceException

Gets a list of the most recently accessed spaces of a user.

Parameters:

remoteId - The remote Id of user.

appId - Id of the installed application in a space.

offset - The starting point to get the most recently accessed spaces.

limit - The limitation of the most recently accessed spaces.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Platform

getLastSpaces

List<org.exoplatform.social.core.space.model.Space> getLastSpaces(int limit)

Gets the last spaces that have been created.

Parameters:

limit - the limit of spaces to provide.

Returns:

The last spaces.

Since:

4.0.x

Level API:

Experimental

getLastAccessedSpace

ListAccess<org.exoplatform.social.core.space.model.Space> getLastAccessedSpace(String remoteId,
                                                                             String appId)

Gets a list of the most recently accessed spaces of a user.

Parameters:

remoteId - The remote Id of a user.

appId - Id of the installed application in a space.

Level API:

Platform

requestJoin

@Deprecated
void requestJoin(org.exoplatform.social.core.space.model.Space space,
                          String userId)
                 throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Requests to join a space, then adds the requester to the list of pending spaces.

Parameters:

space - The space which the user requests to join.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

requestJoin

@Deprecated
void requestJoin(String spaceId,
                          String userId)
                 throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Requests to join a space, then adds the requester to the list of pending spaces.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

revokeRequestJoin

@Deprecated
void revokeRequestJoin(org.exoplatform.social.core.space.model.Space space,
                                String userId)
                       throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Revokes a request to join a space.

Parameters:

space - The space which the user requests to join.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

revokeRequestJoin

@Deprecated
void revokeRequestJoin(String spaceId,
                                String userId)
                       throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Revokes a request to join a space.

Parameters:

spaceId - Id of the space.

userId - Id of the user.

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

inviteMember

@Deprecated
void inviteMember(org.exoplatform.social.core.space.model.Space space,
                           String userId)
                  throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Invites a user to become a space member.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

inviteMember

@Deprecated
void inviteMember(String spaceId,
                           String userId)
                  throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Invites a user to become a space member.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

revokeInvitation

@Deprecated
void revokeInvitation(org.exoplatform.social.core.space.model.Space space,
                               String userId)
                      throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Revokes an invitation - Removes the user from the list of invited users of the space.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

revokeInvitation

@Deprecated
void revokeInvitation(String spaceId,
                               String userId)
                      throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Revokes an invitation - Removes the user from the list of invited users of the space.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

acceptInvitation

@Deprecated
void acceptInvitation(org.exoplatform.social.core.space.model.Space space,
                               String userId)
                      throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Accepts an invitation - Moves the user from the invited users list to the members list.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

acceptInvitation

@Deprecated
void acceptInvitation(String spaceId,
                               String userId)
                      throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Accepts an invitation - Moves the user from the invited users list to the members list.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

denyInvitation

@Deprecated
void denyInvitation(org.exoplatform.social.core.space.model.Space space,
                             String userId)
                    throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Denies an invitation - Removes the user from the list of invited users.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

denyInvitation

@Deprecated
void denyInvitation(String spaceId,
                             String userId)
                    throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Denies an invitation - Removes the user from the list of invited users.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

validateRequest

@Deprecated
void validateRequest(org.exoplatform.social.core.space.model.Space space,
                              String userId)
                     throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Validates a request - Moves the user from the pending users list to the members list.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

validateRequest

@Deprecated
void validateRequest(String spaceId,
                              String userId)
                     throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use addMember(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Validates a request - Moves the user from the pending users list to the members list.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

declineRequest

@Deprecated
void declineRequest(org.exoplatform.social.core.space.model.Space space,
                             String userId)
                    throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Declines a request - Removes the user from the pending users list.

Parameters:

space - The space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

declineRequest

@Deprecated
void declineRequest(String spaceId,
                             String userId)
                    throws org.exoplatform.social.core.space.SpaceException

Deprecated. Use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. Will be removed by 4.0.x.

Declines a request - Removes the user from the pending users list.

Parameters:

spaceId - Id of the space.

userId - Id of the user (remoteId).

Throws:

org.exoplatform.social.core.space.SpaceException

Level API:

Provisional

registerSpaceLifeCycleListener

@Deprecated
void registerSpaceLifeCycleListener(org.exoplatform.social.core.space.spi.SpaceLifeCycleListener listener)

Deprecated. Will be removed by 4.0.x.

Registers a space lifecycle listener.

Parameters:

listener - The space lifecycle listener to be registered.

Level API:

Provisional

unregisterSpaceLifeCycleListener

@Deprecated
void unregisterSpaceLifeCycleListener(org.exoplatform.social.core.space.spi.SpaceLifeCycleListener listener)

Deprecated. Will be removed by 4.0.x.

Unregisters a space lifecycle listener.

Parameters:

listener - The space lifecycle listener to be unregistered.

Level API:

Provisional

setPortletsPrefsRequired

@Deprecated
void setPortletsPrefsRequired(org.exoplatform.social.core.application.PortletPreferenceRequiredPlugin portletPrefsRequiredPlugin)

Deprecated. Use SpaceApplicationConfigPlugin instead. Will be removed by 4.0.x.

Sets the portlet preferences got from the plugin configuration.

Parameters:

portletPrefsRequiredPlugin - The plugin that configures portlets to store spaceUrl in its portlet-preference.

Level API:

Provisional

getPortletsPrefsRequired

String[] getPortletsPrefsRequired()

Deprecated. Will be removed by 4.0.x.

Gets the portlet preferences which are required for creating the portlet application.

Returns:

Array of the portlet preferences.

Level API:

Provisional

getVisitedSpaces

ListAccess<org.exoplatform.social.core.space.model.Space> getVisitedSpaces(String remoteId,
                                                                         String appId)

Gets the list of spaces which are visited by users

Parameters:

remoteId -

appId -

Returns: