Package org.cyclos.services.users

Interface GroupService

All Superinterfaces:

CRUDService<BasicGroupDTO,BasicGroupData,BasicGroupNature>, Service

All Known Subinterfaces:

GroupServiceLocal

All Known Implementing Classes:

GroupServiceImpl, GroupServiceSecurity

public interface GroupService
extends CRUDService<BasicGroupDTO,BasicGroupData,BasicGroupNature>

Service interface for group operations

Method Summary

Modifier and Type	Method	Description
void	changeConfiguration(@NotNull BasicGroupVO basicGroup, @NotNull ConfigurationVO configuration)	Changes the configuration for the specified BasicGroup by assigning a new Configuration.
ActiveConfigurationForGroupsData	getActiveConfiguration(@NotNull BasicGroupVO basicGroup)	Returns the ActiveConfigurationForGroupsData, containing all the actual configuration for the given group or group set
GroupSearchData	getSearchData()	Returns the data for searching groups
Page<BasicGroupVO>	search(@NotNull BasicGroupQuery query)	Searches for groups, returning results hierarchically

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

changeConfiguration

void changeConfiguration(@NotNull
                         @NotNull BasicGroupVO basicGroup,
                         @NotNull
                         @NotNull ConfigurationVO configuration)
                  throws FrameworkException

Changes the configuration for the specified BasicGroup by assigning a new Configuration. As a result, the configuration formerly assigned is not assigned anymore to the group.

Throws:

IllegalActionException - If the given configuration is not enabled for logged users

FrameworkException

getActiveConfiguration

ActiveConfigurationForGroupsData getActiveConfiguration(@NotNull
                                                        @NotNull BasicGroupVO basicGroup)
                                                 throws FrameworkException

Returns the ActiveConfigurationForGroupsData, containing all the actual configuration for the given group or group set

Throws:

FrameworkException

getSearchData

GroupSearchData getSearchData()
                       throws FrameworkException

Returns the data for searching groups

Throws:

FrameworkException

search

Page<BasicGroupVO> search(@NotNull
                          @NotNull BasicGroupQuery query)
                   throws FrameworkException

Searches for groups, returning results hierarchically

Throws:

FrameworkException