Liferay 6.0-ee

com.liferay.portal.service.persistence
Interface ResourcePersistence

All Superinterfaces:
BasePersistence<Resource>
All Known Implementing Classes:
ResourcePersistenceImpl

public interface ResourcePersistence
extends BasePersistence<Resource>

The persistence interface for the resource service.

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

Caching information and settings can be found in portal.properties

See Also:
ResourcePersistenceImpl, ResourceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 void cacheResult(List<Resource> resources)
          Caches the resources in the entity cache if it is enabled.
 void cacheResult(Resource resource)
          Caches the resource in the entity cache if it is enabled.
 int countAll()
          Counts all the resources.
 int countByC_P(long codeId, String primKey)
          Counts all the resources where codeId = ? and primKey = ?.
 int countByCodeId(long codeId)
          Counts all the resources where codeId = ?.
 Resource create(long resourceId)
          Creates a new resource with the primary key.
 Resource fetchByC_P(long codeId, String primKey)
          Finds the resource where codeId = ? and primKey = ? or returns null if it could not be found.
 Resource fetchByC_P(long codeId, String primKey, boolean retrieveFromCache)
          Finds the resource where codeId = ? and primKey = ? or returns null if it could not be found, optionally using the finder cache.
 Resource fetchByPrimaryKey(long resourceId)
          Finds the resource with the primary key or returns null if it could not be found.
 List<Resource> findAll()
          Finds all the resources.
 List<Resource> findAll(int start, int end)
          Finds a range of all the resources.
 List<Resource> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the resources.
 Resource findByC_P(long codeId, String primKey)
          Finds the resource where codeId = ? and primKey = ? or throws a NoSuchResourceException if it could not be found.
 Resource findByCodeId_First(long codeId, OrderByComparator orderByComparator)
          Finds the first resource in the ordered set where codeId = ?.
 Resource findByCodeId_Last(long codeId, OrderByComparator orderByComparator)
          Finds the last resource in the ordered set where codeId = ?.
 Resource[] findByCodeId_PrevAndNext(long resourceId, long codeId, OrderByComparator orderByComparator)
          Finds the resources before and after the current resource in the ordered set where codeId = ?.
 List<Resource> findByCodeId(long codeId)
          Finds all the resources where codeId = ?.
 List<Resource> findByCodeId(long codeId, int start, int end)
          Finds a range of all the resources where codeId = ?.
 List<Resource> findByCodeId(long codeId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the resources where codeId = ?.
 Resource findByPrimaryKey(long resourceId)
          Finds the resource with the primary key or throws a NoSuchResourceException if it could not be found.
 Resource remove(long resourceId)
          Removes the resource with the primary key from the database.
 void removeAll()
          Removes all the resources from the database.
 void removeByC_P(long codeId, String primKey)
          Removes the resource where codeId = ? and primKey = ? from the database.
 void removeByCodeId(long codeId)
          Removes all the resources where codeId = ? from the database.
 Resource updateImpl(Resource resource, 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(Resource resource)
Caches the resource in the entity cache if it is enabled.

Parameters:
resource - the resource to cache

cacheResult

void cacheResult(List<Resource> resources)
Caches the resources in the entity cache if it is enabled.

Parameters:
resources - the resources to cache

create

Resource create(long resourceId)
Creates a new resource with the primary key. Does not add the resource to the database.

Parameters:
resourceId - the primary key for the new resource
Returns:
the new resource

remove

Resource remove(long resourceId)
                throws NoSuchResourceException,
                       SystemException
Removes the resource with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
resourceId - the primary key of the resource to remove
Returns:
the resource that was removed
Throws:
NoSuchResourceException - if a resource with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

Resource updateImpl(Resource resource,
                    boolean merge)
                    throws SystemException
Throws:
SystemException

findByPrimaryKey

Resource findByPrimaryKey(long resourceId)
                          throws NoSuchResourceException,
                                 SystemException
Finds the resource with the primary key or throws a NoSuchResourceException if it could not be found.

Parameters:
resourceId - the primary key of the resource to find
Returns:
the resource
Throws:
NoSuchResourceException - if a resource with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

Resource fetchByPrimaryKey(long resourceId)
                           throws SystemException
Finds the resource with the primary key or returns null if it could not be found.

Parameters:
resourceId - the primary key of the resource to find
Returns:
the resource, or null if a resource with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByCodeId

List<Resource> findByCodeId(long codeId)
                            throws SystemException
Finds all the resources where codeId = ?.

Parameters:
codeId - the code id to search with
Returns:
the matching resources
Throws:
SystemException - if a system exception occurred

findByCodeId

List<Resource> findByCodeId(long codeId,
                            int start,
                            int end)
                            throws SystemException
Finds a range of all the resources where codeId = ?.

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:
codeId - the code id to search with
start - the lower bound of the range of resources to return
end - the upper bound of the range of resources to return (not inclusive)
Returns:
the range of matching resources
Throws:
SystemException - if a system exception occurred

findByCodeId

List<Resource> findByCodeId(long codeId,
                            int start,
                            int end,
                            OrderByComparator orderByComparator)
                            throws SystemException
Finds an ordered range of all the resources where codeId = ?.

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

findByCodeId_First

Resource findByCodeId_First(long codeId,
                            OrderByComparator orderByComparator)
                            throws NoSuchResourceException,
                                   SystemException
Finds the first resource in the ordered set where codeId = ?.

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:
codeId - the code id to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching resource
Throws:
NoSuchResourceException - if a matching resource could not be found
SystemException - if a system exception occurred

findByCodeId_Last

Resource findByCodeId_Last(long codeId,
                           OrderByComparator orderByComparator)
                           throws NoSuchResourceException,
                                  SystemException
Finds the last resource in the ordered set where codeId = ?.

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:
codeId - the code id to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching resource
Throws:
NoSuchResourceException - if a matching resource could not be found
SystemException - if a system exception occurred

findByCodeId_PrevAndNext

Resource[] findByCodeId_PrevAndNext(long resourceId,
                                    long codeId,
                                    OrderByComparator orderByComparator)
                                    throws NoSuchResourceException,
                                           SystemException
Finds the resources before and after the current resource in the ordered set where codeId = ?.

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:
resourceId - the primary key of the current resource
codeId - the code id to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next resource
Throws:
NoSuchResourceException - if a resource with the primary key could not be found
SystemException - if a system exception occurred

findByC_P

Resource findByC_P(long codeId,
                   String primKey)
                   throws NoSuchResourceException,
                          SystemException
Finds the resource where codeId = ? and primKey = ? or throws a NoSuchResourceException if it could not be found.

Parameters:
codeId - the code id to search with
primKey - the prim key to search with
Returns:
the matching resource
Throws:
NoSuchResourceException - if a matching resource could not be found
SystemException - if a system exception occurred

fetchByC_P

Resource fetchByC_P(long codeId,
                    String primKey)
                    throws SystemException
Finds the resource where codeId = ? and primKey = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
codeId - the code id to search with
primKey - the prim key to search with
Returns:
the matching resource, or null if a matching resource could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_P

Resource fetchByC_P(long codeId,
                    String primKey,
                    boolean retrieveFromCache)
                    throws SystemException
Finds the resource where codeId = ? and primKey = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
codeId - the code id to search with
primKey - the prim key to search with
Returns:
the matching resource, or null if a matching resource could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<Resource> findAll()
                       throws SystemException
Finds all the resources.

Returns:
the resources
Throws:
SystemException - if a system exception occurred

findAll

List<Resource> findAll(int start,
                       int end)
                       throws SystemException
Finds a range of all the resources.

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 resources to return
end - the upper bound of the range of resources to return (not inclusive)
Returns:
the range of resources
Throws:
SystemException - if a system exception occurred

findAll

List<Resource> findAll(int start,
                       int end,
                       OrderByComparator orderByComparator)
                       throws SystemException
Finds an ordered range of all the resources.

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

removeByCodeId

void removeByCodeId(long codeId)
                    throws SystemException
Removes all the resources where codeId = ? from the database.

Parameters:
codeId - the code id to search with
Throws:
SystemException - if a system exception occurred

removeByC_P

void removeByC_P(long codeId,
                 String primKey)
                 throws NoSuchResourceException,
                        SystemException
Removes the resource where codeId = ? and primKey = ? from the database.

Parameters:
codeId - the code id to search with
primKey - the prim key to search with
Throws:
SystemException - if a system exception occurred
NoSuchResourceException

removeAll

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

Throws:
SystemException - if a system exception occurred

countByCodeId

int countByCodeId(long codeId)
                  throws SystemException
Counts all the resources where codeId = ?.

Parameters:
codeId - the code id to search with
Returns:
the number of matching resources
Throws:
SystemException - if a system exception occurred

countByC_P

int countByC_P(long codeId,
               String primKey)
               throws SystemException
Counts all the resources where codeId = ? and primKey = ?.

Parameters:
codeId - the code id to search with
primKey - the prim key to search with
Returns:
the number of matching resources
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the resources.

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

Liferay 6.0-ee