Class ClientExtensionEntryLocalServiceUtil

java.lang.Object
com.liferay.client.extension.service.ClientExtensionEntryLocalServiceUtil

public class ClientExtensionEntryLocalServiceUtil extends Object
Provides the local service utility for ClientExtensionEntry. This utility wraps com.liferay.client.extension.service.impl.ClientExtensionEntryLocalServiceImpl 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

    • ClientExtensionEntryLocalServiceUtil

      public ClientExtensionEntryLocalServiceUtil()
  • Method Details

    • addClientExtensionEntry

      public static ClientExtensionEntry addClientExtensionEntry(ClientExtensionEntry clientExtensionEntry)
      Adds the client extension entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect ClientExtensionEntryLocalServiceImpl 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:
      clientExtensionEntry - the client extension entry
      Returns:
      the client extension entry that was added
    • addClientExtensionEntry

      public static ClientExtensionEntry addClientExtensionEntry(String externalReferenceCode, long userId, String description, Map<Locale,String> nameMap, String properties, String sourceCodeURL, String type, String typeSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateClientExtensionEntry

      public static ClientExtensionEntry addOrUpdateClientExtensionEntry(String externalReferenceCode, long userId, String description, Map<Locale,String> nameMap, String properties, String sourceCodeURL, String type, String typeSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createClientExtensionEntry

      public static ClientExtensionEntry createClientExtensionEntry(long clientExtensionEntryId)
      Creates a new client extension entry with the primary key. Does not add the client extension entry to the database.
      Parameters:
      clientExtensionEntryId - the primary key for the new client extension entry
      Returns:
      the new client extension entry
    • 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
    • deleteClientExtensionEntry

      public static ClientExtensionEntry deleteClientExtensionEntry(ClientExtensionEntry clientExtensionEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the client extension entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect ClientExtensionEntryLocalServiceImpl 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:
      clientExtensionEntry - the client extension entry
      Returns:
      the client extension entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteClientExtensionEntry

      public static ClientExtensionEntry deleteClientExtensionEntry(long clientExtensionEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the client extension entry with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static void deployClientExtensionEntry(ClientExtensionEntry clientExtensionEntry) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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 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.client.extension.model.impl.ClientExtensionEntryModelImpl.

      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.client.extension.model.impl.ClientExtensionEntryModelImpl.

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

      public static ClientExtensionEntry fetchClientExtensionEntry(long clientExtensionEntryId)
    • fetchClientExtensionEntryByExternalReferenceCode

      public static ClientExtensionEntry fetchClientExtensionEntryByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchClientExtensionEntryByUuidAndCompanyId

      public static ClientExtensionEntry fetchClientExtensionEntryByUuidAndCompanyId(String uuid, long companyId)
      Returns the client extension entry with the matching UUID and company.
      Parameters:
      uuid - the client extension entry's UUID
      companyId - the primary key of the company
      Returns:
      the matching client extension entry, or null if a matching client extension entry could not be found
    • getActionableDynamicQuery

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

      public static List<ClientExtensionEntry> getClientExtensionEntries(int start, int end)
      Returns a range of all the client extension 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.client.extension.model.impl.ClientExtensionEntryModelImpl.

      Parameters:
      start - the lower bound of the range of client extension entries
      end - the upper bound of the range of client extension entries (not inclusive)
      Returns:
      the range of client extension entries
    • getClientExtensionEntries

      public static List<ClientExtensionEntry> getClientExtensionEntries(long companyId, int start, int end)
    • getClientExtensionEntries

      public static List<ClientExtensionEntry> getClientExtensionEntries(long companyId, String type, int start, int end)
    • getClientExtensionEntriesCount

      public static int getClientExtensionEntriesCount()
      Returns the number of client extension entries.
      Returns:
      the number of client extension entries
    • getClientExtensionEntriesCount

      public static int getClientExtensionEntriesCount(long companyId)
    • getClientExtensionEntriesCount

      public static int getClientExtensionEntriesCount(long companyId, String type)
    • getClientExtensionEntry

      public static ClientExtensionEntry getClientExtensionEntry(long clientExtensionEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the client extension entry with the primary key.
      Parameters:
      clientExtensionEntryId - the primary key of the client extension entry
      Returns:
      the client extension entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a client extension entry with the primary key could not be found
    • getClientExtensionEntryByExternalReferenceCode

      public static ClientExtensionEntry getClientExtensionEntryByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getClientExtensionEntryByUuidAndCompanyId

      public static ClientExtensionEntry getClientExtensionEntryByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the client extension entry with the matching UUID and company.
      Parameters:
      uuid - the client extension entry's UUID
      companyId - the primary key of the company
      Returns:
      the matching client extension entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching client extension entry could not be found
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • 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
    • search

      public static List<ClientExtensionEntry> search(long companyId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCount

      public static int searchCount(long companyId, String keywords) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • undeployClientExtensionEntry

      public static void undeployClientExtensionEntry(ClientExtensionEntry clientExtensionEntry)
    • updateClientExtensionEntry

      public static ClientExtensionEntry updateClientExtensionEntry(ClientExtensionEntry clientExtensionEntry)
      Updates the client extension entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ClientExtensionEntryLocalServiceImpl 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:
      clientExtensionEntry - the client extension entry
      Returns:
      the client extension entry that was updated
    • updateClientExtensionEntry

      public static ClientExtensionEntry updateClientExtensionEntry(long userId, long clientExtensionEntryId, String description, Map<Locale,String> nameMap, String properties, String sourceCodeURL, String typeSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public static ClientExtensionEntry updateStatus(long userId, long clientExtensionEntryId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static ClientExtensionEntryLocalService getService()