Class CPOptionLocalServiceUtil
com.liferay.commerce.product.service.impl.CPOptionLocalServiceImpl 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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic CPOptionaddCPOption(CPOption cpOption) Adds the cp option to the database.static CPOptionaddCPOption(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) static CPOptionaddOrUpdateCPOption(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) static CPOptioncreateCPOption(long CPOptionId) Creates a new cp option with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static CPOptiondeleteCPOption(long CPOptionId) Deletes the cp option with the primary key from the database.static CPOptiondeleteCPOption(CPOption cpOption) Deletes the cp option from the database.static voiddeleteCPOptions(long companyId) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static 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.static CPOptionfetchCPOption(long CPOptionId) static CPOptionfetchCPOption(long companyId, String key) static CPOptionfetchCPOptionByExternalReferenceCode(String externalReferenceCode, long companyId) static CPOptionfetchCPOptionByUuidAndCompanyId(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) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic CPOptiongetCPOption(long CPOptionId) Returns the cp option with the primary key.static CPOptiongetCPOption(long companyId, String key) static CPOptiongetCPOptionByExternalReferenceCode(String externalReferenceCode, long companyId) static CPOptiongetCPOptionByUuidAndCompanyId(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.static intReturns the number of cp options.static intgetCPOptionsCount(long companyId) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static CPOptionLocalServicestatic com.liferay.portal.kernel.search.BaseModelSearchResult<CPOption>searchCPOptions(long companyId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) static CPOptionupdateCPOption(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) static CPOptionupdateCPOption(CPOption cpOption) Updates the cp option in the database or adds it if it does not yet exist.static CPOptionupdateCPOptionExternalReferenceCode(String externalReferenceCode, long cpOptionId)
-
Constructor Details
-
CPOptionLocalServiceUtil
public CPOptionLocalServiceUtil()
-
-
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
public static 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
public static 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
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
-
deleteCPOption
public static 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
public static 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
public static void deleteCPOptions(long companyId) 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
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 - 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
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 - 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
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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchCPOption
-
fetchCPOption
-
fetchCPOptionByExternalReferenceCode
-
fetchCPOptionByUuidAndCompanyId
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
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getCPOption
public static 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
public static CPOption getCPOption(long companyId, String key) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCPOptionByExternalReferenceCode
public static CPOption getCPOptionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCPOptionByUuidAndCompanyId
public static 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
public static int getCPOptionsCount()Returns the number of cp options.- Returns:
- the number of cp options
-
getCPOptionsCount
public static int getCPOptionsCount(long companyId) -
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
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
-
searchCPOptions
public static 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
public static 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
public static CPOption updateCPOptionExternalReferenceCode(String externalReferenceCode, long cpOptionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-