com.liferay.portal.kernel.service

Class ClusterGroupLocalServiceUtil

Object

com.liferay.portal.kernel.service.ClusterGroupLocalServiceUtil

@ProviderType
public class ClusterGroupLocalServiceUtil
extends Object

Provides the local service utility for ClusterGroup. This utility wraps ClusterGroupLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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.

Author:

Brian Wing Shun Chan

See Also:

ClusterGroupLocalService, ClusterGroupLocalServiceBaseImpl, ClusterGroupLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ClusterGroupLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ClusterGroup	addClusterGroup(ClusterGroup clusterGroup) Adds the cluster group to the database.
static ClusterGroup	addClusterGroup(String name, List<String> clusterNodeIds)
static ClusterGroup	addWholeClusterGroup(String name)
static ClusterGroup	createClusterGroup(long clusterGroupId) Creates a new cluster group with the primary key.
static ClusterGroup	deleteClusterGroup(ClusterGroup clusterGroup) Deletes the cluster group from the database.
static ClusterGroup	deleteClusterGroup(long clusterGroupId) Deletes the cluster group with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static ClusterGroup	fetchClusterGroup(long clusterGroupId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static ClusterGroup	getClusterGroup(long clusterGroupId) Returns the cluster group with the primary key.
static List<ClusterGroup>	getClusterGroups(int start, int end) Returns a range of all the cluster groups.
static int	getClusterGroupsCount() Returns the number of cluster groups.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ClusterGroupLocalService	getService()
static ClusterGroup	updateClusterGroup(ClusterGroup clusterGroup) Updates the cluster group in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClusterGroupLocalServiceUtil

public ClusterGroupLocalServiceUtil()

Method Detail

addClusterGroup

public static ClusterGroup addClusterGroup(ClusterGroup clusterGroup)

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

Parameters:

clusterGroup - the cluster group

Returns:

the cluster group that was added

addClusterGroup

public static ClusterGroup addClusterGroup(String name,
                                           List<String> clusterNodeIds)

addWholeClusterGroup

public static ClusterGroup addWholeClusterGroup(String name)

createClusterGroup

public static 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

public static ClusterGroup deleteClusterGroup(ClusterGroup clusterGroup)

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

Parameters:

clusterGroup - the cluster group

Returns:

the cluster group that was removed

deleteClusterGroup

public static ClusterGroup deleteClusterGroup(long clusterGroupId)
                                       throws PortalException

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

Returns:

the cluster group that was removed

Throws:

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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ClusterGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

Returns:

the range of matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ClusterGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchClusterGroup

public static ClusterGroup fetchClusterGroup(long clusterGroupId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getClusterGroup

public static ClusterGroup getClusterGroup(long clusterGroupId)
                                    throws PortalException

Returns the cluster group with the primary key.

Parameters:

clusterGroupId - the primary key of the cluster group

Returns:

the cluster group

Throws:

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

getClusterGroups

public static List<ClusterGroup> getClusterGroups(int start,
                                                  int end)

Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ClusterGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of cluster groups

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

Returns:

the range of cluster groups

getClusterGroupsCount

public static int getClusterGroupsCount()

Returns the number of cluster groups.

Returns:

the number of cluster groups

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateClusterGroup

public static ClusterGroup updateClusterGroup(ClusterGroup clusterGroup)

Updates the cluster group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

clusterGroup - the cluster group

Returns:

the cluster group that was updated

getService

public static ClusterGroupLocalService getService()