Interface ListTypeDefinitionLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
ListTypeDefinitionLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface ListTypeDefinitionLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for ListTypeDefinition. 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:
  • Method Details

    • addListTypeDefinition

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

      @Indexable(type=REINDEX) ListTypeDefinition addListTypeDefinition(String externalReferenceCode, long userId, boolean system) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addListTypeDefinition

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

      @Transactional(enabled=false) ListTypeDefinition createListTypeDefinition(long listTypeDefinitionId)
      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

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteListTypeDefinition

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

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

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.list.type.model.impl.ListTypeDefinitionModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.list.type.model.impl.ListTypeDefinitionModelImpl.

      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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchListTypeDefinition

      @Transactional(propagation=SUPPORTS, readOnly=true) ListTypeDefinition fetchListTypeDefinition(long listTypeDefinitionId)
    • fetchListTypeDefinitionByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) ListTypeDefinition fetchListTypeDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchListTypeDefinitionByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ListTypeDefinition fetchListTypeDefinitionByUuidAndCompanyId(String uuid, long companyId)
      Returns the list type definition with the matching UUID and company.
      Parameters:
      uuid - the list type definition's UUID
      companyId - 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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getListTypeDefinition

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ListTypeDefinition getListTypeDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getListTypeDefinitionByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ListTypeDefinition> getListTypeDefinitions(int start, int end)
      Returns a range of all the list type definitions.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.list.type.model.impl.ListTypeDefinitionModelImpl.

      Parameters:
      start - the lower bound of the range of list type definitions
      end - the upper bound of the range of list type definitions (not inclusive)
      Returns:
      the range of list type definitions
    • getListTypeDefinitionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getListTypeDefinitionsCount()
      Returns the number of list type definitions.
      Returns:
      the number of list type definitions
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateListTypeDefinition

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

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

      void updateUserId(long companyId, long oldUserId, long newUserId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException