Class PLOEntryLocalServiceUtil

java.lang.Object
com.liferay.portal.language.override.service.PLOEntryLocalServiceUtil

public class PLOEntryLocalServiceUtil extends Object
Provides the local service utility for PLOEntry. This utility wraps com.liferay.portal.language.override.service.impl.PLOEntryLocalServiceImpl 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 Details

    • PLOEntryLocalServiceUtil

      public PLOEntryLocalServiceUtil()
  • Method Details

    • addOrUpdatePLOEntry

      public static PLOEntry addOrUpdatePLOEntry(long companyId, long userId, String key, String languageId, String value) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addPLOEntry

      public static PLOEntry addPLOEntry(PLOEntry ploEntry)
      Adds the plo entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect PLOEntryLocalServiceImpl 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:
      ploEntry - the plo entry
      Returns:
      the plo entry that was added
    • 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
    • createPLOEntry

      public static PLOEntry createPLOEntry(long ploEntryId)
      Creates a new plo entry with the primary key. Does not add the plo entry to the database.
      Parameters:
      ploEntryId - the primary key for the new plo entry
      Returns:
      the new plo entry
    • 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
    • deletePLOEntries

      public static void deletePLOEntries(long companyId, String key)
    • deletePLOEntry

      public static PLOEntry deletePLOEntry(long ploEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the plo entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect PLOEntryLocalServiceImpl 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:
      ploEntryId - the primary key of the plo entry
      Returns:
      the plo entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a plo entry with the primary key could not be found
    • deletePLOEntry

      public static PLOEntry deletePLOEntry(long companyId, String key, String languageId)
    • deletePLOEntry

      public static PLOEntry deletePLOEntry(PLOEntry ploEntry)
      Deletes the plo entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect PLOEntryLocalServiceImpl 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:
      ploEntry - the plo entry
      Returns:
      the plo entry that was removed
    • 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

      public 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.
      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 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.language.override.model.impl.PLOEntryModelImpl.

      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(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.portal.language.override.model.impl.PLOEntryModelImpl.

      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(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 query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchPLOEntry

      public static PLOEntry fetchPLOEntry(long ploEntryId)
    • fetchPLOEntry

      public static PLOEntry fetchPLOEntry(long companyId, String key, String languageId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String 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
    • getPLOEntries

      public static List<PLOEntry> getPLOEntries(int start, int end)
      Returns a range of all the plo entries.

      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.language.override.model.impl.PLOEntryModelImpl.

      Parameters:
      start - the lower bound of the range of plo entries
      end - the upper bound of the range of plo entries (not inclusive)
      Returns:
      the range of plo entries
    • getPLOEntries

      public static List<PLOEntry> getPLOEntries(long companyId)
    • getPLOEntries

      public static List<PLOEntry> getPLOEntries(long companyId, String languageId)
    • getPLOEntriesCount

      public static int getPLOEntriesCount()
      Returns the number of plo entries.
      Returns:
      the number of plo entries
    • getPLOEntriesCount

      public static int getPLOEntriesCount(long companyId)
    • getPLOEntry

      public static PLOEntry getPLOEntry(long ploEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the plo entry with the primary key.
      Parameters:
      ploEntryId - the primary key of the plo entry
      Returns:
      the plo entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a plo entry with the primary key could not be found
    • importPLOEntries

      public static void importPLOEntries(long companyId, long userId, String languageId, Properties properties) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setPLOEntries

      public static void setPLOEntries(long companyId, long userId, String key, Map<Locale,String> localizationMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updatePLOEntry

      public static PLOEntry updatePLOEntry(PLOEntry ploEntry)
      Updates the plo entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect PLOEntryLocalServiceImpl 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:
      ploEntry - the plo entry
      Returns:
      the plo entry that was updated
    • getService

      public static PLOEntryLocalService getService()