@ProviderType
public class ListTypeLocalServiceUtil
extends Object
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.ListTypeLocalService
,
ListTypeLocalServiceBaseImpl
,
ListTypeLocalServiceImpl
Constructor and Description |
---|
ListTypeLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static ListType |
addListType(ListType listType)
Adds the list type to the database.
|
static ListType |
addListType(String name,
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> 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 ListType |
fetchListType(long listTypeId) |
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static ListType |
getListType(long listTypeId)
Returns the list type with the primary key.
|
static ListType |
getListType(String name,
String type) |
static List<ListType> |
getListTypes(int start,
int end)
Returns a range of all the list types.
|
static List<ListType> |
getListTypes(String type) |
static int |
getListTypesCount()
Returns the number of list types.
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PersistedModel |
getPersistedModel(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,
String type) |
static void |
validate(long listTypeId,
String type) |
public static ListType addListType(ListType listType)
listType
- the list typepublic static ListType addListType(String name, String type)
public static ListType createListType(long listTypeId)
listTypeId
- the primary key for the new list typepublic static ListType deleteListType(ListType listType)
listType
- the list typepublic static ListType deleteListType(long listTypeId) throws PortalException
listTypeId
- the primary key of the list typePortalException
- if a list type with the primary key could not be foundpublic static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static ListType fetchListType(long listTypeId)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static ListType getListType(long listTypeId) throws PortalException
listTypeId
- the primary key of the list typePortalException
- if a list type with the primary key could not be foundpublic static ListType getListType(String name, String type)
public static List<ListType> getListTypes(int start, int end)
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.
start
- the lower bound of the range of list typesend
- the upper bound of the range of list types (not inclusive)public static List<ListType> getListTypes(String type)
public static int getListTypesCount()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static ListType updateListType(ListType listType)
listType
- the list typepublic static void validate(long listTypeId, long classNameId, String type) throws PortalException
PortalException
public static void validate(long listTypeId, String type) throws PortalException
PortalException
public static ListTypeLocalService getService()