Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class ClusterGroupLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.ClusterGroupLocalServiceUtil

public class ClusterGroupLocalServiceUtil
extends Object

The utility for the cluster group local service. This utility wraps ClusterGroupLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:
ClusterGroupLocalService, ClusterGroupLocalServiceBaseImpl, ClusterGroupLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
ClusterGroupLocalServiceUtil()
           
 
Method Summary
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 DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static ClusterGroup fetchClusterGroup(long clusterGroupId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static ClusterGroupLocalService getService()
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(ClusterGroupLocalService service)
          Deprecated.  
static ClusterGroup updateClusterGroup(ClusterGroup clusterGroup)
          Updates the cluster group in the database or adds it if it does not yet exist.
static ClusterGroup updateClusterGroup(ClusterGroup clusterGroup, boolean merge)
          Updates the cluster group in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.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)
                                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

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(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
Returns:
the cluster group that was removed
Throws:
PortalException - if a cluster group with the primary key could not be found
SystemException - if a system exception occurred

deleteClusterGroup

public static ClusterGroup deleteClusterGroup(ClusterGroup clusterGroup)
                                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static 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
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static 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
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchClusterGroup

public static ClusterGroup fetchClusterGroup(long clusterGroupId)
                                      throws SystemException
Throws:
SystemException

getClusterGroup

public static ClusterGroup getClusterGroup(long clusterGroupId)
                                    throws PortalException,
                                           SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getClusterGroups

public static List<ClusterGroup> getClusterGroups(int start,
                                                  int end)
                                           throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

getClusterGroupsCount

public static int getClusterGroupsCount()
                                 throws SystemException
Returns the number of cluster groups.

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

updateClusterGroup

public static ClusterGroup updateClusterGroup(ClusterGroup clusterGroup)
                                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateClusterGroup

public static ClusterGroup updateClusterGroup(ClusterGroup clusterGroup,
                                              boolean merge)
                                       throws SystemException
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
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

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addClusterGroup

public static ClusterGroup addClusterGroup(String name,
                                           List<String> clusterNodeIds)
                                    throws SystemException
Throws:
SystemException

addWholeClusterGroup

public static ClusterGroup addWholeClusterGroup(String name)
                                         throws SystemException
Throws:
SystemException

getService

public static ClusterGroupLocalService getService()

setService

public void setService(ClusterGroupLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3