Interface CPOptionValueLocalService

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

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

    • addCPOptionValue

      @Indexable(type=REINDEX) CPOptionValue addCPOptionValue(CPOptionValue cpOptionValue)
      Adds the cp option value to the database. Also notifies the appropriate model listeners.

      Important: Inspect CPOptionValueLocalServiceImpl 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:
      cpOptionValue - the cp option value
      Returns:
      the cp option value that was added
    • addCPOptionValue

      @Indexable(type=REINDEX) CPOptionValue addCPOptionValue(long cpOptionId, Map<Locale,String> nameMap, double priority, String key, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCPOptionValue

      @Indexable(type=REINDEX) CPOptionValue addCPOptionValue(String externalReferenceCode, long cpOptionId, Map<Locale,String> nameMap, double priority, String key, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateCPOptionValue

      CPOptionValue addOrUpdateCPOptionValue(String externalReferenceCode, long cpOptionId, Map<Locale,String> nameMap, double priority, String key, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCPOptionValue

      @Transactional(enabled=false) CPOptionValue createCPOptionValue(long CPOptionValueId)
      Creates a new cp option value with the primary key. Does not add the cp option value to the database.
      Parameters:
      CPOptionValueId - the primary key for the new cp option value
      Returns:
      the new cp option value
    • 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
    • deleteCPOptionValue

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

      Important: Inspect CPOptionValueLocalServiceImpl 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:
      cpOptionValue - the cp option value
      Returns:
      the cp option value that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPOptionValue

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

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

      void deleteCPOptionValues(long cpOptionId) 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.CPOptionValueModelImpl.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOptionValue fetchCPOptionValue(long CPOptionValueId)
    • fetchCPOptionValueByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOptionValue fetchCPOptionValueByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCPOptionValueByUuidAndCompanyId

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CPOptionValue getCPOptionValue(long cpOptionId, String key) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPOptionValueByExternalReferenceCode

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPOptionValue> getCPOptionValues(int start, int end)
      Returns a range of all the cp option values.

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

      Parameters:
      start - the lower bound of the range of cp option values
      end - the upper bound of the range of cp option values (not inclusive)
      Returns:
      the range of cp option values
    • getCPOptionValues

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPOptionValue> getCPOptionValues(long cpOptionId, int start, int end)
    • getCPOptionValues

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPOptionValue> getCPOptionValues(long cpOptionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPOptionValue> orderByComparator)
    • getCPOptionValuesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCPOptionValuesCount()
      Returns the number of cp option values.
      Returns:
      the number of cp option values
    • getCPOptionValuesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCPOptionValuesCount(long cpOptionId)
    • 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
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.Hits search(com.liferay.portal.kernel.search.SearchContext searchContext)
    • searchCPOptionValues

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.BaseModelSearchResult<CPOptionValue> searchCPOptionValues(long companyId, long cpOptionId, 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
    • searchCPOptionValuesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCPOptionValuesCount(long companyId, long cpOptionId, String keywords) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCPOptionValue

      @Indexable(type=REINDEX) CPOptionValue updateCPOptionValue(CPOptionValue cpOptionValue)
      Updates the cp option value in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CPOptionValueLocalServiceImpl 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:
      cpOptionValue - the cp option value
      Returns:
      the cp option value that was updated
    • updateCPOptionValue

      @Indexable(type=REINDEX) CPOptionValue updateCPOptionValue(long cpOptionValueId, Map<Locale,String> nameMap, double priority, String key, com.liferay.portal.kernel.service.ServiceContext serviceContext) 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<CPOptionValue> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPOptionValue>
    • getModelClass

      @Transactional(enabled=false) Class<CPOptionValue> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPOptionValue>
    • 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<CPOptionValue>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPOptionValue>
      Throws:
      E extends Throwable