com.liferay.portal.service.persistence.LayoutSetPersistence 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 aQute.bnd.annotation.ProviderType;
import com.liferay.portal.model.LayoutSet;
/**
* The persistence interface for the layout set service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see LayoutSetPersistenceImpl
* @see LayoutSetUtil
* @generated
*/
@ProviderType
public interface LayoutSetPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link LayoutSetUtil} to access the layout set persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the layout sets where groupId = ?.
*
* @param groupId the group ID
* @return the matching layout sets
* @throws SystemException if a system exception occurred
*/
public java.util.List findByGroupId(
long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the layout sets where groupId = ?.
*
*
* 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.LayoutSetModelImpl}. 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 groupId the group ID
* @param start the lower bound of the range of layout sets
* @param end the upper bound of the range of layout sets (not inclusive)
* @return the range of matching layout sets
* @throws SystemException if a system exception occurred
*/
public java.util.List findByGroupId(
long groupId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the layout sets where groupId = ?.
*
*
* 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.LayoutSetModelImpl}. 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 groupId the group ID
* @param start the lower bound of the range of layout sets
* @param end the upper bound of the range of layout sets (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching layout sets
* @throws SystemException if a system exception occurred
*/
public java.util.List findByGroupId(
long groupId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first layout set in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet findByGroupId_First(
long groupId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first layout set in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching layout set, or null if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet fetchByGroupId_First(
long groupId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last layout set in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet findByGroupId_Last(long groupId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last layout set in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching layout set, or null if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet fetchByGroupId_Last(
long groupId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout sets before and after the current layout set in the ordered set where groupId = ?.
*
* @param layoutSetId the primary key of the current layout set
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet[] findByGroupId_PrevAndNext(
long layoutSetId, long groupId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the layout sets where groupId = ? from the database.
*
* @param groupId the group ID
* @throws SystemException if a system exception occurred
*/
public void removeByGroupId(long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of layout sets where groupId = ?.
*
* @param groupId the group ID
* @return the number of matching layout sets
* @throws SystemException if a system exception occurred
*/
public int countByGroupId(long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the layout sets where layoutSetPrototypeUuid = ?.
*
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @return the matching layout sets
* @throws SystemException if a system exception occurred
*/
public java.util.List findByLayoutSetPrototypeUuid(
java.lang.String layoutSetPrototypeUuid)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the layout sets where layoutSetPrototypeUuid = ?.
*
*
* 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.LayoutSetModelImpl}. 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 layoutSetPrototypeUuid the layout set prototype uuid
* @param start the lower bound of the range of layout sets
* @param end the upper bound of the range of layout sets (not inclusive)
* @return the range of matching layout sets
* @throws SystemException if a system exception occurred
*/
public java.util.List findByLayoutSetPrototypeUuid(
java.lang.String layoutSetPrototypeUuid, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the layout sets where layoutSetPrototypeUuid = ?.
*
*
* 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.LayoutSetModelImpl}. 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 layoutSetPrototypeUuid the layout set prototype uuid
* @param start the lower bound of the range of layout sets
* @param end the upper bound of the range of layout sets (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching layout sets
* @throws SystemException if a system exception occurred
*/
public java.util.List findByLayoutSetPrototypeUuid(
java.lang.String layoutSetPrototypeUuid, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?.
*
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet findByLayoutSetPrototypeUuid_First(
java.lang.String layoutSetPrototypeUuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?.
*
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching layout set, or null if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet fetchByLayoutSetPrototypeUuid_First(
java.lang.String layoutSetPrototypeUuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?.
*
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet findByLayoutSetPrototypeUuid_Last(
java.lang.String layoutSetPrototypeUuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?.
*
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching layout set, or null if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet fetchByLayoutSetPrototypeUuid_Last(
java.lang.String layoutSetPrototypeUuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout sets before and after the current layout set in the ordered set where layoutSetPrototypeUuid = ?.
*
* @param layoutSetId the primary key of the current layout set
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet[] findByLayoutSetPrototypeUuid_PrevAndNext(
long layoutSetId, java.lang.String layoutSetPrototypeUuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the layout sets where layoutSetPrototypeUuid = ? from the database.
*
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @throws SystemException if a system exception occurred
*/
public void removeByLayoutSetPrototypeUuid(
java.lang.String layoutSetPrototypeUuid)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of layout sets where layoutSetPrototypeUuid = ?.
*
* @param layoutSetPrototypeUuid the layout set prototype uuid
* @return the number of matching layout sets
* @throws SystemException if a system exception occurred
*/
public int countByLayoutSetPrototypeUuid(
java.lang.String layoutSetPrototypeUuid)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout set where groupId = ? and privateLayout = ? or throws a {@link com.liferay.portal.NoSuchLayoutSetException} if it could not be found.
*
* @param groupId the group ID
* @param privateLayout the private layout
* @return the matching layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet findByG_P(long groupId,
boolean privateLayout)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout set where groupId = ? and privateLayout = ? or returns null if it could not be found. Uses the finder cache.
*
* @param groupId the group ID
* @param privateLayout the private layout
* @return the matching layout set, or null if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet fetchByG_P(long groupId,
boolean privateLayout)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout set where groupId = ? and privateLayout = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param groupId the group ID
* @param privateLayout the private layout
* @param retrieveFromCache whether to use the finder cache
* @return the matching layout set, or null if a matching layout set could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet fetchByG_P(long groupId,
boolean privateLayout, boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the layout set where groupId = ? and privateLayout = ? from the database.
*
* @param groupId the group ID
* @param privateLayout the private layout
* @return the layout set that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet removeByG_P(long groupId,
boolean privateLayout)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of layout sets where groupId = ? and privateLayout = ?.
*
* @param groupId the group ID
* @param privateLayout the private layout
* @return the number of matching layout sets
* @throws SystemException if a system exception occurred
*/
public int countByG_P(long groupId, boolean privateLayout)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Caches the layout set in the entity cache if it is enabled.
*
* @param layoutSet the layout set
*/
public void cacheResult(com.liferay.portal.model.LayoutSet layoutSet);
/**
* Caches the layout sets in the entity cache if it is enabled.
*
* @param layoutSets the layout sets
*/
public void cacheResult(
java.util.List layoutSets);
/**
* Creates a new layout set with the primary key. Does not add the layout set to the database.
*
* @param layoutSetId the primary key for the new layout set
* @return the new layout set
*/
public com.liferay.portal.model.LayoutSet create(long layoutSetId);
/**
* Removes the layout set with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param layoutSetId the primary key of the layout set
* @return the layout set that was removed
* @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet remove(long layoutSetId)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateImpl(
com.liferay.portal.model.LayoutSet layoutSet)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout set with the primary key or throws a {@link com.liferay.portal.NoSuchLayoutSetException} if it could not be found.
*
* @param layoutSetId the primary key of the layout set
* @return the layout set
* @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet findByPrimaryKey(long layoutSetId)
throws com.liferay.portal.NoSuchLayoutSetException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout set with the primary key or returns null if it could not be found.
*
* @param layoutSetId the primary key of the layout set
* @return the layout set, or null if a layout set with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet fetchByPrimaryKey(
long layoutSetId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the layout sets.
*
* @return the layout sets
* @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 layout sets.
*
*
* 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.LayoutSetModelImpl}. 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 layout sets
* @param end the upper bound of the range of layout sets (not inclusive)
* @return the range of layout sets
* @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 layout sets.
*
*
* 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.LayoutSetModelImpl}. 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 layout sets
* @param end the upper bound of the range of layout sets (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of layout sets
* @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 layout sets from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of layout sets.
*
* @return the number of layout sets
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}