com.liferay.portal.kernel.service

Interface ListTypeLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ListTypeLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ListTypeLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for ListType. 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:

ListTypeLocalServiceUtil, ListTypeLocalServiceBaseImpl, ListTypeLocalServiceImpl

Generated:

Method Summary

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

Method Detail

addListType

@Indexable(type=REINDEX)
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

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

createListType

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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

<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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ListType fetchListType(long listTypeId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getListType

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ListType> getListTypes(java.lang.String type)

getListTypesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getListTypesCount()

Returns the number of list types.

Returns:

the number of list types

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateListType

@Indexable(type=REINDEX)
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

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

Throws:

PortalException

validate

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

Throws:

PortalException