Class ListTypeLocalServiceUtil
com.liferay.portal.service.impl.ListTypeLocalServiceImpl and
is an 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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ListTypeaddListType(long companyId, String name, String type) static ListTypeaddListType(ListType listType) Adds the list type to the database.static ListTypecreateListType(long listTypeId) Creates a new list type with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static ListTypedeleteListType(long listTypeId) Deletes the list type with the primary key from the database.static ListTypedeleteListType(ListType listType) Deletes the list type from the database.static voiddeleteListTypes(long companyId) static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <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 longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static ListTypefetchListType(long listTypeId) static ListTypefetchListTypeByUuidAndCompanyId(String uuid, long companyId) Returns the list type with the matching UUID and company.static ActionableDynamicQuerystatic ExportActionableDynamicQuerygetExportActionableDynamicQuery(PortletDataContext portletDataContext) static ListTypegetListType(long listTypeId) Returns the list type with the primary key.static ListTypegetListType(long companyId, String name, String type) static ListTypegetListTypeByUuidAndCompanyId(String uuid, long companyId) Returns the list type with the matching UUID and company.static longgetListTypeId(long companyId, String name, String type) getListTypes(int start, int end) Returns a range of all the list types.getListTypes(long companyId, String type) static intReturns the number of list types.static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static ListTypeLocalServicestatic voidsetService(ListTypeLocalService service) static ListTypeupdateListType(ListType listType) Updates the list type in the database or adds it if it does not yet exist.static voidstatic void
-
Constructor Details
-
ListTypeLocalServiceUtil
public ListTypeLocalServiceUtil()
-
-
Method Details
-
addListType
Adds the list type to the database. Also notifies the appropriate model listeners.Important: Inspect ListTypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
listType- the list type- Returns:
- the list type that was added
-
addListType
-
createListType
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
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteListType
Deletes the list type from the database. Also notifies the appropriate model listeners.Important: Inspect ListTypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
listType- the list type- Returns:
- the list type that was removed
-
deleteListType
Deletes the list type with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ListTypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
deleteListTypes
public static void deleteListTypes(long companyId) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ListTypeModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ListTypeModelImpl.- Parameters:
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 (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchListType
-
fetchListTypeByUuidAndCompanyId
Returns the list type with the matching UUID and company.- Parameters:
uuid- the list type's UUIDcompanyId- the primary key of the company- Returns:
- the matching list type, or
nullif a matching list type could not be found
-
getActionableDynamicQuery
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getListType
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
-
getListType
-
getListTypeByUuidAndCompanyId
public static ListType getListTypeByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the list type with the matching UUID and company.- Parameters:
uuid- the list type's UUIDcompanyId- the primary key of the company- Returns:
- the matching list type
- Throws:
PortalException- if a matching list type could not be found
-
getListTypeId
-
getListTypes
Returns a range of all the list types.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ListTypeModelImpl.- Parameters:
start- the lower bound of the range of list typesend- the upper bound of the range of list types (not inclusive)- Returns:
- the range of list types
-
getListTypes
-
getListTypesCount
public static int getListTypesCount()Returns the number of list types.- Returns:
- the number of list types
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
updateListType
Updates the list type in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ListTypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
listType- the list type- Returns:
- the list type that was updated
-
validate
- Throws:
PortalException
-
validate
- Throws:
PortalException
-
getService
-
setService
-