net.datenwerke.rs.teamspace.service.teamspace

Interface TeamSpaceService

All Known Implementing Classes:

TeamSpaceServiceImpl

public interface TeamSpaceService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	USER_PROPERTY_PRIMARY_TEAMSPACE

Method Summary

Modifier and Type	Method and Description
boolean	appExists(java.lang.String appId) Tests if a TeamSpaceApp with the given id exists
void	assertAccess(TeamSpace ts)
void	assertIsUser(TeamSpace teamSpace)
TeamSpace	createTeamSpace() Creates a new TeamSpace with the current user as owner.
TeamSpace	createTeamSpace(User user) Creates a new TeamSpace with the given User as owner
void	forceRemove(TeamSpace teamSpace)
java.util.Collection<TeamSpace>	getAllTeamSpaces() Returns a Collection of all existing TeamSpaces
TeamSpaceAppDefinition	getAppDefinitionById(java.lang.String appId)
TeamSpace	getExplicitPrimarySpace() Retrieves the primary TeamSpace of the current user if this is explicitely set.
java.util.List<java.lang.String>	getFileUploadEndingWhiteList()
java.lang.Long	getMaxUploadFileSizeBytes()
TeamSpaceMember	getMemberFor(TeamSpace teamSpace, AbstractUserManagerNode folk)
java.util.Collection<TeamSpace>	getOwnedTeamSpaces() Returns the current user's owned TeamSpaces
java.util.Collection<TeamSpace>	getOwnedTeamSpaces(User user) Returns the User's owned TeamSpaces
TeamSpace	getPrimarySpace() Retrieves the primary TeamSpace of the current user.
TeamSpace	getPrimarySpace(User user) Retrieves the primary TeamSpace of the given User.
TeamSpaceRole	getRole(TeamSpace teamSpace)
TeamSpaceRole	getRole(User user, TeamSpace teamSpace)
TeamSpace	getTeamSpaceById(java.lang.Long id)
TeamSpace	getTeamSpaceByName(java.lang.String name)
java.util.Collection<TeamSpace>	getTeamSpaces() Returns the current user's TeamSpaces
java.util.Collection<TeamSpace>	getTeamSpaces(User user) Returns the TeamSpaces that can be accessed by a given folk
java.util.Collection<TeamSpace>	getTeamSpacesByName(java.lang.String name)
java.util.Collection<TeamSpace>	getTeamSpacesWithMemberFor(AbstractUserManagerNode folk)
boolean	hasRole(TeamSpace teamSpace, TeamSpaceRole roleToHave) Tests if the current user has the given TeamSpaceRole on the given TeamSpace
boolean	hasRole(User user, TeamSpace teamSpace, TeamSpaceRole roleToHave) Tests if the given User has the given TeamSpaceRole on the given TeamSpace
TeamSpaceApp	installTeamSpaceApp(TeamSpace teamSpace, java.lang.String appId) Creates a new TeamSpaceApp instance of the given type
boolean	isAdmin(TeamSpace teamSpace) Tests if the current user is an admin of the given TeamSpace
boolean	isAdmin(User user, TeamSpace teamSpace) Tests if the given User is an admin of the given TeamSpace
java.lang.Boolean	isFileUploadEnabled()
boolean	isGlobalTsAdmin() Tests if the current user is a global TeamSpace admin
boolean	isGlobalTsAdmin(User user) Tests if the given User is a global TeamSpace admin
boolean	isGuest(TeamSpace teamSpace) Tests if the current user is a guest in the given TeamSpace
boolean	isGuest(User folk, TeamSpace teamSpace) Tests if the given User is a guest in the given TeamSpace
boolean	isManager(TeamSpace teamSpace) Tests if the current user is a manager of the given TeamSpace
boolean	isManager(User user, TeamSpace teamSpace) Tests if the given User is a manager of the given TeamSpace
boolean	isOwner(TeamSpace teamSpace) checks if the current user owns the TeamSpace
boolean	isUser(TeamSpace teamSpace) Tests if the current user is a user of the given TeamSpace
boolean	isUser(User folk, TeamSpace teamSpace) Tests if the given User is a user of the given TeamSpace
boolean	mayAccess(TeamSpace teamSpace) Tests if the current user has the right to access the given TeamSpace
boolean	mayAccess(User user, TeamSpace teamSpace) Tests if the given User has the right to access the given TeamSpace
TeamSpace	merge(TeamSpace teamSpace) Merges the given TeamSpace with the representation in the database and returns the result.
TeamSpaceApp	merge(TeamSpaceApp app) Merges the given TeamSpaceApp with the representation in the database and returns the result.
TeamSpaceMember	merge(TeamSpaceMember member) Merges the given TeamSpaceMember with the representation in the database and returns the result.
void	persist(TeamSpace teamSpace) Persists the given TeamSpace
void	persist(TeamSpaceApp teamSpaceApp) Persists the given TeamSpaceApp
void	persist(TeamSpaceMember tsMember) Persists the given TeamSpaceMember
void	provideAccess(TeamSpace teamSpace, User user, TeamSpaceRole role)
void	remove(TeamSpace teamSpace) Removes the given TeamSpace from the database
void	remove(TeamSpaceApp app) Removes the given TeamSpaceApp from the database
void	remove(TeamSpaceMember member) Removes the given TeamSpaceMember from the database
void	setInstalledApps(TeamSpace teamSpace, java.util.Collection<java.lang.String> appIds)
void	setPrimarySpace(TeamSpace teamSpace) Sets the primary TeamSpace for the current user

