Liferay 6.2-ce-ga5

com.liferay.portal.service.persistence
Interface ClassNamePersistence

All Superinterfaces:
BasePersistence<ClassName>

@ProviderType
public interface ClassNamePersistence
extends BasePersistence<ClassName>

The persistence interface for the class name service.

Caching information and settings can be found in portal.properties

See Also:
ClassNamePersistenceImpl, ClassNameUtil

Method Summary
 void cacheResult(ClassName className)
          Caches the class name in the entity cache if it is enabled.
 void cacheResult(List<ClassName> classNames)
          Caches the class names in the entity cache if it is enabled.
 int countAll()
          Returns the number of class names.
 int countByValue(String value)
          Returns the number of class names where value = ?.
 ClassName create(long classNameId)
          Creates a new class name with the primary key.
 ClassName fetchByPrimaryKey(long classNameId)
          Returns the class name with the primary key or returns null if it could not be found.
 ClassName fetchByValue(String value)
          Returns the class name where value = ? or returns null if it could not be found.
 ClassName fetchByValue(String value, boolean retrieveFromCache)
          Returns the class name where value = ? or returns null if it could not be found, optionally using the finder cache.
 List<ClassName> findAll()
          Returns all the class names.
 List<ClassName> findAll(int start, int end)
          Returns a range of all the class names.
 List<ClassName> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the class names.
 ClassName findByPrimaryKey(long classNameId)
          Returns the class name with the primary key or throws a NoSuchClassNameException if it could not be found.
 ClassName findByValue(String value)
          Returns the class name where value = ? or throws a NoSuchClassNameException if it could not be found.
 ClassName remove(long classNameId)
          Removes the class name with the primary key from the database.
 void removeAll()
          Removes all the class names from the database.
 ClassName removeByValue(String value)
          Removes the class name where value = ? from the database.
 ClassName updateImpl(ClassName className)
           
 
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

findByValue

ClassName findByValue(String value)
                      throws NoSuchClassNameException,
                             SystemException
Returns the class name where value = ? or throws a NoSuchClassNameException if it could not be found.

Parameters:
value - the value
Returns:
the matching class name
Throws:
NoSuchClassNameException - if a matching class name could not be found
SystemException - if a system exception occurred

fetchByValue

ClassName fetchByValue(String value)
                       throws SystemException
Returns the class name where value = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
value - the value
Returns:
the matching class name, or null if a matching class name could not be found
Throws:
SystemException - if a system exception occurred

fetchByValue

ClassName fetchByValue(String value,
                       boolean retrieveFromCache)
                       throws SystemException
Returns the class name where value = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
value - the value
retrieveFromCache - whether to use the finder cache
Returns:
the matching class name, or null if a matching class name could not be found
Throws:
SystemException - if a system exception occurred

removeByValue

ClassName removeByValue(String value)
                        throws NoSuchClassNameException,
                               SystemException
Removes the class name where value = ? from the database.

Parameters:
value - the value
Returns:
the class name that was removed
Throws:
SystemException - if a system exception occurred
NoSuchClassNameException

countByValue

int countByValue(String value)
                 throws SystemException
Returns the number of class names where value = ?.

Parameters:
value - the value
Returns:
the number of matching class names
Throws:
SystemException - if a system exception occurred

cacheResult

void cacheResult(ClassName className)
Caches the class name in the entity cache if it is enabled.

Parameters:
className - the class name

cacheResult

void cacheResult(List<ClassName> classNames)
Caches the class names in the entity cache if it is enabled.

Parameters:
classNames - the class names

create

ClassName create(long classNameId)
Creates a new class name with the primary key. Does not add the class name to the database.

Parameters:
classNameId - the primary key for the new class name
Returns:
the new class name

remove

ClassName remove(long classNameId)
                 throws NoSuchClassNameException,
                        SystemException
Removes the class name with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
classNameId - the primary key of the class name
Returns:
the class name that was removed
Throws:
NoSuchClassNameException - if a class name with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

ClassName updateImpl(ClassName className)
                     throws SystemException
Throws:
SystemException

findByPrimaryKey

ClassName findByPrimaryKey(long classNameId)
                           throws NoSuchClassNameException,
                                  SystemException
Returns the class name with the primary key or throws a NoSuchClassNameException if it could not be found.

Parameters:
classNameId - the primary key of the class name
Returns:
the class name
Throws:
NoSuchClassNameException - if a class name with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

ClassName fetchByPrimaryKey(long classNameId)
                            throws SystemException
Returns the class name with the primary key or returns null if it could not be found.

Parameters:
classNameId - the primary key of the class name
Returns:
the class name, or null if a class name with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<ClassName> findAll()
                        throws SystemException
Returns all the class names.

Returns:
the class names
Throws:
SystemException - if a system exception occurred

findAll

List<ClassName> findAll(int start,
                        int end)
                        throws SystemException
Returns a range of all the class names.

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 ClassNameModelImpl. 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 class names
end - the upper bound of the range of class names (not inclusive)
Returns:
the range of class names
Throws:
SystemException - if a system exception occurred

findAll

List<ClassName> findAll(int start,
                        int end,
                        OrderByComparator orderByComparator)
                        throws SystemException
Returns an ordered range of all the class names.

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

removeAll

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

Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of class names.

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

Liferay 6.2-ce-ga5