com.liferay.portal.service.persistence.ClassNameUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.ReferenceRegistry;
import com.liferay.portal.model.ClassName;
import com.liferay.portal.service.ServiceContext;
import java.util.List;
/**
* The persistence utility for the class name service. This utility wraps {@link 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 ClassNamePersistence
* @see ClassNamePersistenceImpl
* @generated
*/
@ProviderType
public class ClassNameUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Modify service.xml and rerun ServiceBuilder to regenerate this class.
*/
/**
* @see com.liferay.portal.service.persistence.BasePersistence#clearCache()
*/
public static void clearCache() {
getPersistence().clearCache();
}
/**
* @see com.liferay.portal.service.persistence.BasePersistence#clearCache(com.liferay.portal.model.BaseModel)
*/
public static void clearCache(ClassName className) {
getPersistence().clearCache(className);
}
/**
* @see com.liferay.portal.service.persistence.BasePersistence#countWithDynamicQuery(DynamicQuery)
*/
public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
throws SystemException {
return getPersistence().countWithDynamicQuery(dynamicQuery);
}
/**
* @see com.liferay.portal.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery)
*/
public static List findWithDynamicQuery(
DynamicQuery dynamicQuery) throws SystemException {
return getPersistence().findWithDynamicQuery(dynamicQuery);
}
/**
* @see com.liferay.portal.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery, int, int)
*/
public static List findWithDynamicQuery(
DynamicQuery dynamicQuery, int start, int end)
throws SystemException {
return getPersistence().findWithDynamicQuery(dynamicQuery, start, end);
}
/**
* @see com.liferay.portal.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)
*/
public static List findWithDynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator) throws SystemException {
return getPersistence()
.findWithDynamicQuery(dynamicQuery, start, end,
orderByComparator);
}
/**
* @see com.liferay.portal.service.persistence.BasePersistence#update(com.liferay.portal.model.BaseModel)
*/
public static ClassName update(ClassName className)
throws SystemException {
return getPersistence().update(className);
}
/**
* @see com.liferay.portal.service.persistence.BasePersistence#update(com.liferay.portal.model.BaseModel, ServiceContext)
*/
public static ClassName update(ClassName className,
ServiceContext serviceContext) throws SystemException {
return getPersistence().update(className, serviceContext);
}
/**
* Returns the class name where value = ? or throws a {@link com.liferay.portal.NoSuchClassNameException} if it could not be found.
*
* @param value the value
* @return the matching class name
* @throws com.liferay.portal.NoSuchClassNameException if a matching class name could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.ClassName findByValue(
java.lang.String value)
throws com.liferay.portal.NoSuchClassNameException,
com.liferay.portal.kernel.exception.SystemException {
return getPersistence().findByValue(value);
}
/**
* Returns the class name where value = ? or returns null if it could not be found. Uses the finder cache.
*
* @param value the value
* @return the matching class name, or null if a matching class name could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.ClassName fetchByValue(
java.lang.String value)
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().fetchByValue(value);
}
/**
* Returns the class name where value = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param value the value
* @param retrieveFromCache whether to use the finder cache
* @return the matching class name, or null if a matching class name could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.ClassName fetchByValue(
java.lang.String value, boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().fetchByValue(value, retrieveFromCache);
}
/**
* Removes the class name where value = ? from the database.
*
* @param value the value
* @return the class name that was removed
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.ClassName removeByValue(
java.lang.String value)
throws com.liferay.portal.NoSuchClassNameException,
com.liferay.portal.kernel.exception.SystemException {
return getPersistence().removeByValue(value);
}
/**
* Returns the number of class names where value = ?.
*
* @param value the value
* @return the number of matching class names
* @throws SystemException if a system exception occurred
*/
public static int countByValue(java.lang.String value)
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().countByValue(value);
}
/**
* Caches the class name in the entity cache if it is enabled.
*
* @param className the class name
*/
public static void cacheResult(com.liferay.portal.model.ClassName className) {
getPersistence().cacheResult(className);
}
/**
* Caches the class names in the entity cache if it is enabled.
*
* @param classNames the class names
*/
public static void cacheResult(
java.util.List classNames) {
getPersistence().cacheResult(classNames);
}
/**
* Creates a new class name with the primary key. Does not add the class name to the database.
*
* @param classNameId the primary key for the new class name
* @return the new class name
*/
public static com.liferay.portal.model.ClassName create(long classNameId) {
return getPersistence().create(classNameId);
}
/**
* Removes the class name with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param classNameId the primary key of the class name
* @return the class name that was removed
* @throws com.liferay.portal.NoSuchClassNameException if a class name with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.ClassName remove(long classNameId)
throws com.liferay.portal.NoSuchClassNameException,
com.liferay.portal.kernel.exception.SystemException {
return getPersistence().remove(classNameId);
}
public static com.liferay.portal.model.ClassName updateImpl(
com.liferay.portal.model.ClassName className)
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().updateImpl(className);
}
/**
* Returns the class name with the primary key or throws a {@link com.liferay.portal.NoSuchClassNameException} if it could not be found.
*
* @param classNameId the primary key of the class name
* @return the class name
* @throws com.liferay.portal.NoSuchClassNameException if a class name with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.ClassName findByPrimaryKey(
long classNameId)
throws com.liferay.portal.NoSuchClassNameException,
com.liferay.portal.kernel.exception.SystemException {
return getPersistence().findByPrimaryKey(classNameId);
}
/**
* Returns the class name with the primary key or returns null if it could not be found.
*
* @param classNameId the primary key of the class name
* @return the class name, or null if a class name with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.ClassName fetchByPrimaryKey(
long classNameId)
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().fetchByPrimaryKey(classNameId);
}
/**
* Returns all the class names.
*
* @return the class names
* @throws SystemException if a system exception occurred
*/
public static java.util.List findAll()
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().findAll();
}
/**
* 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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of class names
* @param end the upper bound of the range of class names (not inclusive)
* @return the range of class names
* @throws SystemException if a system exception occurred
*/
public static java.util.List findAll(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().findAll(start, end);
}
/**
* 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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of class names
* @param end the upper bound of the range of class names (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of class names
* @throws SystemException if a system exception occurred
*/
public static java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().findAll(start, end, orderByComparator);
}
/**
* Removes all the class names from the database.
*
* @throws SystemException if a system exception occurred
*/
public static void removeAll()
throws com.liferay.portal.kernel.exception.SystemException {
getPersistence().removeAll();
}
/**
* Returns the number of class names.
*
* @return the number of class names
* @throws SystemException if a system exception occurred
*/
public static int countAll()
throws com.liferay.portal.kernel.exception.SystemException {
return getPersistence().countAll();
}
public static ClassNamePersistence getPersistence() {
if (_persistence == null) {
_persistence = (ClassNamePersistence)PortalBeanLocatorUtil.locate(ClassNamePersistence.class.getName());
ReferenceRegistry.registerReference(ClassNameUtil.class,
"_persistence");
}
return _persistence;
}
/**
* @deprecated As of 6.2.0
*/
public void setPersistence(ClassNamePersistence persistence) {
}
private static ClassNamePersistence _persistence;
}