Class ListTypeDefinitionLocalServiceUtil
com.liferay.list.type.service.impl.ListTypeDefinitionLocalServiceImpl
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.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ListTypeDefinition
addListTypeDefinition
(ListTypeDefinition listTypeDefinition) Adds the list type definition to the database.static ListTypeDefinition
addListTypeDefinition
(String externalReferenceCode, long userId, boolean system) static ListTypeDefinition
addListTypeDefinition
(String externalReferenceCode, long userId, Map<Locale, String> nameMap, boolean system, List<ListTypeEntry> listTypeEntries) static ListTypeDefinition
createListTypeDefinition
(long listTypeDefinitionId) Creates a new list type definition with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static ListTypeDefinition
deleteListTypeDefinition
(long listTypeDefinitionId) Deletes the list type definition with the primary key from the database.static ListTypeDefinition
deleteListTypeDefinition
(ListTypeDefinition listTypeDefinition) Deletes the list type definition from the database.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.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
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static ListTypeDefinition
fetchListTypeDefinition
(long listTypeDefinitionId) static ListTypeDefinition
fetchListTypeDefinitionByExternalReferenceCode
(String externalReferenceCode, long companyId) static ListTypeDefinition
fetchListTypeDefinitionByUuidAndCompanyId
(String uuid, long companyId) Returns the list type definition with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static ListTypeDefinition
getListTypeDefinition
(long listTypeDefinitionId) Returns the list type definition with the primary key.static ListTypeDefinition
getListTypeDefinitionByExternalReferenceCode
(String externalReferenceCode, long companyId) static ListTypeDefinition
getListTypeDefinitionByUuidAndCompanyId
(String uuid, long companyId) Returns the list type definition with the matching UUID and company.static List<ListTypeDefinition>
getListTypeDefinitions
(int start, int end) Returns a range of all the list type definitions.static int
Returns the number of list type definitions.static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static ListTypeDefinition
updateListTypeDefinition
(ListTypeDefinition listTypeDefinition) Updates the list type definition in the database or adds it if it does not yet exist.static ListTypeDefinition
updateListTypeDefinition
(String externalReferenceCode, long listTypeDefinitionId, long userId, Map<Locale, String> nameMap, List<ListTypeEntry> listTypeEntries) static void
updateUserId
(long companyId, long oldUserId, long newUserId)
-
Constructor Details
-
ListTypeDefinitionLocalServiceUtil
public ListTypeDefinitionLocalServiceUtil()
-
-
Method Details
-
addListTypeDefinition
Adds the list type definition to the database. Also notifies the appropriate model listeners.Important: Inspect ListTypeDefinitionLocalServiceImpl 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:
listTypeDefinition
- the list type definition- Returns:
- the list type definition that was added
-
addListTypeDefinition
public static ListTypeDefinition addListTypeDefinition(String externalReferenceCode, long userId, boolean system) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addListTypeDefinition
public static ListTypeDefinition addListTypeDefinition(String externalReferenceCode, long userId, Map<Locale, String> nameMap, boolean system, List<ListTypeEntry> listTypeEntries) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createListTypeDefinition
Creates a new list type definition with the primary key. Does not add the list type definition to the database.- Parameters:
listTypeDefinitionId
- the primary key for the new list type definition- Returns:
- the new list type definition
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteListTypeDefinition
public static ListTypeDefinition deleteListTypeDefinition(ListTypeDefinition listTypeDefinition) throws com.liferay.portal.kernel.exception.PortalException Deletes the list type definition from the database. Also notifies the appropriate model listeners.Important: Inspect ListTypeDefinitionLocalServiceImpl 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:
listTypeDefinition
- the list type definition- Returns:
- the list type definition that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteListTypeDefinition
public static ListTypeDefinition deleteListTypeDefinition(long listTypeDefinitionId) throws com.liferay.portal.kernel.exception.PortalException Deletes the list type definition with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ListTypeDefinitionLocalServiceImpl 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:
listTypeDefinitionId
- the primary key of the list type definition- Returns:
- the list type definition that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a list type definition with the primary key could not be found
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.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
public static com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.list.type.model.impl.ListTypeDefinitionModelImpl
.- 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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.list.type.model.impl.ListTypeDefinitionModelImpl
.- 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
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) 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
-
fetchListTypeDefinition
-
fetchListTypeDefinitionByExternalReferenceCode
public static ListTypeDefinition fetchListTypeDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchListTypeDefinitionByUuidAndCompanyId
public static ListTypeDefinition fetchListTypeDefinitionByUuidAndCompanyId(String uuid, long companyId) Returns the list type definition with the matching UUID and company.- Parameters:
uuid
- the list type definition's UUIDcompanyId
- the primary key of the company- Returns:
- the matching list type definition, or
null
if a matching list type definition could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getListTypeDefinition
public static ListTypeDefinition getListTypeDefinition(long listTypeDefinitionId) throws com.liferay.portal.kernel.exception.PortalException Returns the list type definition with the primary key.- Parameters:
listTypeDefinitionId
- the primary key of the list type definition- Returns:
- the list type definition
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a list type definition with the primary key could not be found
-
getListTypeDefinitionByExternalReferenceCode
public static ListTypeDefinition getListTypeDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getListTypeDefinitionByUuidAndCompanyId
public static ListTypeDefinition getListTypeDefinitionByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the list type definition with the matching UUID and company.- Parameters:
uuid
- the list type definition's UUIDcompanyId
- the primary key of the company- Returns:
- the matching list type definition
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching list type definition could not be found
-
getListTypeDefinitions
Returns a range of all the list type definitions.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.list.type.model.impl.ListTypeDefinitionModelImpl
.- Parameters:
start
- the lower bound of the range of list type definitionsend
- the upper bound of the range of list type definitions (not inclusive)- Returns:
- the range of list type definitions
-
getListTypeDefinitionsCount
public static int getListTypeDefinitionsCount()Returns the number of list type definitions.- Returns:
- the number of list type definitions
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateListTypeDefinition
Updates the list type definition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ListTypeDefinitionLocalServiceImpl 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:
listTypeDefinition
- the list type definition- Returns:
- the list type definition that was updated
-
updateListTypeDefinition
public static ListTypeDefinition updateListTypeDefinition(String externalReferenceCode, long listTypeDefinitionId, long userId, Map<Locale, String> nameMap, List<ListTypeEntry> listTypeEntries) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateUserId
public static void updateUserId(long companyId, long oldUserId, long newUserId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-