com.liferay.commerce.product.service

Class CPSpecificationOptionLocalServiceUtil

java.lang.Object

com.liferay.commerce.product.service.CPSpecificationOptionLocalServiceUtil

public class CPSpecificationOptionLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CPSpecificationOption. This utility wraps com.liferay.commerce.product.service.impl.CPSpecificationOptionLocalServiceImpl 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:

CPSpecificationOptionLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CPSpecificationOptionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CPSpecificationOption	addCPSpecificationOption(CPSpecificationOption cpSpecificationOption) Adds the cp specification option to the database.
static CPSpecificationOption	addCPSpecificationOption(long userId, long cpOptionCategoryId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean facetable, java.lang.String key, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CPSpecificationOption	createCPSpecificationOption(long CPSpecificationOptionId) Creates a new cp specification option with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static CPSpecificationOption	deleteCPSpecificationOption(CPSpecificationOption cpSpecificationOption) Deletes the cp specification option from the database.
static CPSpecificationOption	deleteCPSpecificationOption(long CPSpecificationOptionId) Deletes the cp specification option with the primary key from the database.
static void	deleteCPSpecificationOptions(long companyId)
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.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> java.util.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> java.util.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 long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
static CPSpecificationOption	fetchCPSpecificationOption(long CPSpecificationOptionId)
static CPSpecificationOption	fetchCPSpecificationOption(long companyId, java.lang.String key)
static CPSpecificationOption	fetchCPSpecificationOptionByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the cp specification option with the matching UUID and company.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static CPSpecificationOption	getCPSpecificationOption(long CPSpecificationOptionId) Returns the cp specification option with the primary key.
static CPSpecificationOption	getCPSpecificationOption(long companyId, java.lang.String key)
static CPSpecificationOption	getCPSpecificationOptionByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the cp specification option with the matching UUID and company.
static java.util.List<CPSpecificationOption>	getCPSpecificationOptions(int start, int end) Returns a range of all the cp specification options.
static int	getCPSpecificationOptionsCount() Returns the number of cp specification options.
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static CPSpecificationOptionLocalService	getService()
static com.liferay.portal.kernel.search.BaseModelSearchResult<CPSpecificationOption>	searchCPSpecificationOptions(long companyId, java.lang.Boolean facetable, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static CPSpecificationOption	updateCPOptionCategoryId(long cpSpecificationOptionId, long cpOptionCategoryId)
static CPSpecificationOption	updateCPSpecificationOption(CPSpecificationOption cpSpecificationOption) Updates the cp specification option in the database or adds it if it does not yet exist.
static CPSpecificationOption	updateCPSpecificationOption(long cpSpecificationOptionId, long cpOptionCategoryId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean facetable, java.lang.String key, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CPSpecificationOptionLocalServiceUtil

public CPSpecificationOptionLocalServiceUtil()

Method Detail

addCPSpecificationOption

public static CPSpecificationOption addCPSpecificationOption(CPSpecificationOption cpSpecificationOption)

Adds the cp specification option to the database. Also notifies the appropriate model listeners.

Important: Inspect CPSpecificationOptionLocalServiceImpl 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:

cpSpecificationOption - the cp specification option

Returns:

the cp specification option that was added

addCPSpecificationOption

public static CPSpecificationOption addCPSpecificationOption(long userId,
                                                             long cpOptionCategoryId,
                                                             java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                             boolean facetable,
                                                             java.lang.String key,
                                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCPSpecificationOption

public static CPSpecificationOption createCPSpecificationOption(long CPSpecificationOptionId)

Creates a new cp specification option with the primary key. Does not add the cp specification option to the database.

Parameters:

CPSpecificationOptionId - the primary key for the new cp specification option

Returns:

the new cp specification option

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCPSpecificationOption

public static CPSpecificationOption deleteCPSpecificationOption(CPSpecificationOption cpSpecificationOption)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Deletes the cp specification option from the database. Also notifies the appropriate model listeners.

Important: Inspect CPSpecificationOptionLocalServiceImpl 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:

cpSpecificationOption - the cp specification option

Returns:

the cp specification option that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCPSpecificationOption

public static CPSpecificationOption deleteCPSpecificationOption(long CPSpecificationOptionId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Deletes the cp specification option with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect CPSpecificationOptionLocalServiceImpl 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:

CPSpecificationOptionId - the primary key of the cp specification option

Returns:

the cp specification option that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a cp specification option with the primary key could not be found

deleteCPSpecificationOptions

public static void deleteCPSpecificationOptions(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

public static <T> java.util.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> java.util.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.CPSpecificationOptionModelImpl.

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> java.util.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.CPSpecificationOptionModelImpl.

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

fetchCPSpecificationOption

public static CPSpecificationOption fetchCPSpecificationOption(long CPSpecificationOptionId)

fetchCPSpecificationOption

public static CPSpecificationOption fetchCPSpecificationOption(long companyId,
                                                               java.lang.String key)

fetchCPSpecificationOptionByUuidAndCompanyId

public static CPSpecificationOption fetchCPSpecificationOptionByUuidAndCompanyId(java.lang.String uuid,
                                                                                 long companyId)

Returns the cp specification option with the matching UUID and company.

Parameters:

uuid - the cp specification option's UUID

companyId - the primary key of the company

Returns:

the matching cp specification option, or null if a matching cp specification option could not be found

getActionableDynamicQuery

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

getCPSpecificationOption

public static CPSpecificationOption getCPSpecificationOption(long CPSpecificationOptionId)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the cp specification option with the primary key.

Parameters:

CPSpecificationOptionId - the primary key of the cp specification option

Returns:

the cp specification option

Throws:

com.liferay.portal.kernel.exception.PortalException - if a cp specification option with the primary key could not be found

getCPSpecificationOption

public static CPSpecificationOption getCPSpecificationOption(long companyId,
                                                             java.lang.String key)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCPSpecificationOptionByUuidAndCompanyId

public static CPSpecificationOption getCPSpecificationOptionByUuidAndCompanyId(java.lang.String uuid,
                                                                               long companyId)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Returns the cp specification option with the matching UUID and company.

Parameters:

uuid - the cp specification option's UUID

companyId - the primary key of the company

Returns:

the matching cp specification option

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching cp specification option could not be found

getCPSpecificationOptions

public static java.util.List<CPSpecificationOption> getCPSpecificationOptions(int start,
                                                                              int end)

Returns a range of all the cp specification 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.CPSpecificationOptionModelImpl.

Parameters:

start - the lower bound of the range of cp specification options

end - the upper bound of the range of cp specification options (not inclusive)

Returns:

the range of cp specification options

getCPSpecificationOptionsCount

public static int getCPSpecificationOptionsCount()

Returns the number of cp specification options.

Returns:

the number of cp specification options

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 java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

searchCPSpecificationOptions

public static com.liferay.portal.kernel.search.BaseModelSearchResult<CPSpecificationOption> searchCPSpecificationOptions(long companyId,
                                                                                                                         java.lang.Boolean facetable,
                                                                                                                         java.lang.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

updateCPOptionCategoryId

public static CPSpecificationOption updateCPOptionCategoryId(long cpSpecificationOptionId,
                                                             long cpOptionCategoryId)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCPSpecificationOption

public static CPSpecificationOption updateCPSpecificationOption(CPSpecificationOption cpSpecificationOption)

Updates the cp specification option in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect CPSpecificationOptionLocalServiceImpl 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:

cpSpecificationOption - the cp specification option

Returns:

the cp specification option that was updated

updateCPSpecificationOption

public static CPSpecificationOption updateCPSpecificationOption(long cpSpecificationOptionId,
                                                                long cpOptionCategoryId,
                                                                java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                                                java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                                boolean facetable,
                                                                java.lang.String key,
                                                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CPSpecificationOptionLocalService getService()