com.liferay.portal.kernel.service

Class ClassNameLocalServiceUtil

Object

com.liferay.portal.kernel.service.ClassNameLocalServiceUtil

@ProviderType
public class ClassNameLocalServiceUtil
extends Object

Provides the local service utility for ClassName. This utility wraps ClassNameLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

ClassNameLocalService, ClassNameLocalServiceBaseImpl, ClassNameLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ClassNameLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ClassName	addClassName(ClassName className) Adds the class name to the database.
static ClassName	addClassName(String value)
static void	checkClassNames()
static ClassName	createClassName(long classNameId) Creates a new class name with the primary key.
static ClassName	deleteClassName(ClassName className) Deletes the class name from the database.
static ClassName	deleteClassName(long classNameId) Deletes the class name with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static ClassName	fetchByClassNameId(long classNameId)
static ClassName	fetchClassName(long classNameId)
static ClassName	fetchClassName(String value)
static ActionableDynamicQuery	getActionableDynamicQuery()
static ClassName	getClassName(long classNameId) Returns the class name with the primary key.
static ClassName	getClassName(String value)
static long	getClassNameId(Class<?> clazz)
static long	getClassNameId(String value)
static List<ClassName>	getClassNames(int start, int end) Returns a range of all the class names.
static int	getClassNamesCount() Returns the number of class names.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static String	getRegistryName()
static ClassNameLocalService	getService()
static void	invalidate()
static ClassName	updateClassName(ClassName className) Updates the class name in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassNameLocalServiceUtil

public ClassNameLocalServiceUtil()

Method Detail

addClassName

public static ClassName addClassName(ClassName className)

Adds the class name to the database. Also notifies the appropriate model listeners.

Parameters:

className - the class name

Returns:

the class name that was added

addClassName

public static ClassName addClassName(String value)

checkClassNames

public static void checkClassNames()

createClassName

public static ClassName createClassName(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

deleteClassName

public static ClassName deleteClassName(ClassName className)

Deletes the class name from the database. Also notifies the appropriate model listeners.

Parameters:

className - the class name

Returns:

the class name that was removed

deleteClassName

public static ClassName deleteClassName(long classNameId)
                                 throws PortalException

Deletes 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:

PortalException - if a class name with the primary key could not be found

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)

Performs a dynamic query on the database and returns a range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchByClassNameId

public static ClassName fetchByClassNameId(long classNameId)

fetchClassName

public static ClassName fetchClassName(long classNameId)

fetchClassName

public static ClassName fetchClassName(String value)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getClassName

public static ClassName getClassName(long classNameId)
                              throws PortalException

Returns the class name with the primary key.

Parameters:

classNameId - the primary key of the class name

Returns:

the class name

Throws:

PortalException - if a class name with the primary key could not be found

getClassName

public static ClassName getClassName(String value)

getClassNameId

public static long getClassNameId(Class<?> clazz)

getClassNameId

public static long getClassNameId(String value)

getClassNames

public static List<ClassName> getClassNames(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

getClassNamesCount

public static int getClassNamesCount()

Returns the number of class names.

Returns:

the number of class names

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getRegistryName

public static String getRegistryName()

invalidate

public static void invalidate()

updateClassName

public static ClassName updateClassName(ClassName className)

Updates the class name in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

className - the class name

Returns:

the class name that was updated

getService

public static ClassNameLocalService getService()