com.liferay.portal.service
Interface ClusterGroupLocalService

All Known Implementing Classes:

ClusterGroupLocalServiceBaseImpl, ClusterGroupLocalServiceImpl, ClusterGroupLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ClusterGroupLocalService

The interface for the cluster group local service.

Never modify or reference this interface directly. Always use ClusterGroupLocalServiceUtil to access the cluster group local service. Add custom service methods to ClusterGroupLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

ClusterGroupLocalServiceUtil, ClusterGroupLocalServiceBaseImpl, ClusterGroupLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

ClusterGroup	addClusterGroup(ClusterGroup clusterGroup) Adds the cluster group to the database.
ClusterGroup	addClusterGroup(String name, List<String> clusterNodeIds)
ClusterGroup	addWholeClusterGroup(String name)
ClusterGroup	createClusterGroup(long clusterGroupId) Creates a new cluster group with the primary key.
void	deleteClusterGroup(ClusterGroup clusterGroup) Deletes the cluster group from the database.
void	deleteClusterGroup(long clusterGroupId) Deletes the cluster group with the primary key from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
ClusterGroup	getClusterGroup(long clusterGroupId) Gets the cluster group with the primary key.
List<ClusterGroup>	getClusterGroups(int start, int end) Gets a range of all the cluster groups.
int	getClusterGroupsCount() Gets the number of cluster groups.
ClusterGroup	updateClusterGroup(ClusterGroup clusterGroup) Updates the cluster group in the database.
ClusterGroup	updateClusterGroup(ClusterGroup clusterGroup, boolean merge) Updates the cluster group in the database.

Method Detail

addClusterGroup

ClusterGroup addClusterGroup(ClusterGroup clusterGroup)
                             throws SystemException

Adds the cluster group to the database. Also notifies the appropriate model listeners.

Parameters:

clusterGroup - the cluster group to add

Returns:

the cluster group that was added

Throws:

SystemException - if a system exception occurred

createClusterGroup

ClusterGroup createClusterGroup(long clusterGroupId)

Creates a new cluster group with the primary key. Does not add the cluster group to the database.

Parameters:

clusterGroupId - the primary key for the new cluster group

Returns:

the new cluster group

deleteClusterGroup

void deleteClusterGroup(long clusterGroupId)
                        throws PortalException,
                               SystemException

Deletes the cluster group with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

clusterGroupId - the primary key of the cluster group to delete

Throws:

PortalException - if a cluster group with the primary key could not be found

SystemException - if a system exception occurred

deleteClusterGroup

void deleteClusterGroup(ClusterGroup clusterGroup)
                        throws SystemException

Deletes the cluster group from the database. Also notifies the appropriate model listeners.

Parameters:

clusterGroup - the cluster group to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

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:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getClusterGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClusterGroup getClusterGroup(long clusterGroupId)
                             throws PortalException,
                                    SystemException

Gets the cluster group with the primary key.

Parameters:

clusterGroupId - the primary key of the cluster group to get

Returns:

the cluster group

Throws:

PortalException - if a cluster group with the primary key could not be found

SystemException - if a system exception occurred

getClusterGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ClusterGroup> getClusterGroups(int start,
                                                                             int end)
                                    throws SystemException

Gets a range of all the cluster 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 cluster groups to return

end - the upper bound of the range of cluster groups to return (not inclusive)

Returns:

the range of cluster groups

Throws:

SystemException - if a system exception occurred

getClusterGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getClusterGroupsCount()
                          throws SystemException

Gets the number of cluster groups.

Returns:

the number of cluster groups

Throws:

SystemException - if a system exception occurred

updateClusterGroup

ClusterGroup updateClusterGroup(ClusterGroup clusterGroup)
                                throws SystemException

Updates the cluster group in the database. Also notifies the appropriate model listeners.

Parameters:

clusterGroup - the cluster group to update

Returns:

the cluster group that was updated

Throws:

SystemException - if a system exception occurred

updateClusterGroup

ClusterGroup updateClusterGroup(ClusterGroup clusterGroup,
                                boolean merge)
                                throws SystemException

Updates the cluster group in the database. Also notifies the appropriate model listeners.

Parameters:

clusterGroup - the cluster group to update

merge - whether to merge the cluster group with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the cluster group that was updated

Throws:

SystemException - if a system exception occurred

addClusterGroup

ClusterGroup addClusterGroup(String name,
                             List<String> clusterNodeIds)
                             throws SystemException

Throws:

SystemException

addWholeClusterGroup

ClusterGroup addWholeClusterGroup(String name)
                                  throws SystemException

Throws:

SystemException