com.liferay.portal.service.persistence.ClusterGroupPersistence Maven / Gradle / Ivy
Show all versions of portal-service Show documentation
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service.persistence;
import com.liferay.portal.model.ClusterGroup;
/**
* The persistence interface for the cluster group service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see ClusterGroupPersistenceImpl
* @see ClusterGroupUtil
* @generated
*/
public interface ClusterGroupPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link ClusterGroupUtil} to access the cluster group persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Caches the cluster group in the entity cache if it is enabled.
*
* @param clusterGroup the cluster group
*/
public void cacheResult(com.liferay.portal.model.ClusterGroup clusterGroup);
/**
* Caches the cluster groups in the entity cache if it is enabled.
*
* @param clusterGroups the cluster groups
*/
public void cacheResult(
java.util.List clusterGroups);
/**
* Creates a new cluster group with the primary key. Does not add the cluster group to the database.
*
* @param clusterGroupId the primary key for the new cluster group
* @return the new cluster group
*/
public com.liferay.portal.model.ClusterGroup create(long clusterGroupId);
/**
* Removes the cluster group with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param clusterGroupId the primary key of the cluster group
* @return the cluster group that was removed
* @throws com.liferay.portal.NoSuchClusterGroupException if a cluster group with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ClusterGroup remove(long clusterGroupId)
throws com.liferay.portal.NoSuchClusterGroupException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.ClusterGroup updateImpl(
com.liferay.portal.model.ClusterGroup clusterGroup)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the cluster group with the primary key or throws a {@link com.liferay.portal.NoSuchClusterGroupException} if it could not be found.
*
* @param clusterGroupId the primary key of the cluster group
* @return the cluster group
* @throws com.liferay.portal.NoSuchClusterGroupException if a cluster group with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ClusterGroup findByPrimaryKey(
long clusterGroupId)
throws com.liferay.portal.NoSuchClusterGroupException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the cluster group with the primary key or returns null if it could not be found.
*
* @param clusterGroupId the primary key of the cluster group
* @return the cluster group, or null if a cluster group with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ClusterGroup fetchByPrimaryKey(
long clusterGroupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the cluster groups.
*
* @return the cluster groups
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll()
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of cluster groups
* @param end the upper bound of the range of cluster groups (not inclusive)
* @return the range of cluster groups
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered 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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of cluster groups
* @param end the upper bound of the range of cluster groups (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of cluster groups
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the cluster groups from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of cluster groups.
*
* @return the number of cluster groups
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}