Field Detail

USER_PROPERTY_PRIMARY_TEAMSPACE

static final java.lang.String USER_PROPERTY_PRIMARY_TEAMSPACE

See Also:

Constant Field Values

Method Detail

getTeamSpaceById

TeamSpace getTeamSpaceById(java.lang.Long id)

getPrimarySpace

TeamSpace getPrimarySpace()

Retrieves the primary TeamSpace of the current user.

Returns:

The primary TeamSpace of the current user.

getExplicitPrimarySpace

TeamSpace getExplicitPrimarySpace()

Retrieves the primary TeamSpace of the current user if this is explicitely set.

Returns:

The primary TeamSpace of the current user if this is explicitely set.

getPrimarySpace

TeamSpace getPrimarySpace(User user)

Retrieves the primary TeamSpace of the given User.

Parameters:

user - The User

Returns:

The primary TeamSpace of the given User

setPrimarySpace

void setPrimarySpace(TeamSpace teamSpace)

Sets the primary TeamSpace for the current user

Parameters:

teamSpace - The new primary TeamSpace

createTeamSpace

TeamSpace createTeamSpace()

Creates a new TeamSpace with the current user as owner.

Returns:

The newly created TeamSpace

createTeamSpace

TeamSpace createTeamSpace(User user)

Creates a new TeamSpace with the given User as owner

Parameters:

user - The User

Returns:

The newly created TeamSpace

getTeamSpaces

java.util.Collection<TeamSpace> getTeamSpaces()

Returns the current user's TeamSpaces

Returns:

A Collection of the current user's TeamSpaces

getTeamSpaces

java.util.Collection<TeamSpace> getTeamSpaces(User user)

Returns the TeamSpaces that can be accessed by a given folk

Parameters:

user - The User

Returns:

A Collection of TeamSpaces

getOwnedTeamSpaces

java.util.Collection<TeamSpace> getOwnedTeamSpaces()

Returns the current user's owned TeamSpaces

Returns:

A Collection of the TeamSpace owned by the current user

getOwnedTeamSpaces

java.util.Collection<TeamSpace> getOwnedTeamSpaces(User user)

Returns the User's owned TeamSpaces

Parameters:

