Class ClassNameLocalServiceUtil

Object
com.liferay.portal.kernel.service.ClassNameLocalServiceUtil

public class ClassNameLocalServiceUtil extends Object
Provides the local service utility for ClassName. This utility wraps com.liferay.portal.service.impl.ClassNameLocalServiceImpl 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 Details

    • ClassNameLocalServiceUtil

      public ClassNameLocalServiceUtil()
  • Method Details

    • addClassName

      public static 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

      public static ClassName addClassName(String value)
    • checkClassNames

      public static void checkClassNames()
    • createClassName

      public static 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

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • deleteClassName

      public static 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

      public static 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

      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

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

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

      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

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

      public static 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

      public static 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

      public static ClassName fetchByClassNameId(long classNameId)
    • fetchClassName

      public static ClassName fetchClassName(long classNameId)
    • fetchClassName

      public static ClassName fetchClassName(String value)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getClassName

      public static 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

      public static ClassName getClassName(String value)
    • getClassNameId

      public static long getClassNameId(Class<?> clazz)
    • getClassNameId

      public static long getClassNameId(String value)
    • getClassNameIdsSupplier

      public static Supplier<long[]> getClassNameIdsSupplier(String[] classNames)
    • getClassNameIdSupplier

      public static Supplier<Long> getClassNameIdSupplier(String className)
    • getClassNames

      public static 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

      public static int getClassNamesCount()
      Returns the number of class names.
      Returns:
      the number of class names
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getRegistryName

      public static String getRegistryName()
    • invalidate

      public static void invalidate()
    • updateClassName

      public static 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
    • getService

      public static ClassNameLocalService getService()
    • setService

      public static void setService(ClassNameLocalService service)