Liferay 6.1.2-ce-ga3

com.liferay.portal.service.persistence
Interface GroupPersistence

All Superinterfaces:
BasePersistence<Group>

public interface GroupPersistence
extends BasePersistence<Group>

The persistence interface for the group service.

Caching information and settings can be found in portal.properties

See Also:
GroupPersistenceImpl, GroupUtil

Method Summary
 void addOrganization(long pk, long organizationPK)
          Adds an association between the group and the organization.
 void addOrganization(long pk, Organization organization)
          Adds an association between the group and the organization.
 void addOrganizations(long pk, List<Organization> organizations)
          Adds an association between the group and the organizations.
 void addOrganizations(long pk, long[] organizationPKs)
          Adds an association between the group and the organizations.
 void addPermission(long pk, long permissionPK)
          Adds an association between the group and the permission.
 void addPermission(long pk, Permission permission)
          Adds an association between the group and the permission.
 void addPermissions(long pk, List<Permission> permissions)
          Adds an association between the group and the permissions.
 void addPermissions(long pk, long[] permissionPKs)
          Adds an association between the group and the permissions.
 void addRole(long pk, long rolePK)
          Adds an association between the group and the role.
 void addRole(long pk, Role role)
          Adds an association between the group and the role.
 void addRoles(long pk, List<Role> roles)
          Adds an association between the group and the roles.
 void addRoles(long pk, long[] rolePKs)
          Adds an association between the group and the roles.
 void addUser(long pk, long userPK)
          Adds an association between the group and the user.
 void addUser(long pk, User user)
          Adds an association between the group and the user.
 void addUserGroup(long pk, long userGroupPK)
          Adds an association between the group and the user group.
 void addUserGroup(long pk, UserGroup userGroup)
          Adds an association between the group and the user group.
 void addUserGroups(long pk, List<UserGroup> userGroups)
          Adds an association between the group and the user groups.
 void addUserGroups(long pk, long[] userGroupPKs)
          Adds an association between the group and the user groups.
 void addUsers(long pk, List<User> users)
          Adds an association between the group and the users.
 void addUsers(long pk, long[] userPKs)
          Adds an association between the group and the users.
 void cacheResult(Group group)
          Caches the group in the entity cache if it is enabled.
 void cacheResult(List<Group> groups)
          Caches the groups in the entity cache if it is enabled.
 void clearOrganizations(long pk)
          Clears all associations between the group and its organizations.
 void clearPermissions(long pk)
          Clears all associations between the group and its permissions.
 void clearRoles(long pk)
          Clears all associations between the group and its roles.
 void clearUserGroups(long pk)
          Clears all associations between the group and its user groups.
 void clearUsers(long pk)
          Clears all associations between the group and its users.
 boolean containsOrganization(long pk, long organizationPK)
          Returns true if the organization is associated with the group.
 boolean containsOrganizations(long pk)
          Returns true if the group has any organizations associated with it.
 boolean containsPermission(long pk, long permissionPK)
          Returns true if the permission is associated with the group.
 boolean containsPermissions(long pk)
          Returns true if the group has any permissions associated with it.
 boolean containsRole(long pk, long rolePK)
          Returns true if the role is associated with the group.
 boolean containsRoles(long pk)
          Returns true if the group has any roles associated with it.
 boolean containsUser(long pk, long userPK)
          Returns true if the user is associated with the group.
 boolean containsUserGroup(long pk, long userGroupPK)
          Returns true if the user group is associated with the group.
 boolean containsUserGroups(long pk)
          Returns true if the group has any user groups associated with it.
 boolean containsUsers(long pk)
          Returns true if the group has any users associated with it.
 int countAll()
          Returns the number of groups.
 int countByC_C_C(long companyId, long classNameId, long classPK)
          Returns the number of groups where companyId = ? and classNameId = ? and classPK = ?.
 int countByC_C_L_N(long companyId, long classNameId, long liveGroupId, String name)
          Returns the number of groups where companyId = ? and classNameId = ? and liveGroupId = ? and name = ?.
 int countByC_F(long companyId, String friendlyURL)
          Returns the number of groups where companyId = ? and friendlyURL = ?.
 int countByC_L_N(long companyId, long liveGroupId, String name)
          Returns the number of groups where companyId = ? and liveGroupId = ? and name = ?.
 int countByC_N(long companyId, String name)
          Returns the number of groups where companyId = ? and name = ?.
 int countByCompanyId(long companyId)
          Returns the number of groups where companyId = ?.
 int countByLiveGroupId(long liveGroupId)
          Returns the number of groups where liveGroupId = ?.
 int countByT_A(int type, boolean active)
          Returns the number of groups where type = ? and active = ?.
 Group create(long groupId)
          Creates a new group with the primary key.
 Group fetchByC_C_C(long companyId, long classNameId, long classPK)
          Returns the group where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found.
 Group fetchByC_C_C(long companyId, long classNameId, long classPK, boolean retrieveFromCache)
          Returns the group where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.
 Group fetchByC_C_L_N(long companyId, long classNameId, long liveGroupId, String name)
          Returns the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? or returns null if it could not be found.
 Group fetchByC_C_L_N(long companyId, long classNameId, long liveGroupId, String name, boolean retrieveFromCache)
          Returns the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
 Group fetchByC_F(long companyId, String friendlyURL)
          Returns the group where companyId = ? and friendlyURL = ? or returns null if it could not be found.
 Group fetchByC_F(long companyId, String friendlyURL, boolean retrieveFromCache)
          Returns the group where companyId = ? and friendlyURL = ? or returns null if it could not be found, optionally using the finder cache.
 Group fetchByC_L_N(long companyId, long liveGroupId, String name)
          Returns the group where companyId = ? and liveGroupId = ? and name = ? or returns null if it could not be found.
 Group fetchByC_L_N(long companyId, long liveGroupId, String name, boolean retrieveFromCache)
          Returns the group where companyId = ? and liveGroupId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
 Group fetchByC_N(long companyId, String name)
          Returns the group where companyId = ? and name = ? or returns null if it could not be found.
 Group fetchByC_N(long companyId, String name, boolean retrieveFromCache)
          Returns the group where companyId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
 Group fetchByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Returns the first group in the ordered set where companyId = ?.
 Group fetchByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Returns the last group in the ordered set where companyId = ?.
 Group fetchByLiveGroupId(long liveGroupId)
          Returns the group where liveGroupId = ? or returns null if it could not be found.
 Group fetchByLiveGroupId(long liveGroupId, boolean retrieveFromCache)
          Returns the group where liveGroupId = ? or returns null if it could not be found, optionally using the finder cache.
 Group fetchByPrimaryKey(long groupId)
          Returns the group with the primary key or returns null if it could not be found.
 Group fetchByT_A_First(int type, boolean active, OrderByComparator orderByComparator)
          Returns the first group in the ordered set where type = ? and active = ?.
 Group fetchByT_A_Last(int type, boolean active, OrderByComparator orderByComparator)
          Returns the last group in the ordered set where type = ? and active = ?.
 List<Group> findAll()
          Returns all the groups.
 List<Group> findAll(int start, int end)
          Returns a range of all the groups.
 List<Group> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the groups.
 Group findByC_C_C(long companyId, long classNameId, long classPK)
          Returns the group where companyId = ? and classNameId = ? and classPK = ? or throws a NoSuchGroupException if it could not be found.
 Group findByC_C_L_N(long companyId, long classNameId, long liveGroupId, String name)
          Returns the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? or throws a NoSuchGroupException if it could not be found.
 Group findByC_F(long companyId, String friendlyURL)
          Returns the group where companyId = ? and friendlyURL = ? or throws a NoSuchGroupException if it could not be found.
 Group findByC_L_N(long companyId, long liveGroupId, String name)
          Returns the group where companyId = ? and liveGroupId = ? and name = ? or throws a NoSuchGroupException if it could not be found.
 Group findByC_N(long companyId, String name)
          Returns the group where companyId = ? and name = ? or throws a NoSuchGroupException if it could not be found.
 Group findByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Returns the first group in the ordered set where companyId = ?.
 Group findByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Returns the last group in the ordered set where companyId = ?.
 Group[] findByCompanyId_PrevAndNext(long groupId, long companyId, OrderByComparator orderByComparator)
          Returns the groups before and after the current group in the ordered set where companyId = ?.
 List<Group> findByCompanyId(long companyId)
          Returns all the groups where companyId = ?.
 List<Group> findByCompanyId(long companyId, int start, int end)
          Returns a range of all the groups where companyId = ?.
 List<Group> findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the groups where companyId = ?.
 Group findByLiveGroupId(long liveGroupId)
          Returns the group where liveGroupId = ? or throws a NoSuchGroupException if it could not be found.
 Group findByPrimaryKey(long groupId)
          Returns the group with the primary key or throws a NoSuchGroupException if it could not be found.
 Group findByT_A_First(int type, boolean active, OrderByComparator orderByComparator)
          Returns the first group in the ordered set where type = ? and active = ?.
 Group findByT_A_Last(int type, boolean active, OrderByComparator orderByComparator)
          Returns the last group in the ordered set where type = ? and active = ?.
 Group[] findByT_A_PrevAndNext(long groupId, int type, boolean active, OrderByComparator orderByComparator)
          Returns the groups before and after the current group in the ordered set where type = ? and active = ?.
 List<Group> findByT_A(int type, boolean active)
          Returns all the groups where type = ? and active = ?.
 List<Group> findByT_A(int type, boolean active, int start, int end)
          Returns a range of all the groups where type = ? and active = ?.
 List<Group> findByT_A(int type, boolean active, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the groups where type = ? and active = ?.
 List<Organization> getOrganizations(long pk)
          Returns all the organizations associated with the group.
 List<Organization> getOrganizations(long pk, int start, int end)
          Returns a range of all the organizations associated with the group.
 List<Organization> getOrganizations(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the organizations associated with the group.
 int getOrganizationsSize(long pk)
          Returns the number of organizations associated with the group.
 List<Permission> getPermissions(long pk)
          Returns all the permissions associated with the group.
 List<Permission> getPermissions(long pk, int start, int end)
          Returns a range of all the permissions associated with the group.
 List<Permission> getPermissions(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the permissions associated with the group.
 int getPermissionsSize(long pk)
          Returns the number of permissions associated with the group.
 List<Role> getRoles(long pk)
          Returns all the roles associated with the group.
 List<Role> getRoles(long pk, int start, int end)
          Returns a range of all the roles associated with the group.
 List<Role> getRoles(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles associated with the group.
 int getRolesSize(long pk)
          Returns the number of roles associated with the group.
 List<UserGroup> getUserGroups(long pk)
          Returns all the user groups associated with the group.
 List<UserGroup> getUserGroups(long pk, int start, int end)
          Returns a range of all the user groups associated with the group.
 List<UserGroup> getUserGroups(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the user groups associated with the group.
 int getUserGroupsSize(long pk)
          Returns the number of user groups associated with the group.
 List<User> getUsers(long pk)
          Returns all the users associated with the group.
 List<User> getUsers(long pk, int start, int end)
          Returns a range of all the users associated with the group.
 List<User> getUsers(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the users associated with the group.
 int getUsersSize(long pk)
          Returns the number of users associated with the group.
 Group remove(long groupId)
          Removes the group with the primary key from the database.
 void removeAll()
          Removes all the groups from the database.
 Group removeByC_C_C(long companyId, long classNameId, long classPK)
          Removes the group where companyId = ? and classNameId = ? and classPK = ? from the database.
 Group removeByC_C_L_N(long companyId, long classNameId, long liveGroupId, String name)
          Removes the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? from the database.
 Group removeByC_F(long companyId, String friendlyURL)
          Removes the group where companyId = ? and friendlyURL = ? from the database.
 Group removeByC_L_N(long companyId, long liveGroupId, String name)
          Removes the group where companyId = ? and liveGroupId = ? and name = ? from the database.
 Group removeByC_N(long companyId, String name)
          Removes the group where companyId = ? and name = ? from the database.
 void removeByCompanyId(long companyId)
          Removes all the groups where companyId = ? from the database.
 Group removeByLiveGroupId(long liveGroupId)
          Removes the group where liveGroupId = ? from the database.
 void removeByT_A(int type, boolean active)
          Removes all the groups where type = ? and active = ? from the database.
 void removeOrganization(long pk, long organizationPK)
          Removes the association between the group and the organization.
 void removeOrganization(long pk, Organization organization)
          Removes the association between the group and the organization.
 void removeOrganizations(long pk, List<Organization> organizations)
          Removes the association between the group and the organizations.
 void removeOrganizations(long pk, long[] organizationPKs)
          Removes the association between the group and the organizations.
 void removePermission(long pk, long permissionPK)
          Removes the association between the group and the permission.
 void removePermission(long pk, Permission permission)
          Removes the association between the group and the permission.
 void removePermissions(long pk, List<Permission> permissions)
          Removes the association between the group and the permissions.
 void removePermissions(long pk, long[] permissionPKs)
          Removes the association between the group and the permissions.
 void removeRole(long pk, long rolePK)
          Removes the association between the group and the role.
 void removeRole(long pk, Role role)
          Removes the association between the group and the role.
 void removeRoles(long pk, List<Role> roles)
          Removes the association between the group and the roles.
 void removeRoles(long pk, long[] rolePKs)
          Removes the association between the group and the roles.
 void removeUser(long pk, long userPK)
          Removes the association between the group and the user.
 void removeUser(long pk, User user)
          Removes the association between the group and the user.
 void removeUserGroup(long pk, long userGroupPK)
          Removes the association between the group and the user group.
 void removeUserGroup(long pk, UserGroup userGroup)
          Removes the association between the group and the user group.
 void removeUserGroups(long pk, List<UserGroup> userGroups)
          Removes the association between the group and the user groups.
 void removeUserGroups(long pk, long[] userGroupPKs)
          Removes the association between the group and the user groups.
 void removeUsers(long pk, List<User> users)
          Removes the association between the group and the users.
 void removeUsers(long pk, long[] userPKs)
          Removes the association between the group and the users.
 void setOrganizations(long pk, List<Organization> organizations)
          Sets the organizations associated with the group, removing and adding associations as necessary.
 void setOrganizations(long pk, long[] organizationPKs)
          Sets the organizations associated with the group, removing and adding associations as necessary.
 void setPermissions(long pk, List<Permission> permissions)
          Sets the permissions associated with the group, removing and adding associations as necessary.
 void setPermissions(long pk, long[] permissionPKs)
          Sets the permissions associated with the group, removing and adding associations as necessary.
 void setRoles(long pk, List<Role> roles)
          Sets the roles associated with the group, removing and adding associations as necessary.
 void setRoles(long pk, long[] rolePKs)
          Sets the roles associated with the group, removing and adding associations as necessary.
 void setUserGroups(long pk, List<UserGroup> userGroups)
          Sets the user groups associated with the group, removing and adding associations as necessary.
 void setUserGroups(long pk, long[] userGroupPKs)
          Sets the user groups associated with the group, removing and adding associations as necessary.
 void setUsers(long pk, List<User> users)
          Sets the users associated with the group, removing and adding associations as necessary.
 void setUsers(long pk, long[] userPKs)
          Sets the users associated with the group, removing and adding associations as necessary.
 Group updateImpl(Group group, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(Group group)
Caches the group in the entity cache if it is enabled.

Parameters:
group - the group

cacheResult

void cacheResult(List<Group> groups)
Caches the groups in the entity cache if it is enabled.

Parameters:
groups - the groups

create

Group create(long groupId)
Creates a new group with the primary key. Does not add the group to the database.

Parameters:
groupId - the primary key for the new group
Returns:
the new group

remove

Group remove(long groupId)
             throws NoSuchGroupException,
                    SystemException
Removes the group with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
groupId - the primary key of the group
Returns:
the group that was removed
Throws:
NoSuchGroupException - if a group with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

Group updateImpl(Group group,
                 boolean merge)
                 throws SystemException
Throws:
SystemException

findByPrimaryKey

Group findByPrimaryKey(long groupId)
                       throws NoSuchGroupException,
                              SystemException
Returns the group with the primary key or throws a NoSuchGroupException if it could not be found.

Parameters:
groupId - the primary key of the group
Returns:
the group
Throws:
NoSuchGroupException - if a group with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

Group fetchByPrimaryKey(long groupId)
                        throws SystemException
Returns the group with the primary key or returns null if it could not be found.

Parameters:
groupId - the primary key of the group
Returns:
the group, or null if a group with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<Group> findByCompanyId(long companyId)
                            throws SystemException
Returns all the groups where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the matching groups
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<Group> findByCompanyId(long companyId,
                            int start,
                            int end)
                            throws SystemException
Returns a range of all the groups where companyId = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company ID
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of matching groups
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<Group> findByCompanyId(long companyId,
                            int start,
                            int end,
                            OrderByComparator orderByComparator)
                            throws SystemException
Returns an ordered range of all the groups where companyId = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company ID
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching groups
Throws:
SystemException - if a system exception occurred

findByCompanyId_First

Group findByCompanyId_First(long companyId,
                            OrderByComparator orderByComparator)
                            throws NoSuchGroupException,
                                   SystemException
Returns the first group in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByCompanyId_First

Group fetchByCompanyId_First(long companyId,
                             OrderByComparator orderByComparator)
                             throws SystemException
Returns the first group in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId_Last

Group findByCompanyId_Last(long companyId,
                           OrderByComparator orderByComparator)
                           throws NoSuchGroupException,
                                  SystemException
Returns the last group in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByCompanyId_Last

Group fetchByCompanyId_Last(long companyId,
                            OrderByComparator orderByComparator)
                            throws SystemException
Returns the last group in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

Group[] findByCompanyId_PrevAndNext(long groupId,
                                    long companyId,
                                    OrderByComparator orderByComparator)
                                    throws NoSuchGroupException,
                                           SystemException
Returns the groups before and after the current group in the ordered set where companyId = ?.

Parameters:
groupId - the primary key of the current group
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next group
Throws:
NoSuchGroupException - if a group with the primary key could not be found
SystemException - if a system exception occurred

findByLiveGroupId

Group findByLiveGroupId(long liveGroupId)
                        throws NoSuchGroupException,
                               SystemException
Returns the group where liveGroupId = ? or throws a NoSuchGroupException if it could not be found.

Parameters:
liveGroupId - the live group ID
Returns:
the matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByLiveGroupId

Group fetchByLiveGroupId(long liveGroupId)
                         throws SystemException
Returns the group where liveGroupId = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
liveGroupId - the live group ID
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

fetchByLiveGroupId

Group fetchByLiveGroupId(long liveGroupId,
                         boolean retrieveFromCache)
                         throws SystemException
Returns the group where liveGroupId = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
liveGroupId - the live group ID
retrieveFromCache - whether to use the finder cache
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByC_N

Group findByC_N(long companyId,
                String name)
                throws NoSuchGroupException,
                       SystemException
Returns the group where companyId = ? and name = ? or throws a NoSuchGroupException if it could not be found.

Parameters:
companyId - the company ID
name - the name
Returns:
the matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByC_N

Group fetchByC_N(long companyId,
                 String name)
                 throws SystemException
Returns the group where companyId = ? and name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company ID
name - the name
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_N

Group fetchByC_N(long companyId,
                 String name,
                 boolean retrieveFromCache)
                 throws SystemException
Returns the group where companyId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company ID
name - the name
retrieveFromCache - whether to use the finder cache
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByC_F

Group findByC_F(long companyId,
                String friendlyURL)
                throws NoSuchGroupException,
                       SystemException
Returns the group where companyId = ? and friendlyURL = ? or throws a NoSuchGroupException if it could not be found.

Parameters:
companyId - the company ID
friendlyURL - the friendly u r l
Returns:
the matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByC_F

Group fetchByC_F(long companyId,
                 String friendlyURL)
                 throws SystemException
Returns the group where companyId = ? and friendlyURL = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company ID
friendlyURL - the friendly u r l
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_F

Group fetchByC_F(long companyId,
                 String friendlyURL,
                 boolean retrieveFromCache)
                 throws SystemException
Returns the group where companyId = ? and friendlyURL = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company ID
friendlyURL - the friendly u r l
retrieveFromCache - whether to use the finder cache
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByT_A

List<Group> findByT_A(int type,
                      boolean active)
                      throws SystemException
Returns all the groups where type = ? and active = ?.

Parameters:
type - the type
active - the active
Returns:
the matching groups
Throws:
SystemException - if a system exception occurred

findByT_A

List<Group> findByT_A(int type,
                      boolean active,
                      int start,
                      int end)
                      throws SystemException
Returns a range of all the groups where type = ? and active = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
type - the type
active - the active
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of matching groups
Throws:
SystemException - if a system exception occurred

findByT_A

List<Group> findByT_A(int type,
                      boolean active,
                      int start,
                      int end,
                      OrderByComparator orderByComparator)
                      throws SystemException
Returns an ordered range of all the groups where type = ? and active = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
type - the type
active - the active
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching groups
Throws:
SystemException - if a system exception occurred

findByT_A_First

Group findByT_A_First(int type,
                      boolean active,
                      OrderByComparator orderByComparator)
                      throws NoSuchGroupException,
                             SystemException
Returns the first group in the ordered set where type = ? and active = ?.

Parameters:
type - the type
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByT_A_First

Group fetchByT_A_First(int type,
                       boolean active,
                       OrderByComparator orderByComparator)
                       throws SystemException
Returns the first group in the ordered set where type = ? and active = ?.

Parameters:
type - the type
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByT_A_Last

Group findByT_A_Last(int type,
                     boolean active,
                     OrderByComparator orderByComparator)
                     throws NoSuchGroupException,
                            SystemException
Returns the last group in the ordered set where type = ? and active = ?.

Parameters:
type - the type
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByT_A_Last

Group fetchByT_A_Last(int type,
                      boolean active,
                      OrderByComparator orderByComparator)
                      throws SystemException
Returns the last group in the ordered set where type = ? and active = ?.

Parameters:
type - the type
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByT_A_PrevAndNext

Group[] findByT_A_PrevAndNext(long groupId,
                              int type,
                              boolean active,
                              OrderByComparator orderByComparator)
                              throws NoSuchGroupException,
                                     SystemException
Returns the groups before and after the current group in the ordered set where type = ? and active = ?.

Parameters:
groupId - the primary key of the current group
type - the type
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next group
Throws:
NoSuchGroupException - if a group with the primary key could not be found
SystemException - if a system exception occurred

findByC_C_C

Group findByC_C_C(long companyId,
                  long classNameId,
                  long classPK)
                  throws NoSuchGroupException,
                         SystemException
Returns the group where companyId = ? and classNameId = ? and classPK = ? or throws a NoSuchGroupException if it could not be found.

Parameters:
companyId - the company ID
classNameId - the class name ID
classPK - the class p k
Returns:
the matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByC_C_C

Group fetchByC_C_C(long companyId,
                   long classNameId,
                   long classPK)
                   throws SystemException
Returns the group where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company ID
classNameId - the class name ID
classPK - the class p k
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_C_C

Group fetchByC_C_C(long companyId,
                   long classNameId,
                   long classPK,
                   boolean retrieveFromCache)
                   throws SystemException
Returns the group where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company ID
classNameId - the class name ID
classPK - the class p k
retrieveFromCache - whether to use the finder cache
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByC_L_N

Group findByC_L_N(long companyId,
                  long liveGroupId,
                  String name)
                  throws NoSuchGroupException,
                         SystemException
Returns the group where companyId = ? and liveGroupId = ? and name = ? or throws a NoSuchGroupException if it could not be found.

Parameters:
companyId - the company ID
liveGroupId - the live group ID
name - the name
Returns:
the matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByC_L_N

Group fetchByC_L_N(long companyId,
                   long liveGroupId,
                   String name)
                   throws SystemException
Returns the group where companyId = ? and liveGroupId = ? and name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company ID
liveGroupId - the live group ID
name - the name
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_L_N

Group fetchByC_L_N(long companyId,
                   long liveGroupId,
                   String name,
                   boolean retrieveFromCache)
                   throws SystemException
Returns the group where companyId = ? and liveGroupId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company ID
liveGroupId - the live group ID
name - the name
retrieveFromCache - whether to use the finder cache
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findByC_C_L_N

Group findByC_C_L_N(long companyId,
                    long classNameId,
                    long liveGroupId,
                    String name)
                    throws NoSuchGroupException,
                           SystemException
Returns the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? or throws a NoSuchGroupException if it could not be found.

Parameters:
companyId - the company ID
classNameId - the class name ID
liveGroupId - the live group ID
name - the name
Returns:
the matching group
Throws:
NoSuchGroupException - if a matching group could not be found
SystemException - if a system exception occurred

fetchByC_C_L_N

Group fetchByC_C_L_N(long companyId,
                     long classNameId,
                     long liveGroupId,
                     String name)
                     throws SystemException
Returns the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company ID
classNameId - the class name ID
liveGroupId - the live group ID
name - the name
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_C_L_N

Group fetchByC_C_L_N(long companyId,
                     long classNameId,
                     long liveGroupId,
                     String name,
                     boolean retrieveFromCache)
                     throws SystemException
Returns the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company ID
classNameId - the class name ID
liveGroupId - the live group ID
name - the name
retrieveFromCache - whether to use the finder cache
Returns:
the matching group, or null if a matching group could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<Group> findAll()
                    throws SystemException
Returns all the groups.

Returns:
the groups
Throws:
SystemException - if a system exception occurred

findAll

List<Group> findAll(int start,
                    int end)
                    throws SystemException
Returns a range of all the groups.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of groups
Throws:
SystemException - if a system exception occurred

findAll

List<Group> findAll(int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException
Returns an ordered range of all the groups.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of groups
Throws:
SystemException - if a system exception occurred

removeByCompanyId

void removeByCompanyId(long companyId)
                       throws SystemException
Removes all the groups where companyId = ? from the database.

Parameters:
companyId - the company ID
Throws:
SystemException - if a system exception occurred

removeByLiveGroupId

Group removeByLiveGroupId(long liveGroupId)
                          throws NoSuchGroupException,
                                 SystemException
Removes the group where liveGroupId = ? from the database.

Parameters:
liveGroupId - the live group ID
Returns:
the group that was removed
Throws:
SystemException - if a system exception occurred
NoSuchGroupException

removeByC_N

Group removeByC_N(long companyId,
                  String name)
                  throws NoSuchGroupException,
                         SystemException
Removes the group where companyId = ? and name = ? from the database.

Parameters:
companyId - the company ID
name - the name
Returns:
the group that was removed
Throws:
SystemException - if a system exception occurred
NoSuchGroupException

removeByC_F

Group removeByC_F(long companyId,
                  String friendlyURL)
                  throws NoSuchGroupException,
                         SystemException
Removes the group where companyId = ? and friendlyURL = ? from the database.

Parameters:
companyId - the company ID
friendlyURL - the friendly u r l
Returns:
the group that was removed
Throws:
SystemException - if a system exception occurred
NoSuchGroupException

removeByT_A

void removeByT_A(int type,
                 boolean active)
                 throws SystemException
Removes all the groups where type = ? and active = ? from the database.

Parameters:
type - the type
active - the active
Throws:
SystemException - if a system exception occurred

removeByC_C_C

Group removeByC_C_C(long companyId,
                    long classNameId,
                    long classPK)
                    throws NoSuchGroupException,
                           SystemException
Removes the group where companyId = ? and classNameId = ? and classPK = ? from the database.

Parameters:
companyId - the company ID
classNameId - the class name ID
classPK - the class p k
Returns:
the group that was removed
Throws:
SystemException - if a system exception occurred
NoSuchGroupException

removeByC_L_N

Group removeByC_L_N(long companyId,
                    long liveGroupId,
                    String name)
                    throws NoSuchGroupException,
                           SystemException
Removes the group where companyId = ? and liveGroupId = ? and name = ? from the database.

Parameters:
companyId - the company ID
liveGroupId - the live group ID
name - the name
Returns:
the group that was removed
Throws:
SystemException - if a system exception occurred
NoSuchGroupException

removeByC_C_L_N

Group removeByC_C_L_N(long companyId,
                      long classNameId,
                      long liveGroupId,
                      String name)
                      throws NoSuchGroupException,
                             SystemException
Removes the group where companyId = ? and classNameId = ? and liveGroupId = ? and name = ? from the database.

Parameters:
companyId - the company ID
classNameId - the class name ID
liveGroupId - the live group ID
name - the name
Returns:
the group that was removed
Throws:
SystemException - if a system exception occurred
NoSuchGroupException

removeAll

void removeAll()
               throws SystemException
Removes all the groups from the database.

Throws:
SystemException - if a system exception occurred

countByCompanyId

int countByCompanyId(long companyId)
                     throws SystemException
Returns the number of groups where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countByLiveGroupId

int countByLiveGroupId(long liveGroupId)
                       throws SystemException
Returns the number of groups where liveGroupId = ?.

Parameters:
liveGroupId - the live group ID
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countByC_N

int countByC_N(long companyId,
               String name)
               throws SystemException
Returns the number of groups where companyId = ? and name = ?.

Parameters:
companyId - the company ID
name - the name
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countByC_F

int countByC_F(long companyId,
               String friendlyURL)
               throws SystemException
Returns the number of groups where companyId = ? and friendlyURL = ?.

Parameters:
companyId - the company ID
friendlyURL - the friendly u r l
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countByT_A

int countByT_A(int type,
               boolean active)
               throws SystemException
Returns the number of groups where type = ? and active = ?.

Parameters:
type - the type
active - the active
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countByC_C_C

int countByC_C_C(long companyId,
                 long classNameId,
                 long classPK)
                 throws SystemException
Returns the number of groups where companyId = ? and classNameId = ? and classPK = ?.

Parameters:
companyId - the company ID
classNameId - the class name ID
classPK - the class p k
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countByC_L_N

int countByC_L_N(long companyId,
                 long liveGroupId,
                 String name)
                 throws SystemException
Returns the number of groups where companyId = ? and liveGroupId = ? and name = ?.

Parameters:
companyId - the company ID
liveGroupId - the live group ID
name - the name
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countByC_C_L_N

int countByC_C_L_N(long companyId,
                   long classNameId,
                   long liveGroupId,
                   String name)
                   throws SystemException
Returns the number of groups where companyId = ? and classNameId = ? and liveGroupId = ? and name = ?.

Parameters:
companyId - the company ID
classNameId - the class name ID
liveGroupId - the live group ID
name - the name
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of groups.

Returns:
the number of groups
Throws:
SystemException - if a system exception occurred

getOrganizations

List<Organization> getOrganizations(long pk)
                                    throws SystemException
Returns all the organizations associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the organizations associated with the group
Throws:
SystemException - if a system exception occurred

getOrganizations

List<Organization> getOrganizations(long pk,
                                    int start,
                                    int end)
                                    throws SystemException
Returns a range of all the organizations associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of organizations associated with the group
Throws:
SystemException - if a system exception occurred

getOrganizations

List<Organization> getOrganizations(long pk,
                                    int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                                    throws SystemException
Returns an ordered range of all the organizations associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of organizations associated with the group
Throws:
SystemException - if a system exception occurred

getOrganizationsSize

int getOrganizationsSize(long pk)
                         throws SystemException
Returns the number of organizations associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the number of organizations associated with the group
Throws:
SystemException - if a system exception occurred

containsOrganization

boolean containsOrganization(long pk,
                             long organizationPK)
                             throws SystemException
Returns true if the organization is associated with the group.

Parameters:
pk - the primary key of the group
organizationPK - the primary key of the organization
Returns:
true if the organization is associated with the group; false otherwise
Throws:
SystemException - if a system exception occurred

containsOrganizations

boolean containsOrganizations(long pk)
                              throws SystemException
Returns true if the group has any organizations associated with it.

Parameters:
pk - the primary key of the group to check for associations with organizations
Returns:
true if the group has any organizations associated with it; false otherwise
Throws:
SystemException - if a system exception occurred

addOrganization

void addOrganization(long pk,
                     long organizationPK)
                     throws SystemException
Adds an association between the group and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizationPK - the primary key of the organization
Throws:
SystemException - if a system exception occurred

addOrganization

void addOrganization(long pk,
                     Organization organization)
                     throws SystemException
Adds an association between the group and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organization - the organization
Throws:
SystemException - if a system exception occurred

addOrganizations

void addOrganizations(long pk,
                      long[] organizationPKs)
                      throws SystemException
Adds an association between the group and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizationPKs - the primary keys of the organizations
Throws:
SystemException - if a system exception occurred

addOrganizations

void addOrganizations(long pk,
                      List<Organization> organizations)
                      throws SystemException
Adds an association between the group and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizations - the organizations
Throws:
SystemException - if a system exception occurred

clearOrganizations

void clearOrganizations(long pk)
                        throws SystemException
Clears all associations between the group and its organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group to clear the associated organizations from
Throws:
SystemException - if a system exception occurred

removeOrganization

void removeOrganization(long pk,
                        long organizationPK)
                        throws SystemException
Removes the association between the group and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizationPK - the primary key of the organization
Throws:
SystemException - if a system exception occurred

removeOrganization

void removeOrganization(long pk,
                        Organization organization)
                        throws SystemException
Removes the association between the group and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organization - the organization
Throws:
SystemException - if a system exception occurred

removeOrganizations

void removeOrganizations(long pk,
                         long[] organizationPKs)
                         throws SystemException
Removes the association between the group and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizationPKs - the primary keys of the organizations
Throws:
SystemException - if a system exception occurred

removeOrganizations

void removeOrganizations(long pk,
                         List<Organization> organizations)
                         throws SystemException
Removes the association between the group and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizations - the organizations
Throws:
SystemException - if a system exception occurred

setOrganizations

void setOrganizations(long pk,
                      long[] organizationPKs)
                      throws SystemException
Sets the organizations associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizationPKs - the primary keys of the organizations to be associated with the group
Throws:
SystemException - if a system exception occurred

setOrganizations

void setOrganizations(long pk,
                      List<Organization> organizations)
                      throws SystemException
Sets the organizations associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
organizations - the organizations to be associated with the group
Throws:
SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk)
                                throws SystemException
Returns all the permissions associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the permissions associated with the group
Throws:
SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk,
                                int start,
                                int end)
                                throws SystemException
Returns a range of all the permissions associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of permissions associated with the group
Throws:
SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException
Returns an ordered range of all the permissions associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of permissions associated with the group
Throws:
SystemException - if a system exception occurred

getPermissionsSize

int getPermissionsSize(long pk)
                       throws SystemException
Returns the number of permissions associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the number of permissions associated with the group
Throws:
SystemException - if a system exception occurred

containsPermission

boolean containsPermission(long pk,
                           long permissionPK)
                           throws SystemException
Returns true if the permission is associated with the group.

Parameters:
pk - the primary key of the group
permissionPK - the primary key of the permission
Returns:
true if the permission is associated with the group; false otherwise
Throws:
SystemException - if a system exception occurred

containsPermissions

boolean containsPermissions(long pk)
                            throws SystemException
Returns true if the group has any permissions associated with it.

Parameters:
pk - the primary key of the group to check for associations with permissions
Returns:
true if the group has any permissions associated with it; false otherwise
Throws:
SystemException - if a system exception occurred

addPermission

void addPermission(long pk,
                   long permissionPK)
                   throws SystemException
Adds an association between the group and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissionPK - the primary key of the permission
Throws:
SystemException - if a system exception occurred

addPermission

void addPermission(long pk,
                   Permission permission)
                   throws SystemException
Adds an association between the group and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permission - the permission
Throws:
SystemException - if a system exception occurred

addPermissions

void addPermissions(long pk,
                    long[] permissionPKs)
                    throws SystemException
Adds an association between the group and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissionPKs - the primary keys of the permissions
Throws:
SystemException - if a system exception occurred

addPermissions

void addPermissions(long pk,
                    List<Permission> permissions)
                    throws SystemException
Adds an association between the group and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissions - the permissions
Throws:
SystemException - if a system exception occurred

clearPermissions

void clearPermissions(long pk)
                      throws SystemException
Clears all associations between the group and its permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group to clear the associated permissions from
Throws:
SystemException - if a system exception occurred

removePermission

void removePermission(long pk,
                      long permissionPK)
                      throws SystemException
Removes the association between the group and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissionPK - the primary key of the permission
Throws:
SystemException - if a system exception occurred

removePermission

void removePermission(long pk,
                      Permission permission)
                      throws SystemException
Removes the association between the group and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permission - the permission
Throws:
SystemException - if a system exception occurred

removePermissions

void removePermissions(long pk,
                       long[] permissionPKs)
                       throws SystemException
Removes the association between the group and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissionPKs - the primary keys of the permissions
Throws:
SystemException - if a system exception occurred

removePermissions

void removePermissions(long pk,
                       List<Permission> permissions)
                       throws SystemException
Removes the association between the group and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissions - the permissions
Throws:
SystemException - if a system exception occurred

setPermissions

void setPermissions(long pk,
                    long[] permissionPKs)
                    throws SystemException
Sets the permissions associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissionPKs - the primary keys of the permissions to be associated with the group
Throws:
SystemException - if a system exception occurred

setPermissions

void setPermissions(long pk,
                    List<Permission> permissions)
                    throws SystemException
Sets the permissions associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
permissions - the permissions to be associated with the group
Throws:
SystemException - if a system exception occurred

getRoles

List<Role> getRoles(long pk)
                    throws SystemException
Returns all the roles associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the roles associated with the group
Throws:
SystemException - if a system exception occurred

getRoles

List<Role> getRoles(long pk,
                    int start,
                    int end)
                    throws SystemException
Returns a range of all the roles associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of roles associated with the group
Throws:
SystemException - if a system exception occurred

getRoles

List<Role> getRoles(long pk,
                    int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException
Returns an ordered range of all the roles associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of roles associated with the group
Throws:
SystemException - if a system exception occurred

getRolesSize

int getRolesSize(long pk)
                 throws SystemException
Returns the number of roles associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the number of roles associated with the group
Throws:
SystemException - if a system exception occurred

containsRole

boolean containsRole(long pk,
                     long rolePK)
                     throws SystemException
Returns true if the role is associated with the group.

Parameters:
pk - the primary key of the group
rolePK - the primary key of the role
Returns:
true if the role is associated with the group; false otherwise
Throws:
SystemException - if a system exception occurred

containsRoles

boolean containsRoles(long pk)
                      throws SystemException
Returns true if the group has any roles associated with it.

Parameters:
pk - the primary key of the group to check for associations with roles
Returns:
true if the group has any roles associated with it; false otherwise
Throws:
SystemException - if a system exception occurred

addRole

void addRole(long pk,
             long rolePK)
             throws SystemException
Adds an association between the group and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
rolePK - the primary key of the role
Throws:
SystemException - if a system exception occurred

addRole

void addRole(long pk,
             Role role)
             throws SystemException
Adds an association between the group and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
role - the role
Throws:
SystemException - if a system exception occurred

addRoles

void addRoles(long pk,
              long[] rolePKs)
              throws SystemException
Adds an association between the group and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
rolePKs - the primary keys of the roles
Throws:
SystemException - if a system exception occurred

addRoles

void addRoles(long pk,
              List<Role> roles)
              throws SystemException
Adds an association between the group and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
roles - the roles
Throws:
SystemException - if a system exception occurred

clearRoles

void clearRoles(long pk)
                throws SystemException
Clears all associations between the group and its roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group to clear the associated roles from
Throws:
SystemException - if a system exception occurred

removeRole

void removeRole(long pk,
                long rolePK)
                throws SystemException
Removes the association between the group and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
rolePK - the primary key of the role
Throws:
SystemException - if a system exception occurred

removeRole

void removeRole(long pk,
                Role role)
                throws SystemException
Removes the association between the group and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
role - the role
Throws:
SystemException - if a system exception occurred

removeRoles

void removeRoles(long pk,
                 long[] rolePKs)
                 throws SystemException
Removes the association between the group and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
rolePKs - the primary keys of the roles
Throws:
SystemException - if a system exception occurred

removeRoles

void removeRoles(long pk,
                 List<Role> roles)
                 throws SystemException
Removes the association between the group and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
roles - the roles
Throws:
SystemException - if a system exception occurred

setRoles

void setRoles(long pk,
              long[] rolePKs)
              throws SystemException
Sets the roles associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
rolePKs - the primary keys of the roles to be associated with the group
Throws:
SystemException - if a system exception occurred

setRoles

void setRoles(long pk,
              List<Role> roles)
              throws SystemException
Sets the roles associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
roles - the roles to be associated with the group
Throws:
SystemException - if a system exception occurred

getUserGroups

List<UserGroup> getUserGroups(long pk)
                              throws SystemException
Returns all the user groups associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the user groups associated with the group
Throws:
SystemException - if a system exception occurred

getUserGroups

List<UserGroup> getUserGroups(long pk,
                              int start,
                              int end)
                              throws SystemException
Returns a range of all the user groups associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of user groups associated with the group
Throws:
SystemException - if a system exception occurred

getUserGroups

List<UserGroup> getUserGroups(long pk,
                              int start,
                              int end,
                              OrderByComparator orderByComparator)
                              throws SystemException
Returns an ordered range of all the user groups associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of user groups associated with the group
Throws:
SystemException - if a system exception occurred

getUserGroupsSize

int getUserGroupsSize(long pk)
                      throws SystemException
Returns the number of user groups associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the number of user groups associated with the group
Throws:
SystemException - if a system exception occurred

containsUserGroup

boolean containsUserGroup(long pk,
                          long userGroupPK)
                          throws SystemException
Returns true if the user group is associated with the group.

Parameters:
pk - the primary key of the group
userGroupPK - the primary key of the user group
Returns:
true if the user group is associated with the group; false otherwise
Throws:
SystemException - if a system exception occurred

containsUserGroups

boolean containsUserGroups(long pk)
                           throws SystemException
Returns true if the group has any user groups associated with it.

Parameters:
pk - the primary key of the group to check for associations with user groups
Returns:
true if the group has any user groups associated with it; false otherwise
Throws:
SystemException - if a system exception occurred

addUserGroup

void addUserGroup(long pk,
                  long userGroupPK)
                  throws SystemException
Adds an association between the group and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroupPK - the primary key of the user group
Throws:
SystemException - if a system exception occurred

addUserGroup

void addUserGroup(long pk,
                  UserGroup userGroup)
                  throws SystemException
Adds an association between the group and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroup - the user group
Throws:
SystemException - if a system exception occurred

addUserGroups

void addUserGroups(long pk,
                   long[] userGroupPKs)
                   throws SystemException
Adds an association between the group and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroupPKs - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

addUserGroups

void addUserGroups(long pk,
                   List<UserGroup> userGroups)
                   throws SystemException
Adds an association between the group and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroups - the user groups
Throws:
SystemException - if a system exception occurred

clearUserGroups

void clearUserGroups(long pk)
                     throws SystemException
Clears all associations between the group and its user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group to clear the associated user groups from
Throws:
SystemException - if a system exception occurred

removeUserGroup

void removeUserGroup(long pk,
                     long userGroupPK)
                     throws SystemException
Removes the association between the group and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroupPK - the primary key of the user group
Throws:
SystemException - if a system exception occurred

removeUserGroup

void removeUserGroup(long pk,
                     UserGroup userGroup)
                     throws SystemException
Removes the association between the group and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroup - the user group
Throws:
SystemException - if a system exception occurred

removeUserGroups

void removeUserGroups(long pk,
                      long[] userGroupPKs)
                      throws SystemException
Removes the association between the group and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroupPKs - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

removeUserGroups

void removeUserGroups(long pk,
                      List<UserGroup> userGroups)
                      throws SystemException
Removes the association between the group and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroups - the user groups
Throws:
SystemException - if a system exception occurred

setUserGroups

void setUserGroups(long pk,
                   long[] userGroupPKs)
                   throws SystemException
Sets the user groups associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroupPKs - the primary keys of the user groups to be associated with the group
Throws:
SystemException - if a system exception occurred

setUserGroups

void setUserGroups(long pk,
                   List<UserGroup> userGroups)
                   throws SystemException
Sets the user groups associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userGroups - the user groups to be associated with the group
Throws:
SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk)
                    throws SystemException
Returns all the users associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the users associated with the group
Throws:
SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk,
                    int start,
                    int end)
                    throws SystemException
Returns a range of all the users associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
Returns:
the range of users associated with the group
Throws:
SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk,
                    int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException
Returns an ordered range of all the users associated with the group.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the group
start - the lower bound of the range of groups
end - the upper bound of the range of groups (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of users associated with the group
Throws:
SystemException - if a system exception occurred

getUsersSize

int getUsersSize(long pk)
                 throws SystemException
Returns the number of users associated with the group.

Parameters:
pk - the primary key of the group
Returns:
the number of users associated with the group
Throws:
SystemException - if a system exception occurred

containsUser

boolean containsUser(long pk,
                     long userPK)
                     throws SystemException
Returns true if the user is associated with the group.

Parameters:
pk - the primary key of the group
userPK - the primary key of the user
Returns:
true if the user is associated with the group; false otherwise
Throws:
SystemException - if a system exception occurred

containsUsers

boolean containsUsers(long pk)
                      throws SystemException
Returns true if the group has any users associated with it.

Parameters:
pk - the primary key of the group to check for associations with users
Returns:
true if the group has any users associated with it; false otherwise
Throws:
SystemException - if a system exception occurred

addUser

void addUser(long pk,
             long userPK)
             throws SystemException
Adds an association between the group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userPK - the primary key of the user
Throws:
SystemException - if a system exception occurred

addUser

void addUser(long pk,
             User user)
             throws SystemException
Adds an association between the group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
user - the user
Throws:
SystemException - if a system exception occurred

addUsers

void addUsers(long pk,
              long[] userPKs)
              throws SystemException
Adds an association between the group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userPKs - the primary keys of the users
Throws:
SystemException - if a system exception occurred

addUsers

void addUsers(long pk,
              List<User> users)
              throws SystemException
Adds an association between the group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
users - the users
Throws:
SystemException - if a system exception occurred

clearUsers

void clearUsers(long pk)
                throws SystemException
Clears all associations between the group and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group to clear the associated users from
Throws:
SystemException - if a system exception occurred

removeUser

void removeUser(long pk,
                long userPK)
                throws SystemException
Removes the association between the group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userPK - the primary key of the user
Throws:
SystemException - if a system exception occurred

removeUser

void removeUser(long pk,
                User user)
                throws SystemException
Removes the association between the group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
user - the user
Throws:
SystemException - if a system exception occurred

removeUsers

void removeUsers(long pk,
                 long[] userPKs)
                 throws SystemException
Removes the association between the group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userPKs - the primary keys of the users
Throws:
SystemException - if a system exception occurred

removeUsers

void removeUsers(long pk,
                 List<User> users)
                 throws SystemException
Removes the association between the group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
users - the users
Throws:
SystemException - if a system exception occurred

setUsers

void setUsers(long pk,
              long[] userPKs)
              throws SystemException
Sets the users associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
userPKs - the primary keys of the users to be associated with the group
Throws:
SystemException - if a system exception occurred

setUsers

void setUsers(long pk,
              List<User> users)
              throws SystemException
Sets the users associated with the group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the group
users - the users to be associated with the group
Throws:
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3