Class CPDefinitionOptionRelLocalServiceUtil

java.lang.Object
com.liferay.commerce.product.service.CPDefinitionOptionRelLocalServiceUtil

public class CPDefinitionOptionRelLocalServiceUtil extends Object
Provides the local service utility for CPDefinitionOptionRel. This utility wraps com.liferay.commerce.product.service.impl.CPDefinitionOptionRelLocalServiceImpl 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

    • CPDefinitionOptionRelLocalServiceUtil

      public CPDefinitionOptionRelLocalServiceUtil()
  • Method Details

    • addCPDefinitionOptionRel

      public static CPDefinitionOptionRel addCPDefinitionOptionRel(CPDefinitionOptionRel cpDefinitionOptionRel)
      Adds the cp definition option rel to the database. Also notifies the appropriate model listeners.

      Important: Inspect CPDefinitionOptionRelLocalServiceImpl 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:
      cpDefinitionOptionRel - the cp definition option rel
      Returns:
      the cp definition option rel that was added
    • addCPDefinitionOptionRel

      public static CPDefinitionOptionRel addCPDefinitionOptionRel(long cpDefinitionId, long cpOptionId, boolean importOptionValue, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCPDefinitionOptionRel

      public static CPDefinitionOptionRel addCPDefinitionOptionRel(long cpDefinitionId, long cpOptionId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, double priority, boolean facetable, boolean required, boolean skuContributor, boolean importOptionValue, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCPDefinitionOptionRel

      public static CPDefinitionOptionRel addCPDefinitionOptionRel(long cpDefinitionId, long cpOptionId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, double priority, boolean facetable, boolean required, boolean skuContributor, boolean importOptionValue, String priceType, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCPDefinitionOptionRel

      public static CPDefinitionOptionRel addCPDefinitionOptionRel(long cpDefinitionId, long cpOptionId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, String infoItemServiceKey, double priority, boolean definedExternally, boolean facetable, boolean required, boolean skuContributor, boolean importOptionValue, String priceType, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCPDefinitionOptionRel

      public static CPDefinitionOptionRel addCPDefinitionOptionRel(long cpDefinitionId, long cpOptionId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCPDefinitionOptionRel

      public static CPDefinitionOptionRel createCPDefinitionOptionRel(long CPDefinitionOptionRelId)
      Creates a new cp definition option rel with the primary key. Does not add the cp definition option rel to the database.
      Parameters:
      CPDefinitionOptionRelId - the primary key for the new cp definition option rel
      Returns:
      the new cp definition option rel
    • 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
    • deleteCPDefinitionOptionRel

      public static CPDefinitionOptionRel deleteCPDefinitionOptionRel(CPDefinitionOptionRel cpDefinitionOptionRel) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the cp definition option rel from the database. Also notifies the appropriate model listeners.

      Important: Inspect CPDefinitionOptionRelLocalServiceImpl 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:
      cpDefinitionOptionRel - the cp definition option rel
      Returns:
      the cp definition option rel that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPDefinitionOptionRel

      public static CPDefinitionOptionRel deleteCPDefinitionOptionRel(long CPDefinitionOptionRelId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the cp definition option rel with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CPDefinitionOptionRelLocalServiceImpl 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:
      CPDefinitionOptionRelId - the primary key of the cp definition option rel
      Returns:
      the cp definition option rel that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a cp definition option rel with the primary key could not be found
    • deleteCPDefinitionOptionRels

      public static void deleteCPDefinitionOptionRels(long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • 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.commerce.product.model.impl.CPDefinitionOptionRelModelImpl.

      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.commerce.product.model.impl.CPDefinitionOptionRelModelImpl.

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

      public static CPDefinitionOptionRel fetchCPDefinitionOptionRel(long CPDefinitionOptionRelId)
    • fetchCPDefinitionOptionRel

      public static CPDefinitionOptionRel fetchCPDefinitionOptionRel(long cpDefinitionId, long cpOptionId)
    • fetchCPDefinitionOptionRelByKey

      public static CPDefinitionOptionRel fetchCPDefinitionOptionRelByKey(long cpDefinitionId, String key)
    • fetchCPDefinitionOptionRelByUuidAndGroupId

      public static CPDefinitionOptionRel fetchCPDefinitionOptionRelByUuidAndGroupId(String uuid, long groupId)
      Returns the cp definition option rel matching the UUID and group.
      Parameters:
      uuid - the cp definition option rel's UUID
      groupId - the primary key of the group
      Returns:
      the matching cp definition option rel, or null if a matching cp definition option rel could not be found
    • getActionableDynamicQuery

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

      public static CPDefinitionOptionRel getCPDefinitionOptionRel(long CPDefinitionOptionRelId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp definition option rel with the primary key.
      Parameters:
      CPDefinitionOptionRelId - the primary key of the cp definition option rel
      Returns:
      the cp definition option rel
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a cp definition option rel with the primary key could not be found
    • getCPDefinitionOptionRelByUuidAndGroupId

      public static CPDefinitionOptionRel getCPDefinitionOptionRelByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp definition option rel matching the UUID and group.
      Parameters:
      uuid - the cp definition option rel's UUID
      groupId - the primary key of the group
      Returns:
      the matching cp definition option rel
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching cp definition option rel could not be found
    • getCPDefinitionOptionRelCPDefinitionOptionValueRelIds

      public static Map<Long,List<Long>> getCPDefinitionOptionRelCPDefinitionOptionValueRelIds(long cpDefinitionId, boolean skuContributorsOnly, com.liferay.portal.kernel.json.JSONArray skuOptionJSONArray) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPDefinitionOptionRelCPDefinitionOptionValueRelIds

      public static Map<Long,List<Long>> getCPDefinitionOptionRelCPDefinitionOptionValueRelIds(long cpDefinitionId, boolean skuContributorsOnly, String json) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPDefinitionOptionRelCPDefinitionOptionValueRelIds

      public static Map<Long,List<Long>> getCPDefinitionOptionRelCPDefinitionOptionValueRelIds(long cpDefinitionId, String json) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPDefinitionOptionRelKeysCPDefinitionOptionValueRelKeys

      public static Map<String,List<String>> getCPDefinitionOptionRelKeysCPDefinitionOptionValueRelKeys(long cpInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPDefinitionOptionRels

      public static List<CPDefinitionOptionRel> getCPDefinitionOptionRels(int start, int end)
      Returns a range of all the cp definition option rels.

      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.commerce.product.model.impl.CPDefinitionOptionRelModelImpl.

      Parameters:
      start - the lower bound of the range of cp definition option rels
      end - the upper bound of the range of cp definition option rels (not inclusive)
      Returns:
      the range of cp definition option rels
    • getCPDefinitionOptionRels

      public static List<CPDefinitionOptionRel> getCPDefinitionOptionRels(long cpDefinitionId)
    • getCPDefinitionOptionRels

      public static List<CPDefinitionOptionRel> getCPDefinitionOptionRels(long cpDefinitionId, boolean skuContributor)
    • getCPDefinitionOptionRels

      public static List<CPDefinitionOptionRel> getCPDefinitionOptionRels(long cpDefinitionId, int start, int end)
    • getCPDefinitionOptionRels

      public static List<CPDefinitionOptionRel> getCPDefinitionOptionRels(long cpDefinitionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPDefinitionOptionRel> orderByComparator)
    • getCPDefinitionOptionRelsByUuidAndCompanyId

      public static List<CPDefinitionOptionRel> getCPDefinitionOptionRelsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the cp definition option rels matching the UUID and company.
      Parameters:
      uuid - the UUID of the cp definition option rels
      companyId - the primary key of the company
      Returns:
      the matching cp definition option rels, or an empty list if no matches were found
    • getCPDefinitionOptionRelsByUuidAndCompanyId

      public static List<CPDefinitionOptionRel> getCPDefinitionOptionRelsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPDefinitionOptionRel> orderByComparator)
      Returns a range of cp definition option rels matching the UUID and company.
      Parameters:
      uuid - the UUID of the cp definition option rels
      companyId - the primary key of the company
      start - the lower bound of the range of cp definition option rels
      end - the upper bound of the range of cp definition option rels (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching cp definition option rels, or an empty list if no matches were found
    • getCPDefinitionOptionRelsCount

      public static int getCPDefinitionOptionRelsCount()
      Returns the number of cp definition option rels.
      Returns:
      the number of cp definition option rels
    • getCPDefinitionOptionRelsCount

      public static int getCPDefinitionOptionRelsCount(long cpDefinitionId)
    • getCPDefinitionOptionRelsCount

      public static int getCPDefinitionOptionRelsCount(long cpDefinitionId, boolean skuContributor)
    • getCPOptionCPDefinitionOptionRels

      public static List<CPDefinitionOptionRel> getCPOptionCPDefinitionOptionRels(long cpOptionId)
    • getCPOptionCPDefinitionOptionRelsCount

      public static int getCPOptionCPDefinitionOptionRelsCount(long cpOptionId)
    • 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
    • hasCPDefinitionPriceContributorCPDefinitionOptionRels

      public static boolean hasCPDefinitionPriceContributorCPDefinitionOptionRels(long cpDefinitionId)
    • hasCPDefinitionRequiredCPDefinitionOptionRels

      public static boolean hasCPDefinitionRequiredCPDefinitionOptionRels(long cpDefinitionId)
    • hasLinkedCPInstanceCPDefinitionOptionRels

      public static boolean hasLinkedCPInstanceCPDefinitionOptionRels(long cpDefinitionId)
    • search

      public static com.liferay.portal.kernel.search.Hits search(com.liferay.portal.kernel.search.SearchContext searchContext)
    • searchCPDefinitionOptionRels

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDefinitionOptionRel> searchCPDefinitionOptionRels(long companyId, long groupId, long cpDefinitionId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort[] sorts) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCPDefinitionOptionRelsCount

      public static int searchCPDefinitionOptionRelsCount(long companyId, long groupId, long cpDefinitionId, String keywords) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCPDefinitionOptionRel

      public static CPDefinitionOptionRel updateCPDefinitionOptionRel(CPDefinitionOptionRel cpDefinitionOptionRel)
      Updates the cp definition option rel in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CPDefinitionOptionRelLocalServiceImpl 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:
      cpDefinitionOptionRel - the cp definition option rel
      Returns:
      the cp definition option rel that was updated
    • updateCPDefinitionOptionRel

      public static CPDefinitionOptionRel updateCPDefinitionOptionRel(long cpDefinitionOptionRelId, long cpOptionId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, double priority, boolean facetable, boolean required, boolean skuContributor, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCPDefinitionOptionRel

      public static CPDefinitionOptionRel updateCPDefinitionOptionRel(long cpDefinitionOptionRelId, long cpOptionId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, String infoItemServiceKey, double priority, boolean definedExternally, boolean facetable, boolean required, boolean skuContributor, String priceType, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CPDefinitionOptionRelLocalService getService()