com.liferay.portal.service.persistence

Interface LayoutSetPersistence

All Superinterfaces:

BasePersistence<LayoutSet>

@ProviderType
public interface LayoutSetPersistence
extends BasePersistence<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 Also:

LayoutSetPersistenceImpl, LayoutSetUtil

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
void	cacheResult(LayoutSet layoutSet) Caches the layout set in the entity cache if it is enabled.
void	cacheResult(java.util.List<LayoutSet> layoutSets) Caches the layout sets in the entity cache if it is enabled.
int	countAll() Returns the number of layout sets.
int	countByG_P(long groupId, boolean privateLayout) Returns the number of layout sets where groupId = ? and privateLayout = ?.
int	countByGroupId(long groupId) Returns the number of layout sets where groupId = ?.
int	countByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid) Returns the number of layout sets where layoutSetPrototypeUuid = ?.
LayoutSet	create(long layoutSetId) Creates a new layout set with the primary key.
LayoutSet	fetchByG_P(long groupId, boolean privateLayout) Returns the layout set where groupId = ? and privateLayout = ? or returns null if it could not be found.
LayoutSet	fetchByG_P(long groupId, boolean privateLayout, boolean retrieveFromCache) Returns the layout set where groupId = ? and privateLayout = ? or returns null if it could not be found, optionally using the finder cache.
LayoutSet	fetchByGroupId_First(long groupId, OrderByComparator orderByComparator) Returns the first layout set in the ordered set where groupId = ?.
LayoutSet	fetchByGroupId_Last(long groupId, OrderByComparator orderByComparator) Returns the last layout set in the ordered set where groupId = ?.
LayoutSet	fetchByLayoutSetPrototypeUuid_First(java.lang.String layoutSetPrototypeUuid, OrderByComparator orderByComparator) Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?.
LayoutSet	fetchByLayoutSetPrototypeUuid_Last(java.lang.String layoutSetPrototypeUuid, OrderByComparator orderByComparator) Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?.
LayoutSet	fetchByPrimaryKey(long layoutSetId) Returns the layout set with the primary key or returns null if it could not be found.
java.util.List<LayoutSet>	findAll() Returns all the layout sets.
java.util.List<LayoutSet>	findAll(int start, int end) Returns a range of all the layout sets.
java.util.List<LayoutSet>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the layout sets.
LayoutSet	findByG_P(long groupId, boolean privateLayout) Returns the layout set where groupId = ? and privateLayout = ? or throws a NoSuchLayoutSetException if it could not be found.
LayoutSet	findByGroupId_First(long groupId, OrderByComparator orderByComparator) Returns the first layout set in the ordered set where groupId = ?.
LayoutSet	findByGroupId_Last(long groupId, OrderByComparator orderByComparator) Returns the last layout set in the ordered set where groupId = ?.
LayoutSet[]	findByGroupId_PrevAndNext(long layoutSetId, long groupId, OrderByComparator orderByComparator) Returns the layout sets before and after the current layout set in the ordered set where groupId = ?.
java.util.List<LayoutSet>	findByGroupId(long groupId) Returns all the layout sets where groupId = ?.
java.util.List<LayoutSet>	findByGroupId(long groupId, int start, int end) Returns a range of all the layout sets where groupId = ?.
java.util.List<LayoutSet>	findByGroupId(long groupId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the layout sets where groupId = ?.
LayoutSet	findByLayoutSetPrototypeUuid_First(java.lang.String layoutSetPrototypeUuid, OrderByComparator orderByComparator) Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?.
LayoutSet	findByLayoutSetPrototypeUuid_Last(java.lang.String layoutSetPrototypeUuid, OrderByComparator orderByComparator) Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?.
LayoutSet[]	findByLayoutSetPrototypeUuid_PrevAndNext(long layoutSetId, java.lang.String layoutSetPrototypeUuid, OrderByComparator orderByComparator) Returns the layout sets before and after the current layout set in the ordered set where layoutSetPrototypeUuid = ?.
java.util.List<LayoutSet>	findByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid) Returns all the layout sets where layoutSetPrototypeUuid = ?.
java.util.List<LayoutSet>	findByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid, int start, int end) Returns a range of all the layout sets where layoutSetPrototypeUuid = ?.
java.util.List<LayoutSet>	findByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the layout sets where layoutSetPrototypeUuid = ?.
LayoutSet	findByPrimaryKey(long layoutSetId) Returns the layout set with the primary key or throws a NoSuchLayoutSetException if it could not be found.
LayoutSet	remove(long layoutSetId) Removes the layout set with the primary key from the database.
void	removeAll() Removes all the layout sets from the database.
LayoutSet	removeByG_P(long groupId, boolean privateLayout) Removes the layout set where groupId = ? and privateLayout = ? from the database.
void	removeByGroupId(long groupId) Removes all the layout sets where groupId = ? from the database.
void	removeByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid) Removes all the layout sets where layoutSetPrototypeUuid = ? from the database.
LayoutSet	updateImpl(LayoutSet layoutSet)

Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence

clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update, update, update

Method Detail

findByGroupId

java.util.List<LayoutSet> findByGroupId(long groupId)
                                        throws SystemException

Returns all the layout sets where groupId = ?.

Parameters:

groupId - the group ID

Returns:

the matching layout sets

Throws:

SystemException - if a system exception occurred

findByGroupId

java.util.List<LayoutSet> findByGroupId(long groupId,
                                      int start,
                                      int end)
                                        throws 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 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 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.

Parameters:

groupId - the group ID

start - the lower bound of the range of layout sets

end - the upper bound of the range of layout sets (not inclusive)

Returns:

the range of matching layout sets

Throws:

SystemException - if a system exception occurred

findByGroupId

java.util.List<LayoutSet> findByGroupId(long groupId,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                                        throws 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 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 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.

Parameters:

groupId - the group ID

start - the lower bound of the range of layout sets

end - the upper bound of the range of layout sets (not inclusive)

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

Returns:

the ordered range of matching layout sets

Throws:

SystemException - if a system exception occurred

findByGroupId_First

LayoutSet findByGroupId_First(long groupId,
                            OrderByComparator orderByComparator)
                              throws NoSuchLayoutSetException,
                                     SystemException

Returns the first layout set in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

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

Returns:

the first matching layout set

Throws:

NoSuchLayoutSetException - if a matching layout set could not be found

SystemException - if a system exception occurred

fetchByGroupId_First

LayoutSet fetchByGroupId_First(long groupId,
                             OrderByComparator orderByComparator)
                               throws SystemException

Returns the first layout set in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

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

Returns:

the first matching layout set, or null if a matching layout set could not be found

Throws:

SystemException - if a system exception occurred

findByGroupId_Last

LayoutSet findByGroupId_Last(long groupId,
                           OrderByComparator orderByComparator)
                             throws NoSuchLayoutSetException,
                                    SystemException

Returns the last layout set in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

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

Returns:

the last matching layout set

Throws:

NoSuchLayoutSetException - if a matching layout set could not be found

SystemException - if a system exception occurred

fetchByGroupId_Last

LayoutSet fetchByGroupId_Last(long groupId,
                            OrderByComparator orderByComparator)
                              throws SystemException

Returns the last layout set in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

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

Returns:

the last matching layout set, or null if a matching layout set could not be found

Throws:

SystemException - if a system exception occurred

findByGroupId_PrevAndNext

LayoutSet[] findByGroupId_PrevAndNext(long layoutSetId,
                                    long groupId,
                                    OrderByComparator orderByComparator)
                                      throws NoSuchLayoutSetException,
                                             SystemException

Returns the layout sets before and after the current layout set in the ordered set where groupId = ?.

Parameters:

layoutSetId - the primary key of the current layout set

groupId - the group ID

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

Returns:

the previous, current, and next layout set

Throws:

NoSuchLayoutSetException - if a layout set with the primary key could not be found

SystemException - if a system exception occurred

removeByGroupId

void removeByGroupId(long groupId)
                     throws SystemException

Removes all the layout sets where groupId = ? from the database.

Parameters:

groupId - the group ID

Throws:

SystemException - if a system exception occurred

countByGroupId

int countByGroupId(long groupId)
                   throws SystemException

Returns the number of layout sets where groupId = ?.

Parameters:

groupId - the group ID

Returns:

the number of matching layout sets

Throws:

SystemException - if a system exception occurred

findByLayoutSetPrototypeUuid

java.util.List<LayoutSet> findByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid)
                                                       throws SystemException

Returns all the layout sets where layoutSetPrototypeUuid = ?.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

Returns:

the matching layout sets

Throws:

SystemException - if a system exception occurred

findByLayoutSetPrototypeUuid

java.util.List<LayoutSet> findByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid,
                                                     int start,
                                                     int end)
                                                       throws 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 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 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.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

start - the lower bound of the range of layout sets

end - the upper bound of the range of layout sets (not inclusive)

Returns:

the range of matching layout sets

Throws:

SystemException - if a system exception occurred

findByLayoutSetPrototypeUuid

java.util.List<LayoutSet> findByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid,
                                                     int start,
                                                     int end,
                                                     OrderByComparator orderByComparator)
                                                       throws 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 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 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.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

start - the lower bound of the range of layout sets

end - the upper bound of the range of layout sets (not inclusive)

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

Returns:

the ordered range of matching layout sets

Throws:

SystemException - if a system exception occurred

findByLayoutSetPrototypeUuid_First

LayoutSet findByLayoutSetPrototypeUuid_First(java.lang.String layoutSetPrototypeUuid,
                                           OrderByComparator orderByComparator)
                                             throws NoSuchLayoutSetException,
                                                    SystemException

Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

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

Returns:

the first matching layout set

Throws:

NoSuchLayoutSetException - if a matching layout set could not be found

SystemException - if a system exception occurred

fetchByLayoutSetPrototypeUuid_First

LayoutSet fetchByLayoutSetPrototypeUuid_First(java.lang.String layoutSetPrototypeUuid,
                                            OrderByComparator orderByComparator)
                                              throws SystemException

Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

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

Returns:

the first matching layout set, or null if a matching layout set could not be found

Throws:

SystemException - if a system exception occurred

findByLayoutSetPrototypeUuid_Last

LayoutSet findByLayoutSetPrototypeUuid_Last(java.lang.String layoutSetPrototypeUuid,
                                          OrderByComparator orderByComparator)
                                            throws NoSuchLayoutSetException,
                                                   SystemException

Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

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

Returns:

the last matching layout set

Throws:

NoSuchLayoutSetException - if a matching layout set could not be found

SystemException - if a system exception occurred

fetchByLayoutSetPrototypeUuid_Last

LayoutSet fetchByLayoutSetPrototypeUuid_Last(java.lang.String layoutSetPrototypeUuid,
                                           OrderByComparator orderByComparator)
                                             throws SystemException

Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

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

Returns:

the last matching layout set, or null if a matching layout set could not be found

Throws:

SystemException - if a system exception occurred

findByLayoutSetPrototypeUuid_PrevAndNext

LayoutSet[] findByLayoutSetPrototypeUuid_PrevAndNext(long layoutSetId,
                                                   java.lang.String layoutSetPrototypeUuid,
                                                   OrderByComparator orderByComparator)
                                                     throws NoSuchLayoutSetException,
                                                            SystemException

Returns the layout sets before and after the current layout set in the ordered set where layoutSetPrototypeUuid = ?.

Parameters:

layoutSetId - the primary key of the current layout set

layoutSetPrototypeUuid - the layout set prototype uuid

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

Returns:

the previous, current, and next layout set

Throws:

NoSuchLayoutSetException - if a layout set with the primary key could not be found

SystemException - if a system exception occurred

removeByLayoutSetPrototypeUuid

void removeByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid)
                                    throws SystemException

Removes all the layout sets where layoutSetPrototypeUuid = ? from the database.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

Throws:

SystemException - if a system exception occurred

countByLayoutSetPrototypeUuid

int countByLayoutSetPrototypeUuid(java.lang.String layoutSetPrototypeUuid)
                                  throws SystemException

Returns the number of layout sets where layoutSetPrototypeUuid = ?.

Parameters:

layoutSetPrototypeUuid - the layout set prototype uuid

Returns:

the number of matching layout sets

Throws:

SystemException - if a system exception occurred

findByG_P

LayoutSet findByG_P(long groupId,
                  boolean privateLayout)
                    throws NoSuchLayoutSetException,
                           SystemException

Returns the layout set where groupId = ? and privateLayout = ? or throws a NoSuchLayoutSetException if it could not be found.

Parameters:

groupId - the group ID

privateLayout - the private layout

