com.liferay.commerce.product.service

Interface CommerceCatalogLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

CommerceCatalogLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface CommerceCatalogLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for CommerceCatalog. 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:

CommerceCatalogLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
CommerceCatalog	addCommerceCatalog(CommerceCatalog commerceCatalog) Adds the commerce catalog to the database.
CommerceCatalog	addCommerceCatalog(java.lang.String externalReferenceCode, java.lang.String name, java.lang.String commerceCurrencyCode, java.lang.String catalogDefaultLanguageId, boolean system, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceCatalog	addCommerceCatalog(java.lang.String externalReferenceCode, java.lang.String name, java.lang.String commerceCurrencyCode, java.lang.String catalogDefaultLanguageId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceCatalog	addDefaultCommerceCatalog(long companyId)
CommerceCatalog	createCommerceCatalog(long commerceCatalogId) Creates a new commerce catalog with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
CommerceCatalog	deleteCommerceCatalog(CommerceCatalog commerceCatalog) Deletes the commerce catalog from the database.
CommerceCatalog	deleteCommerceCatalog(long commerceCatalogId) Deletes the commerce catalog with the primary key from the database.
void	deleteCommerceCatalogs(long companyId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
CommerceCatalog	fetchByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId)
CommerceCatalog	fetchCommerceCatalog(long commerceCatalogId)
CommerceCatalog	fetchCommerceCatalogByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce catalog with the matching external reference code and company.
CommerceCatalog	fetchCommerceCatalogByGroupId(long groupId)
CommerceCatalog	fetchCommerceCatalogByReferenceCode(long companyId, java.lang.String externalReferenceCode) Deprecated. As of Cavanaugh (7.4.x), replaced by fetchCommerceCatalogByExternalReferenceCode(long, String)
CommerceCatalog	forceDeleteCommerceCatalog(CommerceCatalog commerceCatalog)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
CommerceCatalog	getCommerceCatalog(long commerceCatalogId) Returns the commerce catalog with the primary key.
CommerceCatalog	getCommerceCatalogByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce catalog with the matching external reference code and company.
com.liferay.portal.kernel.model.Group	getCommerceCatalogGroup(long commerceCatalogId)
java.util.List<CommerceCatalog>	getCommerceCatalogs(int start, int end) Returns a range of all the commerce catalogs.
java.util.List<CommerceCatalog>	getCommerceCatalogs(long companyId, boolean system)
int	getCommerceCatalogsCount() Returns the number of commerce catalogs.
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<CommerceCatalog>	search(long companyId)
java.util.List<CommerceCatalog>	search(long companyId, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
int	searchCommerceCatalogsCount(long companyId, java.lang.String keywords)
CommerceCatalog	updateCommerceCatalog(CommerceCatalog commerceCatalog) Updates the commerce catalog in the database or adds it if it does not yet exist.
CommerceCatalog	updateCommerceCatalog(long commerceCatalogId, java.lang.String name, java.lang.String commerceCurrencyCode, java.lang.String catalogDefaultLanguageId)
CommerceCatalog	updateCommerceCatalogExternalReferenceCode(java.lang.String externalReferenceCode, long commerceCatalogId)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addCommerceCatalog

@Indexable(type=REINDEX)
CommerceCatalog addCommerceCatalog(CommerceCatalog commerceCatalog)

Adds the commerce catalog to the database. Also notifies the appropriate model listeners.

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

commerceCatalog - the commerce catalog

Returns:

the commerce catalog that was added

addCommerceCatalog

@Indexable(type=REINDEX)
CommerceCatalog addCommerceCatalog(java.lang.String externalReferenceCode,
                                                            java.lang.String name,
                                                            java.lang.String commerceCurrencyCode,
                                                            java.lang.String catalogDefaultLanguageId,
                                                            boolean system,
                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCommerceCatalog

CommerceCatalog addCommerceCatalog(java.lang.String externalReferenceCode,
                                   java.lang.String name,
                                   java.lang.String commerceCurrencyCode,
                                   java.lang.String catalogDefaultLanguageId,
                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addDefaultCommerceCatalog

CommerceCatalog addDefaultCommerceCatalog(long companyId)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceCatalog

@Transactional(enabled=false)
CommerceCatalog createCommerceCatalog(long commerceCatalogId)

Creates a new commerce catalog with the primary key. Does not add the commerce catalog to the database.

Parameters:

commerceCatalogId - the primary key for the new commerce catalog

Returns:

the new commerce catalog

createPersistedModel

com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.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

deleteCommerceCatalog

@Indexable(type=DELETE)
 @SystemEvent(type=1)
CommerceCatalog deleteCommerceCatalog(CommerceCatalog commerceCatalog)
                                                                             throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce catalog from the database. Also notifies the appropriate model listeners.

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

commerceCatalog - the commerce catalog

Returns:

the commerce catalog that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceCatalog

@Indexable(type=DELETE)
CommerceCatalog deleteCommerceCatalog(long commerceCatalogId)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce catalog with the primary key from the database. Also notifies the appropriate model listeners.

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

commerceCatalogId - the primary key of the commerce catalog

Returns:

the commerce catalog that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce catalog with the primary key could not be found

deleteCommerceCatalogs

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

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

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

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

fetchByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceCatalog fetchByExternalReferenceCode(java.lang.String externalReferenceCode,
                                                                                                                long companyId)

fetchCommerceCatalog

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceCatalog fetchCommerceCatalog(long commerceCatalogId)

fetchCommerceCatalogByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceCatalog fetchCommerceCatalogByExternalReferenceCode(long companyId,
                                                                                                                               java.lang.String externalReferenceCode)

Returns the commerce catalog with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce catalog's external reference code

Returns:

the matching commerce catalog, or null if a matching commerce catalog could not be found

fetchCommerceCatalogByGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceCatalog fetchCommerceCatalogByGroupId(long groupId)

fetchCommerceCatalogByReferenceCode

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceCatalog fetchCommerceCatalogByReferenceCode(long companyId,
                                                                                                                                    java.lang.String externalReferenceCode)

Deprecated. As of Cavanaugh (7.4.x), replaced by fetchCommerceCatalogByExternalReferenceCode(long, String)

forceDeleteCommerceCatalog

@Indexable(type=DELETE)
 @SystemEvent(type=1)
CommerceCatalog forceDeleteCommerceCatalog(CommerceCatalog commerceCatalog)
                                                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getActionableDynamicQuery

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

getCommerceCatalog

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceCatalog getCommerceCatalog(long commerceCatalogId)
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce catalog with the primary key.

Parameters:

commerceCatalogId - the primary key of the commerce catalog

Returns:

the commerce catalog

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce catalog with the primary key could not be found

getCommerceCatalogByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceCatalog getCommerceCatalogByExternalReferenceCode(long companyId,
                                                                                                                             java.lang.String externalReferenceCode)
                                                                                                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce catalog with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce catalog's external reference code

Returns:

the matching commerce catalog

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching commerce catalog could not be found

getCommerceCatalogGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.Group getCommerceCatalogGroup(long commerceCatalogId)
                                                                                                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceCatalogs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceCatalog> getCommerceCatalogs(int start,
                                                                                                                       int end)

Returns a range of all the commerce catalogs.

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

Parameters:

start - the lower bound of the range of commerce catalogs

end - the upper bound of the range of commerce catalogs (not inclusive)

Returns:

the range of commerce catalogs

getCommerceCatalogs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceCatalog> getCommerceCatalogs(long companyId,
                                                                                                                       boolean system)

getCommerceCatalogsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceCatalogsCount()

Returns the number of commerce catalogs.

Returns:

the number of commerce catalogs

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

java.lang.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(java.io.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)
java.util.List<CommerceCatalog> search(long companyId)
                                                                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceCatalog> search(long companyId,
                                                                                                          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

searchCommerceCatalogsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCommerceCatalogsCount(long companyId,
                                                                                                   java.lang.String keywords)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceCatalog

@Indexable(type=REINDEX)
CommerceCatalog updateCommerceCatalog(CommerceCatalog commerceCatalog)

Updates the commerce catalog in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

commerceCatalog - the commerce catalog

Returns:

the commerce catalog that was updated

updateCommerceCatalog

@Indexable(type=REINDEX)
CommerceCatalog updateCommerceCatalog(long commerceCatalogId,
                                                               java.lang.String name,
                                                               java.lang.String commerceCurrencyCode,
                                                               java.lang.String catalogDefaultLanguageId)
                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceCatalogExternalReferenceCode

@Indexable(type=REINDEX)
CommerceCatalog updateCommerceCatalogExternalReferenceCode(java.lang.String externalReferenceCode,
                                                                                    long commerceCatalogId)
                                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException