lumis.portal.group
Interface IGroupDao

All Known Implementing Classes:

GroupDaoJdbc

public interface IGroupDao

Group DAO interface.

Since:

4.0.0

Field Summary

static int

TYPE_FRAMEWORK_GROUP

Method Summary

void	add(GroupConfig groupConfig, ITransaction transaction) Add the group.
void	addMember(String groupId, String memberId, ITransaction transaction) Add the member in the group.
void	delete(String groupId, ITransaction transaction) Delete the group.
void	deleteAllMembers(String groupId, ITransaction transaction) Delete all members of the group.
void	deleteMember(String groupId, String memberId, ITransaction transaction) Delete the member of the group.
GroupConfig	get(String groupId, ITransaction transaction) Get the group.
Collection<String>	getByChannelId(String channelId, ITransaction transaction) Get the local groups ids for the specified channel
Collection<String>	getByOrigin(String origin, ITransaction transaction) Get the local groups ids for the specified origin
Collection<String>	getIds(ITransaction transaction) Get all group ids.
Collection<String>	getMemberGroups(String memberId, ITransaction transaction) Get the groups of the member.
Collection<String>	getMembers(String groupId, int filter, ITransaction transaction) Get the members of the group.
boolean	isMember(String memberId, String groupId, ITransaction transaction) Verify if given id is a member of the group.
void	update(GroupConfig groupConfig, ITransaction transaction) Update the group.

Field Detail

TYPE_FRAMEWORK_GROUP

static final int TYPE_FRAMEWORK_GROUP

See Also:

Constant Field Values

Method Detail

add

void add(GroupConfig groupConfig,
         ITransaction transaction)
         throws DaoException,
                PortalException

Add the group.

Parameters:

groupConfig -

transaction -

Throws:

DaoException

PortalException

get

GroupConfig get(String groupId,
                ITransaction transaction)
                throws DaoException,
                       PortalException

Get the group.

Parameters:

groupId -

transaction -

Returns:

Throws:

DaoException

PortalException

update

void update(GroupConfig groupConfig,
            ITransaction transaction)
            throws DaoException,
                   PortalException

Update the group.

Parameters:

groupConfig -

transaction -

Throws:

DaoException

PortalException

delete

void delete(String groupId,
            ITransaction transaction)
            throws DaoException,
                   PortalException

Delete the group.

Parameters:

groupId -

transaction -

Throws:

DaoException

PortalException

getIds

Collection<String> getIds(ITransaction transaction)
                          throws DaoException,
                                 PortalException

Get all group ids.

Parameters:

transaction -

Throws:

DaoException

PortalException

addMember

void addMember(String groupId,
               String memberId,
               ITransaction transaction)
               throws DaoException,
                      PortalException

Add the member in the group.

Parameters:

groupId -

memberId -

transaction -

Throws:

DaoException

PortalException

deleteMember

void deleteMember(String groupId,
                  String memberId,
                  ITransaction transaction)
                  throws DaoException,
                         PortalException

Delete the member of the group.

Parameters:

groupId -

memberId -

transaction -

Throws:

DaoException

PortalException

deleteAllMembers

void deleteAllMembers(String groupId,
                      ITransaction transaction)
                      throws DaoException,
                             PortalException

Delete all members of the group.

Parameters:

groupId -

transaction -

Throws:

DaoException

PortalException

isMember

boolean isMember(String memberId,
                 String groupId,
                 ITransaction transaction)
                 throws DaoException,
                        PortalException

Verify if given id is a member of the group.

Parameters:

memberId -

groupId -

transaction -

Returns:

Throws:

DaoException

PortalException

getMembers

Collection<String> getMembers(String groupId,
                              int filter,
                              ITransaction transaction)
                              throws DaoException,
                                     PortalException

Get the members of the group.

Parameters:

groupId -

filter -

transaction -

Returns:

Throws:

DaoException

PortalException

getMemberGroups

Collection<String> getMemberGroups(String memberId,
                                   ITransaction transaction)
                                   throws DaoException,
                                          PortalException

Get the groups of the member.

Parameters:

memberId -

transaction -

Returns:

Throws:

DaoException

PortalException

getByChannelId

Collection<String> getByChannelId(String channelId,
                                  ITransaction transaction)
                                  throws DaoException,
                                         PortalException

Get the local groups ids for the specified channel

Parameters:

channelId -

transaction -

Returns:

Throws:

DaoException

PortalException

getByOrigin

Collection<String> getByOrigin(String origin,
                               ITransaction transaction)
                               throws DaoException,
                                      PortalException

Get the local groups ids for the specified origin

Parameters:

origin -

transaction -

Returns:

Throws:

DaoException

PortalException

Since:

4.0.8