user - The User

Returns:

A Collection of the TeamSpaces owned by the given User

persist

void persist(TeamSpace teamSpace)

Persists the given TeamSpace

Parameters:

teamSpace - The TeamSpace to persist

persist

void persist(TeamSpaceMember tsMember)

Persists the given TeamSpaceMember

Parameters:

tsMember - The TeamSpaceMember to persist

persist

void persist(TeamSpaceApp teamSpaceApp)

Persists the given TeamSpaceApp

Parameters:

teamSpaceApp - The TeamSpaceApp to persist

merge

TeamSpace merge(TeamSpace teamSpace)

Merges the given TeamSpace with the representation in the database and returns the result.

Parameters:

teamSpace - The TeamSpace with the new data

Returns:

The merged TeamSpace

merge

TeamSpaceMember merge(TeamSpaceMember member)

Merges the given TeamSpaceMember with the representation in the database and returns the result.

Parameters:

member - The TeamSpaceMember with the new data

Returns:

The merged TeamSpaceMember

merge

TeamSpaceApp merge(TeamSpaceApp app)

Merges the given TeamSpaceApp with the representation in the database and returns the result.

Parameters:

app - The TeamSpaceApp with the new data

Returns:

The merged TeamSpaceApp

remove

void remove(TeamSpace teamSpace)

Removes the given TeamSpace from the database

Parameters:

teamSpace - The TeamSpace to be removed

remove

void remove(TeamSpaceMember member)

Removes the given TeamSpaceMember from the database

Parameters:

member - The TeamSpaceMember to be removed

remove

void remove(TeamSpaceApp app)

Removes the given TeamSpaceApp from the database

Parameters:

app - The TeamSpaceApp to be removed

appExists

boolean appExists(java.lang.String appId)

Tests if a TeamSpaceApp with the given id exists

Parameters:

appId - The TeamSpaceApp id

Returns:

true if the TeamSpaceApp exists; false otherwise

installTeamSpaceApp

TeamSpaceApp installTeamSpaceApp(TeamSpace teamSpace,
                                 java.lang.String appId)

Creates a new TeamSpaceApp instance of the given type

Parameters:

appId - The type (TeamSpaceApp id)

Returns:

The newly created TeamSpaceApp

getAllTeamSpaces

java.util.Collection<TeamSpace> getAllTeamSpaces()

Returns a Collection of all existing TeamSpaces

Returns:

A Collection of TeamSpaces

isGlobalTsAdmin

boolean isGlobalTsAdmin()

Tests if the current user is a global TeamSpace admin

Returns:

true if the current user is a global TeamSpace admin; false otherwise

isGlobalTsAdmin

boolean isGlobalTsAdmin(User user)

Tests if the given User is a global TeamSpace admin

Parameters:

user - The User

Returns:

true if the given User is a global TeamSpace admin; false otherwise

isManager

boolean isManager(TeamSpace teamSpace)

Tests if the current user is a manager of the given TeamSpace

Parameters:

teamSpace - The TeamSpace

Returns:

true if the current user is a manager of the given TeamSpace; false otherwise

isManager

boolean isManager(User user,
                  TeamSpace teamSpace)

Tests if the given User is a manager of the given TeamSpace

Parameters:

user - The User

teamSpace - The TeamSpace

Returns:

true if the given User is a manager of the given TeamSpace; false otherwise

isGuest

boolean isGuest(TeamSpace teamSpace)

Tests if the current user is a guest in the given TeamSpace

Parameters:

teamSpace - The TeamSpace

Returns:

true if the current user is a guest in the given TeamSpace; false otherwise

isGuest

boolean isGuest(User folk,
                TeamSpace teamSpace)

Tests if the given User is a guest in the given TeamSpace

Parameters:

teamSpace - The TeamSpace

Returns:

true if the given User is a guest in the given TeamSpace; false otherwise

isUser

