Liferay 7.0-ce-b4

com.liferay.portal.service
Interface ClusterGroupLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ClusterGroupLocalServiceWrapper

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

Provides the local service interface for ClusterGroup. 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, com.liferay.portal.service.impl.ClusterGroupLocalServiceImpl

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.
 ClusterGroup deleteClusterGroup(ClusterGroup clusterGroup)
          Deletes the cluster group from the database.
 ClusterGroup deleteClusterGroup(long clusterGroupId)
          Deletes the cluster group with the primary key from the database.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 ClusterGroup fetchClusterGroup(long clusterGroupId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 ClusterGroup getClusterGroup(long clusterGroupId)
          Returns the cluster group with the primary key.
 List<ClusterGroup> getClusterGroups(int start, int end)
          Returns a range of all the cluster groups.
 int getClusterGroupsCount()
          Returns the number of cluster groups.
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 ClusterGroup updateClusterGroup(ClusterGroup clusterGroup)
          Updates the cluster group in the database or adds it if it does not yet exist.
 

Method Detail

addClusterGroup

@Indexable(type=REINDEX)
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

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

addWholeClusterGroup

ClusterGroup addWholeClusterGroup(String name)

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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

<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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClusterGroup fetchClusterGroup(long clusterGroupId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getClusterGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getClusterGroupsCount()
Returns the number of cluster groups.

Returns:
the number of cluster groups

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

updateClusterGroup

@Indexable(type=REINDEX)
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

Liferay 7.0-ce-b4