com.liferay.portal.kernel.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

Author:

Brian Wing Shun Chan

See Also:

ClassNamePersistenceImpl, ClassNameUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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.
Map<Serializable,ClassName>	fetchByPrimaryKeys(Set<Serializable> primaryKeys)
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<ClassName> orderByComparator) Returns an ordered range of all the class names.
List<ClassName>	findAll(int start, int end, OrderByComparator<ClassName> orderByComparator, boolean retrieveFromCache) 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.kernel.service.persistence.BasePersistence

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

Method Detail

findByValue

ClassName findByValue(String value)
               throws NoSuchClassNameException

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

fetchByValue

ClassName fetchByValue(String value)

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

fetchByValue

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.

Parameters:

value - the value

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the matching class name, or null if a matching class name could not be found

removeByValue

ClassName removeByValue(String value)
                 throws NoSuchClassNameException

Removes the class name where value = ? from the database.

Parameters:

value - the value

Returns:

the class name that was removed

Throws:

NoSuchClassNameException

countByValue

int countByValue(String value)

Returns the number of class names where value = ?.

Parameters:

value - the value

Returns:

the number of matching class names

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

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

updateImpl

ClassName updateImpl(ClassName className)

findByPrimaryKey

ClassName findByPrimaryKey(long classNameId)
                    throws NoSuchClassNameException

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

fetchByPrimaryKey

ClassName fetchByPrimaryKey(long classNameId)

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

fetchByPrimaryKeys

Map<Serializable,ClassName> fetchByPrimaryKeys(Set<Serializable> primaryKeys)

Specified by:

fetchByPrimaryKeys in interface BasePersistence<ClassName>

findAll

List<ClassName> findAll()

Returns all the class names.

Returns:

the class names

findAll

List<ClassName> findAll(int start,
                        int end)

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

findAll

List<ClassName> findAll(int start,
                        int end,
                        OrderByComparator<ClassName> orderByComparator)

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

findAll

List<ClassName> findAll(int start,
                        int end,
                        OrderByComparator<ClassName> orderByComparator,
                        boolean retrieveFromCache)

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)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of class names

removeAll

void removeAll()

Removes all the class names from the database.

countAll

int countAll()

Returns the number of class names.

Returns:

the number of class names