com.liferay.portal.kernel.service

Class ListTypeLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.ListTypeLocalServiceUtil

@ProviderType
public class ListTypeLocalServiceUtil
extends java.lang.Object

Provides the local service utility for ListType. This utility wraps ListTypeLocalServiceImpl 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:

ListTypeLocalService, ListTypeLocalServiceBaseImpl, ListTypeLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
ListTypeLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ListType	addListType(ListType listType) Adds the list type to the database.
static ListType	addListType(java.lang.String name, java.lang.String type)
static ListType	createListType(long listTypeId) Creates a new list type with the primary key.
static ListType	deleteListType(ListType listType) Deletes the list type from the database.
static ListType	deleteListType(long listTypeId) Deletes the list type with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.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> java.util.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 ListType	fetchListType(long listTypeId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static ListType	getListType(long listTypeId) Returns the list type with the primary key.
static java.util.List<ListType>	getListTypes(int start, int end) Returns a range of all the list types.
static java.util.List<ListType>	getListTypes(java.lang.String type)
static int	getListTypesCount() Returns the number of list types.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static ListTypeLocalService	getService()
static ListType	updateListType(ListType listType) Updates the list type in the database or adds it if it does not yet exist.
static void	validate(long listTypeId, long classNameId, java.lang.String type)
static void	validate(long listTypeId, java.lang.String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListTypeLocalServiceUtil

public ListTypeLocalServiceUtil()

Method Detail

addListType

public static ListType addListType(ListType listType)

Adds the list type to the database. Also notifies the appropriate model listeners.

Parameters:

listType - the list type

Returns:

the list type that was added

addListType

public static ListType addListType(java.lang.String name,
                                   java.lang.String type)

createListType

public static ListType createListType(long listTypeId)

Creates a new list type with the primary key. Does not add the list type to the database.

Parameters:

listTypeId - the primary key for the new list type

Returns:

the new list type

deleteListType

public static ListType deleteListType(ListType listType)

Deletes the list type from the database. Also notifies the appropriate model listeners.

Parameters:

listType - the list type

Returns:

the list type that was removed

deleteListType

public static ListType deleteListType(long listTypeId)
                               throws PortalException

Deletes the list type with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

listTypeId - the primary key of the list type

Returns:

the list type that was removed

Throws:

PortalException - if a list type 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> java.util.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> java.util.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 ListTypeModelImpl. 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> java.util.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 ListTypeModelImpl. 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

fetchListType

public static ListType fetchListType(long listTypeId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getListType

public static ListType getListType(long listTypeId)
                            throws PortalException

Returns the list type with the primary key.

Parameters:

listTypeId - the primary key of the list type

Returns:

the list type

Throws:

PortalException - if a list type with the primary key could not be found

getListTypes

public static java.util.List<ListType> getListTypes(int start,
                                                    int end)

Returns a range of all the list types.

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 ListTypeModelImpl. 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 list types

end - the upper bound of the range of list types (not inclusive)

Returns:

the range of list types

getListTypes

public static java.util.List<ListType> getListTypes(java.lang.String type)

getListTypesCount

public static int getListTypesCount()

Returns the number of list types.

Returns:

the number of list types

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateListType

public static ListType updateListType(ListType listType)

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

Parameters:

listType - the list type

Returns:

the list type that was updated

validate

public static void validate(long listTypeId,
                            long classNameId,
                            java.lang.String type)
                     throws PortalException

Throws:

PortalException

validate

public static void validate(long listTypeId,
                            java.lang.String type)
                     throws PortalException

Throws:

PortalException

getService

public static ListTypeLocalService getService()