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
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddCPOption(CPOption cpOption) Adds the cp option to the database.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) 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) createCPOption(long CPOptionId) Creates a new cp option with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) deleteCPOption(long CPOptionId) Deletes the cp option with the primary key from the database.deleteCPOption(CPOption cpOption) Deletes the cp option from the database.voiddeleteCPOptions(long companyId) com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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.fetchCPOption(long CPOptionId) fetchCPOption(long companyId, String key) fetchCPOptionByExternalReferenceCode(String externalReferenceCode, long companyId) fetchCPOptionByUuidAndCompanyId(String uuid, long companyId) Returns the cp option with the matching UUID and company.findCPOptionByCompanyId(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPOption> orderByComparator) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerygetCPOption(long CPOptionId) Returns the cp option with the primary key.getCPOption(long companyId, String key) getCPOptionByExternalReferenceCode(String externalReferenceCode, long companyId) getCPOptionByUuidAndCompanyId(String uuid, long companyId) Returns the cp option with the matching UUID and company.getCPOptions(int start, int end) Returns a range of all the cp options.intReturns the number of cp options.intgetCPOptionsCount(long companyId) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPOption>com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) com.liferay.portal.kernel.search.BaseModelSearchResult<CPOption>searchCPOptions(long companyId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) 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) updateCPOption(CPOption cpOption) Updates the cp option in the database or adds it if it does not yet exist.updateCPOptionExternalReferenceCode(String externalReferenceCode, long cpOptionId) <R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPOption>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addCPOption
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> 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
-
addOrUpdateCPOption
CPOption addOrUpdateCPOption(String externalReferenceCode, long userId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> 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
-
createCPOption
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:
createPersistedModelin interfacecom.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:
deletePersistedModelin interfacecom.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:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.commerce.product.model.impl.CPOptionModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.commerce.product.model.impl.CPOptionModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchCPOption
-
fetchCPOption
-
fetchCPOptionByExternalReferenceCode
-
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 UUIDcompanyId- the primary key of the company- Returns:
- the matching cp option, or
nullif a matching cp option could not be found
-
findCPOptionByCompanyId
-
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 UUIDcompanyId- 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
Returns a range of all the cp options.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.commerce.product.model.impl.CPOptionModelImpl.- Parameters:
start- the lower bound of the range of cp optionsend- 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:
getPersistedModelin interfacecom.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
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> 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
-
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:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<CPOption>
-
getModelClass
- Specified by:
getModelClassin interfacecom.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, throws EE> updateUnsafeFunction)
-