Interface ListTypeLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ListTypeLocalServiceWrapper

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:
{$generated.description}
  • Method Details

    • addListType

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

      ListType addListType(long companyId, String name, 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
    • createPersistedModel

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteListType

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

      @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.

      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

      void deleteListTypes(long companyId)
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • dslQuery

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

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

    • dynamicQuery

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

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

      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.portal.model.impl.ListTypeModelImpl.

      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(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 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.portal.model.impl.ListTypeModelImpl.

      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(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(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)
    • fetchListTypeByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ListType fetchListTypeByUuidAndCompanyId(String uuid, long companyId)
      Returns the list type with the matching UUID and company.
      Parameters:
      uuid - the list type's UUID
      companyId - the primary key of the company
      Returns:
      the matching list type, or null if a matching list type could not be found
    • getActionableDynamicQuery

    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
    • 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
    • getListType

      @Transactional(propagation=SUPPORTS, readOnly=true) ListType getListType(long companyId, String name, String type)
    • getListTypeByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ListType getListTypeByUuidAndCompanyId(String uuid, long companyId) throws PortalException
      Returns the list type with the matching UUID and company.
      Parameters:
      uuid - the list type's UUID
      companyId - the primary key of the company
      Returns:
      the matching list type
      Throws:
      PortalException - if a matching list type could not be found
    • getListTypeId

      @Transactional(propagation=SUPPORTS, readOnly=true) long getListTypeId(long companyId, String name, String type)
    • getListTypes

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 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.portal.model.impl.ListTypeModelImpl.

      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) List<ListType> getListTypes(long companyId, String type)
    • getListTypesCount

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

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

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

      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

      @Transactional(readOnly=true) void validate(long listTypeId, long classNameId, String type) throws PortalException
      Throws:
      PortalException
    • validate

      @Transactional(readOnly=true) void validate(long listTypeId, String type) throws PortalException
      Throws:
      PortalException