boolean isUser(TeamSpace teamSpace)

Tests if the current user is a user of the given TeamSpace

Parameters:

teamSpace - The TeamSpace

Returns:

true if the current user is a user of the given TeamSpace; false otherwise

isUser

boolean isUser(User folk,
               TeamSpace teamSpace)

Tests if the given User is a user of the given TeamSpace

Parameters:

teamSpace - The TeamSpace

Returns:

true if the given User is a user of the given TeamSpace; false otherwise

isAdmin

boolean isAdmin(TeamSpace teamSpace)

Tests if the current user is an admin of the given TeamSpace

Parameters:

teamSpace - The TeamSpace

Returns:

true if the current user is an admin of the given TeamSpace; false otherwise

isAdmin

boolean isAdmin(User user,
                TeamSpace teamSpace)

Tests if the given User is an admin of the given TeamSpace

Parameters:

user - The User

teamSpace - The TeamSpace

Returns:

true if the given User is an admin of the given TeamSpace; false otherwise

hasRole

boolean hasRole(User user,
                TeamSpace teamSpace,
                TeamSpaceRole roleToHave)

Tests if the given User has the given TeamSpaceRole on the given TeamSpace

Parameters:

user - The User

teamSpace - The TeamSpace

roleToHave - The TeamSpaceRole to test

Returns:

true if the User has the TeamSpaceRole; false otherwise

hasRole

boolean hasRole(TeamSpace teamSpace,
                TeamSpaceRole roleToHave)

Tests if the current user has the given TeamSpaceRole on the given TeamSpace

Parameters:

teamSpace - The TeamSpace

roleToHave - The TeamSpaceRole to test

Returns:

true if the current user has the TeamSpaceRole; false otherwise

mayAccess

boolean mayAccess(TeamSpace teamSpace)

Tests if the current user has the right to access the given TeamSpace

Parameters:

teamSpace - The TeamSpace

Returns:

true if the current user has the right to access the given TeamSpace; false otherwise

mayAccess

boolean mayAccess(User user,
                  TeamSpace teamSpace)

Tests if the given User has the right to access the given TeamSpace

Parameters:

user - The User

teamSpace - The TeamSpace

Returns:

true if the User has the right to access the given TeamSpace; false otherwise

getTeamSpaceByName

TeamSpace getTeamSpaceByName(java.lang.String name)

getTeamSpacesByName

java.util.Collection<TeamSpace> getTeamSpacesByName(java.lang.String name)

provideAccess

void provideAccess(TeamSpace teamSpace,
                   User user,
                   TeamSpaceRole role)

setInstalledApps

void setInstalledApps(TeamSpace teamSpace,
                      java.util.Collection<java.lang.String> appIds)

getAppDefinitionById

TeamSpaceAppDefinition getAppDefinitionById(java.lang.String appId)

getMemberFor

TeamSpaceMember getMemberFor(TeamSpace teamSpace,
                             AbstractUserManagerNode folk)

forceRemove

void forceRemove(TeamSpace teamSpace)

getRole

TeamSpaceRole getRole(TeamSpace teamSpace)

getRole

TeamSpaceRole getRole(User user,
                      TeamSpace teamSpace)

isOwner

boolean isOwner(TeamSpace teamSpace)

checks if the current user owns the TeamSpace

Parameters:

teamSpace -

getTeamSpacesWithMemberFor

java.util.Collection<TeamSpace> getTeamSpacesWithMemberFor(AbstractUserManagerNode folk)

assertAccess

void assertAccess(TeamSpace ts)

assertIsUser

void assertIsUser(TeamSpace teamSpace)

isFileUploadEnabled

java.lang.Boolean isFileUploadEnabled()

getMaxUploadFileSizeBytes

java.lang.Long getMaxUploadFileSizeBytes()

getFileUploadEndingWhiteList

java.util.List<java.lang.String> getFileUploadEndingWhiteList()