Class ClassNameUtil
com.liferay.portal.service.persistence.impl.ClassNamePersistenceImpl
and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.
Caching information and settings can be found in portal.properties
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
cacheResult
(ClassName className) Caches the class name in the entity cache if it is enabled.static void
cacheResult
(List<ClassName> classNames) Caches the class names in the entity cache if it is enabled.static void
static void
clearCache
(ClassName className) static int
countAll()
Returns the number of class names.static int
countByValue
(String value) Returns the number of class names where value = ?.static long
countWithDynamicQuery
(DynamicQuery dynamicQuery) static ClassName
create
(long classNameId) Creates a new class name with the primary key.static ClassName
fetchByPrimaryKey
(long classNameId) Returns the class name with the primary key or returnsnull
if it could not be found.static Map<Serializable,
ClassName> fetchByPrimaryKeys
(Set<Serializable> primaryKeys) static ClassName
fetchByValue
(String value) Returns the class name where value = ? or returnsnull
if it could not be found.static ClassName
fetchByValue
(String value, boolean useFinderCache) Returns the class name where value = ? or returnsnull
if it could not be found, optionally using the finder cache.findAll()
Returns all the class names.findAll
(int start, int end) Returns a range of all the class names.findAll
(int start, int end, OrderByComparator<ClassName> orderByComparator) Returns an ordered range of all the class names.findAll
(int start, int end, OrderByComparator<ClassName> orderByComparator, boolean useFinderCache) Returns an ordered range of all the class names.static ClassName
findByPrimaryKey
(long classNameId) Returns the class name with the primary key or throws aNoSuchClassNameException
if it could not be found.static ClassName
findByValue
(String value) Returns the class name where value = ? or throws aNoSuchClassNameException
if it could not be found.findWithDynamicQuery
(DynamicQuery dynamicQuery) findWithDynamicQuery
(DynamicQuery dynamicQuery, int start, int end) findWithDynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<ClassName> orderByComparator) static ClassNamePersistence
static ClassName
remove
(long classNameId) Removes the class name with the primary key from the database.static void
Removes all the class names from the database.static ClassName
removeByValue
(String value) Removes the class name where value = ? from the database.static void
setPersistence
(ClassNamePersistence persistence) static ClassName
static ClassName
update
(ClassName className, ServiceContext serviceContext) static ClassName
updateImpl
(ClassName className)
-
Constructor Details
-
ClassNameUtil
public ClassNameUtil()
-
-
Method Details
-
clearCache
public static void clearCache()- See Also:
-
clearCache
-
countWithDynamicQuery
-
fetchByPrimaryKeys
- See Also:
-
findWithDynamicQuery
-
findWithDynamicQuery
-
findWithDynamicQuery
public static List<ClassName> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<ClassName> orderByComparator) -
update
-
update
-
findByValue
Returns the class name where value = ? or throws aNoSuchClassNameException
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 foundNoSuchClassNameException
-
fetchByValue
Returns the class name where value = ? or returnsnull
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
Returns the class name where value = ? or returnsnull
if it could not be found, optionally using the finder cache.- Parameters:
value
- the valueuseFinderCache
- whether to use the finder cache- Returns:
- the matching class name, or
null
if a matching class name could not be found
-
removeByValue
Removes the class name where value = ? from the database.- Parameters:
value
- the value- Returns:
- the class name that was removed
- Throws:
NoSuchClassNameException
-
countByValue
Returns the number of class names where value = ?.- Parameters:
value
- the value- Returns:
- the number of matching class names
-
cacheResult
Caches the class name in the entity cache if it is enabled.- Parameters:
className
- the class name
-
cacheResult
Caches the class names in the entity cache if it is enabled.- Parameters:
classNames
- the class names
-
create
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
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 foundNoSuchClassNameException
-
updateImpl
-
findByPrimaryKey
Returns the class name with the primary key or throws aNoSuchClassNameException
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 foundNoSuchClassNameException
-
fetchByPrimaryKey
Returns the class name with the primary key or returnsnull
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
-
findAll
Returns all the class names.- Returns:
- the class names
-
findAll
Returns a range of all the class names.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromClassNameModelImpl
.- Parameters:
start
- the lower bound of the range of class namesend
- the upper bound of the range of class names (not inclusive)- Returns:
- the range of class names
-
findAll
public static 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromClassNameModelImpl
.- Parameters:
start
- the lower bound of the range of class namesend
- the upper bound of the range of class names (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of class names
-
findAll
public static List<ClassName> findAll(int start, int end, OrderByComparator<ClassName> orderByComparator, boolean useFinderCache) Returns an ordered range of all the class names.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromClassNameModelImpl
.- Parameters:
start
- the lower bound of the range of class namesend
- the upper bound of the range of class names (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)useFinderCache
- whether to use the finder cache- Returns:
- the ordered range of class names
-
removeAll
public static void removeAll()Removes all the class names from the database. -
countAll
public static int countAll()Returns the number of class names.- Returns:
- the number of class names
-
getPersistence
-
setPersistence
-