Interface CPOptionLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<CPOption>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
CPOptionLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface CPOptionLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<CPOption>, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for CPOption. 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:
  • Method Details

    • addCPOption

      @Indexable(type=REINDEX) CPOption addCPOption(CPOption cpOption)
      Adds the cp option to the database. Also notifies the appropriate model listeners.

      Important: Inspect CPOptionLocalServiceImpl 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:
      cpOption - the cp option
      Returns:
      the cp option that was added
    • addCPOption

      @Indexable(type=REINDEX) CPOption addCPOption(String externalReferenceCode, long userId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, boolean facetable, boolean required, boolean skuContributor, String key, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateCPOption

      CPOption addOrUpdateCPOption(String externalReferenceCode, long userId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, boolean facetable, boolean required, boolean skuContributor, String key, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCPOption

      @Transactional(enabled=false) CPOption createCPOption(long CPOptionId)
      Creates a new cp option with the primary key. Does not add the cp option to the database.
      Parameters:
      CPOptionId - the primary key for the new cp option
      Returns:
      the new cp option
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPOption

      @Indexable(type=DELETE) @SystemEvent(type=1) CPOption deleteCPOption(CPOption cpOption) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the cp option from the database. Also notifies the appropriate model listeners.

      Important: Inspect CPOptionLocalServiceImpl 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:
      cpOption - the cp option
      Returns:
      the cp option that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPOption

      @Indexable(type=DELETE) CPOption deleteCPOption(long CPOptionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the cp option with the primary key from the database. Also notifies the appropriate model listeners.

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

      void deleteCPOptions(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.CPOptionModelImpl.

      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(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.CPOptionModelImpl.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption fetchCPOption(long CPOptionId)
    • fetchCPOption

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption fetchCPOption(long companyId, String key)
    • fetchCPOptionByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption fetchCPOptionByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCPOptionByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption fetchCPOptionByUuidAndCompanyId(String uuid, long companyId)
      Returns the cp option with the matching UUID and company.
      Parameters:
      uuid - the cp option's UUID
      companyId - the primary key of the company
      Returns:
      the matching cp option, or null if a matching cp option could not be found
    • findCPOptionByCompanyId

      List<CPOption> findCPOptionByCompanyId(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPOption> orderByComparator)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getCPOption

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption getCPOption(long CPOptionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp option with the primary key.
      Parameters:
      CPOptionId - the primary key of the cp option
      Returns:
      the cp option
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a cp option with the primary key could not be found
    • getCPOption

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption getCPOption(long companyId, String key) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPOptionByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption getCPOptionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPOptionByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOption getCPOptionByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp option with the matching UUID and company.
      Parameters:
      uuid - the cp option's UUID
      companyId - the primary key of the company
      Returns:
      the matching cp option
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching cp option could not be found
    • getCPOptions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPOption> getCPOptions(int start, int end)
      Returns a range of all the cp options.

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

      Parameters:
      start - the lower bound of the range of cp options
      end - the upper bound of the range of cp options (not inclusive)
      Returns:
      the range of cp options
    • getCPOptionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCPOptionsCount()
      Returns the number of cp options.
      Returns:
      the number of cp options
    • getCPOptionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCPOptionsCount(long companyId)
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCPOptions

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.BaseModelSearchResult<CPOption> searchCPOptions(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
    • updateCPOption

      @Indexable(type=REINDEX) CPOption updateCPOption(CPOption cpOption)
      Updates the cp option in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CPOptionLocalServiceImpl 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:
      cpOption - the cp option
      Returns:
      the cp option that was updated
    • updateCPOption

      @Indexable(type=REINDEX) CPOption updateCPOption(long cpOptionId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String commerceOptionTypeKey, boolean facetable, boolean required, boolean skuContributor, String key, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCPOptionExternalReferenceCode

      @Indexable(type=REINDEX) CPOption updateCPOptionExternalReferenceCode(String externalReferenceCode, long cpOptionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCTPersistence

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPOption> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPOption>
    • getModelClass

      @Transactional(enabled=false) Class<CPOption> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPOption>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPOption>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPOption>
      Throws:
      E extends Throwable