Interface ClassNameLocalService

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

Provides the local service interface for ClassName. 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

    • addClassName

      @Indexable(type=REINDEX) ClassName addClassName(ClassName className)
      Adds the class name to the database. Also notifies the appropriate model listeners.

      Important: Inspect ClassNameLocalServiceImpl 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:
      className - the class name
      Returns:
      the class name that was added
    • addClassName

    • checkClassNames

      @Transactional(propagation=SUPPORTS, readOnly=true) void checkClassNames()
    • createClassName

      @Transactional(enabled=false) ClassName createClassName(long classNameId)
      Creates a new class name with the primary key. Does not add the class name to the database.
      Parameters:
      classNameId - the primary key for the new class name
      Returns:
      the new class name
    • createPersistedModel

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

      @Indexable(type=DELETE) ClassName deleteClassName(ClassName className)
      Deletes the class name from the database. Also notifies the appropriate model listeners.

      Important: Inspect ClassNameLocalServiceImpl 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:
      className - the class name
      Returns:
      the class name that was removed
    • deleteClassName

      @Indexable(type=DELETE) ClassName deleteClassName(long classNameId) throws PortalException
      Deletes the class name with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect ClassNameLocalServiceImpl 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:
      classNameId - the primary key of the class name
      Returns:
      the class name that was removed
      Throws:
      PortalException - if a class name with the primary key could not be found
    • 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.ClassNameModelImpl.

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

      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
    • fetchByClassNameId

      @Transactional(propagation=SUPPORTS, readOnly=true) ClassName fetchByClassNameId(long classNameId)
    • fetchClassName

      @Transactional(propagation=SUPPORTS, readOnly=true) ClassName fetchClassName(long classNameId)
    • fetchClassName

    • getActionableDynamicQuery

    • getClassName

      @Transactional(propagation=SUPPORTS, readOnly=true) ClassName getClassName(long classNameId) throws PortalException
      Returns the class name with the primary key.
      Parameters:
      classNameId - the primary key of the class name
      Returns:
      the class name
      Throws:
      PortalException - if a class name with the primary key could not be found
    • getClassName

      @Transactional(enabled=false) ClassName getClassName(String value)
    • getClassNameId

      @Transactional(enabled=false) long getClassNameId(Class<?> clazz)
    • getClassNameId

      @Transactional(enabled=false) long getClassNameId(String value)
    • getClassNameIdsSupplier

      @Transactional(propagation=SUPPORTS, readOnly=true) Supplier<long[]> getClassNameIdsSupplier(String[] classNames)
    • getClassNameIdSupplier

      @Transactional(propagation=SUPPORTS, readOnly=true) Supplier<Long> getClassNameIdSupplier(String className)
    • getClassNames

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ClassName> getClassNames(int start, int end)
      Returns a range of all the class names.

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

      Parameters:
      start - the lower bound of the range of class names
      end - the upper bound of the range of class names (not inclusive)
      Returns:
      the range of class names
    • getClassNamesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getClassNamesCount()
      Returns the number of class names.
      Returns:
      the number of class names
    • getIndexableActionableDynamicQuery

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

    • invalidate

      void invalidate()
    • updateClassName

      @Indexable(type=REINDEX) ClassName updateClassName(ClassName className)
      Updates the class name in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ClassNameLocalServiceImpl 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:
      className - the class name
      Returns:
      the class name that was updated