Liferay 6.0.5

com.liferay.portal.service.persistence
Interface LayoutSetPersistence

All Superinterfaces:
BasePersistence<LayoutSet>
All Known Implementing Classes:
LayoutSetPersistenceImpl

public interface LayoutSetPersistence
extends BasePersistence<LayoutSet>

The persistence interface for the layout set service.

Never modify or reference this interface directly. Always use LayoutSetUtil to access the layout set persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:
LayoutSetPersistenceImpl, LayoutSetUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 void cacheResult(LayoutSet layoutSet)
          Caches the layout set in the entity cache if it is enabled.
 void cacheResult(List<LayoutSet> layoutSets)
          Caches the layout sets in the entity cache if it is enabled.
 int countAll()
          Counts all the layout sets.
 int countByG_P(long groupId, boolean privateLayout)
          Counts all the layout sets where groupId = ? and privateLayout = ?.
 int countByGroupId(long groupId)
          Counts all the layout sets where groupId = ?.
 int countByVirtualHost(String virtualHost)
          Counts all the layout sets where virtualHost = ?.
 LayoutSet create(long layoutSetId)
          Creates a new layout set with the primary key.
 LayoutSet fetchByG_P(long groupId, boolean privateLayout)
          Finds 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)
          Finds the layout set where groupId = ? and privateLayout = ? or returns null if it could not be found, optionally using the finder cache.
 LayoutSet fetchByPrimaryKey(long layoutSetId)
          Finds the layout set with the primary key or returns null if it could not be found.
 LayoutSet fetchByVirtualHost(String virtualHost)
          Finds the layout set where virtualHost = ? or returns null if it could not be found.
 LayoutSet fetchByVirtualHost(String virtualHost, boolean retrieveFromCache)
          Finds the layout set where virtualHost = ? or returns null if it could not be found, optionally using the finder cache.
 List<LayoutSet> findAll()
          Finds all the layout sets.
 List<LayoutSet> findAll(int start, int end)
          Finds a range of all the layout sets.
 List<LayoutSet> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the layout sets.
 LayoutSet findByG_P(long groupId, boolean privateLayout)
          Finds the layout set where groupId = ? and privateLayout = ? or throws a NoSuchLayoutSetException if it could not be found.
 LayoutSet findByGroupId_First(long groupId, OrderByComparator orderByComparator)
          Finds the first layout set in the ordered set where groupId = ?.
 LayoutSet findByGroupId_Last(long groupId, OrderByComparator orderByComparator)
          Finds the last layout set in the ordered set where groupId = ?.
 LayoutSet[] findByGroupId_PrevAndNext(long layoutSetId, long groupId, OrderByComparator orderByComparator)
          Finds the layout sets before and after the current layout set in the ordered set where groupId = ?.
 List<LayoutSet> findByGroupId(long groupId)
          Finds all the layout sets where groupId = ?.
 List<LayoutSet> findByGroupId(long groupId, int start, int end)
          Finds a range of all the layout sets where groupId = ?.
 List<LayoutSet> findByGroupId(long groupId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the layout sets where groupId = ?.
 LayoutSet findByPrimaryKey(long layoutSetId)
          Finds the layout set with the primary key or throws a NoSuchLayoutSetException if it could not be found.
 LayoutSet findByVirtualHost(String virtualHost)
          Finds the layout set where virtualHost = ? 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.
 void 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 removeByVirtualHost(String virtualHost)
          Removes the layout set where virtualHost = ? from the database.
 LayoutSet updateImpl(LayoutSet layoutSet, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(LayoutSet layoutSet)
Caches the layout set in the entity cache if it is enabled.

Parameters:
layoutSet - the layout set to cache

cacheResult

void cacheResult(List<LayoutSet> layoutSets)
Caches the layout sets in the entity cache if it is enabled.

Parameters:
layoutSets - the layout sets to cache

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 to remove
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,
                     boolean merge)
                     throws SystemException
Throws:
SystemException

findByPrimaryKey

LayoutSet findByPrimaryKey(long layoutSetId)
                           throws NoSuchLayoutSetException,
                                  SystemException
Finds 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 to find
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
Finds 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 to find
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

findByGroupId

List<LayoutSet> findByGroupId(long groupId)
                              throws SystemException
Finds all the layout sets where groupId = ?.

Parameters:
groupId - the group id to search with
Returns:
the matching layout sets
Throws:
SystemException - if a system exception occurred

findByGroupId

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

Parameters:
groupId - the group id to search with
start - the lower bound of the range of layout sets to return
end - the upper bound of the range of layout sets to return (not inclusive)
Returns:
the range of matching layout sets
Throws:
SystemException - if a system exception occurred

findByGroupId

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

Parameters:
groupId - the group id to search with
start - the lower bound of the range of layout sets to return
end - the upper bound of the range of layout sets to return (not inclusive)
orderByComparator - the comparator to order the results by
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
Finds the first layout set in the ordered set 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.

Parameters:
groupId - the group id to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching layout set
Throws:
NoSuchLayoutSetException - if a matching layout set could not be found
SystemException - if a system exception occurred

findByGroupId_Last

LayoutSet findByGroupId_Last(long groupId,
                             OrderByComparator orderByComparator)
                             throws NoSuchLayoutSetException,
                                    SystemException
Finds the last layout set in the ordered set 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.

Parameters:
groupId - the group id to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching layout set
Throws:
NoSuchLayoutSetException - if a matching layout set could not be found
SystemException - if a system exception occurred

findByGroupId_PrevAndNext

LayoutSet[] findByGroupId_PrevAndNext(long layoutSetId,
                                      long groupId,
                                      OrderByComparator orderByComparator)
                                      throws NoSuchLayoutSetException,
                                             SystemException
Finds the layout sets before and after the current layout set in the ordered set 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.

Parameters:
layoutSetId - the primary key of the current layout set
groupId - the group id to search with
orderByComparator - the comparator to order the set by
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

findByVirtualHost

LayoutSet findByVirtualHost(String virtualHost)
                            throws NoSuchLayoutSetException,
                                   SystemException
Finds the layout set where virtualHost = ? or throws a NoSuchLayoutSetException if it could not be found.

Parameters:
virtualHost - the virtual host to search with
Returns:
the matching layout set
Throws:
NoSuchLayoutSetException - if a matching layout set could not be found
SystemException - if a system exception occurred

fetchByVirtualHost

LayoutSet fetchByVirtualHost(String virtualHost)
                             throws SystemException
Finds the layout set where virtualHost = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
virtualHost - the virtual host to search with
Returns:
the matching layout set, or null if a matching layout set could not be found
Throws:
SystemException - if a system exception occurred

fetchByVirtualHost

LayoutSet fetchByVirtualHost(String virtualHost,
                             boolean retrieveFromCache)
                             throws SystemException
Finds the layout set where virtualHost = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
virtualHost - the virtual host to search with
Returns:
the matching layout set, or null if a matching layout set could not be found
Throws:
SystemException - if a system exception occurred

findByG_P

LayoutSet findByG_P(long groupId,
                    boolean privateLayout)
                    throws NoSuchLayoutSetException,
                           SystemException
Finds the layout set where groupId = ? and privateLayout = ? or throws a NoSuchLayoutSetException if it could not be found.

Parameters:
groupId - the group id to search with
privateLayout - the private layout to search with
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
Finds 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 to search with
privateLayout - the private layout to search with
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
Finds 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 to search with
privateLayout - the private layout to search with
Returns:
the matching layout set, or null if a matching layout set could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<LayoutSet> findAll()
                        throws SystemException
Finds all the layout sets.

Returns:
the layout sets
Throws:
SystemException - if a system exception occurred

findAll

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

Parameters:
start - the lower bound of the range of layout sets to return
end - the upper bound of the range of layout sets to return (not inclusive)
Returns:
the range of layout sets
Throws:
SystemException - if a system exception occurred

findAll

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

Parameters:
start - the lower bound of the range of layout sets to return
end - the upper bound of the range of layout sets to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of layout sets
Throws:
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 to search with
Throws:
SystemException - if a system exception occurred

removeByVirtualHost

void removeByVirtualHost(String virtualHost)
                         throws NoSuchLayoutSetException,
                                SystemException
Removes the layout set where virtualHost = ? from the database.

Parameters:
virtualHost - the virtual host to search with
Throws:
SystemException - if a system exception occurred
NoSuchLayoutSetException

removeByG_P

void 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 to search with
privateLayout - the private layout to search with
Throws:
SystemException - if a system exception occurred
NoSuchLayoutSetException

removeAll

void removeAll()
               throws SystemException
Removes all the layout sets from the database.

Throws:
SystemException - if a system exception occurred

countByGroupId

int countByGroupId(long groupId)
                   throws SystemException
Counts all the layout sets where groupId = ?.

Parameters:
groupId - the group id to search with
Returns:
the number of matching layout sets
Throws:
SystemException - if a system exception occurred

countByVirtualHost

int countByVirtualHost(String virtualHost)
                       throws SystemException
Counts all the layout sets where virtualHost = ?.

Parameters:
virtualHost - the virtual host to search with
Returns:
the number of matching layout sets
Throws:
SystemException - if a system exception occurred

countByG_P

int countByG_P(long groupId,
               boolean privateLayout)
               throws SystemException
Counts all the layout sets where groupId = ? and privateLayout = ?.

Parameters:
groupId - the group id to search with
privateLayout - the private layout to search with
Returns:
the number of matching layout sets
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the layout sets.

Returns:
the number of layout sets
Throws:
SystemException - if a system exception occurred

Liferay 6.0.5