Returns:

the matching layout set

Throws:

NoSuchLayoutSetException - if a matching layout set could not be found

SystemException - if a system exception occurred

fetchByG_P

LayoutSet fetchByG_P(long groupId,
                   boolean privateLayout)
                     throws SystemException

Returns the layout set where groupId = ? and privateLayout = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

groupId - the group ID

privateLayout - the private layout

Returns:

the matching layout set, or null if a matching layout set could not be found

Throws:

SystemException - if a system exception occurred

fetchByG_P

LayoutSet fetchByG_P(long groupId,
                   boolean privateLayout,
                   boolean retrieveFromCache)
                     throws SystemException

Returns the layout set where groupId = ? and privateLayout = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

groupId - the group ID

privateLayout - the private layout

retrieveFromCache - whether to use the finder cache

Returns:

the matching layout set, or null if a matching layout set could not be found

Throws:

SystemException - if a system exception occurred

removeByG_P

LayoutSet removeByG_P(long groupId,
                    boolean privateLayout)
                      throws NoSuchLayoutSetException,
                             SystemException

Removes the layout set where groupId = ? and privateLayout = ? from the database.

Parameters:

groupId - the group ID

privateLayout - the private layout

Returns:

the layout set that was removed

Throws:

SystemException - if a system exception occurred

NoSuchLayoutSetException

countByG_P

int countByG_P(long groupId,
             boolean privateLayout)
               throws SystemException

Returns the number of layout sets where groupId = ? and privateLayout = ?.

Parameters:

groupId - the group ID

privateLayout - the private layout

Returns:

the number of matching layout sets

Throws:

SystemException - if a system exception occurred

cacheResult

void cacheResult(LayoutSet layoutSet)

Caches the layout set in the entity cache if it is enabled.

Parameters:

layoutSet - the layout set

cacheResult

void cacheResult(java.util.List<LayoutSet> layoutSets)

Caches the layout sets in the entity cache if it is enabled.

Parameters:

layoutSets - the layout sets

create

LayoutSet create(long layoutSetId)

Creates a new layout set with the primary key. Does not add the layout set to the database.

Parameters:

layoutSetId - the primary key for the new layout set

Returns:

the new layout set

remove

LayoutSet remove(long layoutSetId)
                 throws NoSuchLayoutSetException,
                        SystemException

Removes the layout set with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

layoutSetId - the primary key of the layout set

Returns:

the layout set that was removed

Throws:

NoSuchLayoutSetException - if a layout set with the primary key could not be found

SystemException - if a system exception occurred

updateImpl

LayoutSet updateImpl(LayoutSet layoutSet)
                     throws SystemException

Throws:

SystemException

findByPrimaryKey

LayoutSet findByPrimaryKey(long layoutSetId)
                           throws NoSuchLayoutSetException,
                                  SystemException

Returns the layout set with the primary key or throws a NoSuchLayoutSetException if it could not be found.

Parameters:

layoutSetId - the primary key of the layout set

Returns:

the layout set

Throws:

NoSuchLayoutSetException - if a layout set with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

LayoutSet fetchByPrimaryKey(long layoutSetId)
                            throws SystemException

Returns the layout set with the primary key or returns null if it could not be found.

Parameters:

layoutSetId - the primary key of the layout set

Returns:

the layout set, or null if a layout set with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findAll

java.util.List<LayoutSet> findAll()
                                  throws SystemException

Returns all the layout sets.

Returns:

the layout sets

Throws:

SystemException - if a system exception occurred

findAll

java.util.List<LayoutSet> findAll(int start,
                                int end)
                                  throws 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 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 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.

Parameters:

start - the lower bound of the range of layout sets

end - the upper bound of the range of layout sets (not inclusive)

Returns:

the range of layout sets

Throws:

SystemException - if a system exception occurred

findAll

java.util.List<LayoutSet> findAll(int start,
                                int end,
                                OrderByComparator orderByComparator)
                                  throws 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 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 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.

Parameters:

start - the lower bound of the range of layout sets

end - the upper bound of the range of layout sets (not inclusive)

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

Returns:

the ordered range of layout sets

Throws:

SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException

Removes all the layout sets from the database.

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Returns the number of layout sets.

Returns:

the number of layout sets

Throws:

SystemException - if a system exception occurred