Class CommerceCatalogLocalServiceUtil
com.liferay.commerce.product.service.impl.CommerceCatalogLocalServiceImpl 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 CommerceCatalogaddCommerceCatalog(CommerceCatalog commerceCatalog) Adds the commerce catalog to the database.static CommerceCatalogaddCommerceCatalog(String externalReferenceCode, long accountEntryId, String name, String commerceCurrencyCode, String catalogDefaultLanguageId, boolean system, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CommerceCatalogaddCommerceCatalog(String externalReferenceCode, String name, String commerceCurrencyCode, String catalogDefaultLanguageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CommerceCatalogaddDefaultCommerceCatalog(long companyId) static CommerceCatalogcreateCommerceCatalog(long commerceCatalogId) Creates a new commerce catalog with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static CommerceCatalogdeleteCommerceCatalog(long commerceCatalogId) Deletes the commerce catalog with the primary key from the database.static CommerceCatalogdeleteCommerceCatalog(CommerceCatalog commerceCatalog) Deletes the commerce catalog from the database.static voiddeleteCommerceCatalogs(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 CommerceCatalogfetchCommerceCatalog(long commerceCatalogId) static CommerceCatalogfetchCommerceCatalogByExternalReferenceCode(String externalReferenceCode, long companyId) static CommerceCatalogfetchCommerceCatalogByGroupId(long groupId) static CommerceCatalogfetchCommerceCatalogByUuidAndCompanyId(String uuid, long companyId) Returns the commerce catalog with the matching UUID and company.static CommerceCatalogforceDeleteCommerceCatalog(CommerceCatalog commerceCatalog) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic CommerceCataloggetCommerceCatalog(long commerceCatalogId) Returns the commerce catalog with the primary key.static CommerceCataloggetCommerceCatalogByExternalReferenceCode(String externalReferenceCode, long companyId) static CommerceCataloggetCommerceCatalogByUuidAndCompanyId(String uuid, long companyId) Returns the commerce catalog with the matching UUID and company.static com.liferay.portal.kernel.model.GroupgetCommerceCatalogGroup(long commerceCatalogId) static List<CommerceCatalog>getCommerceCatalogs(int start, int end) Returns a range of all the commerce catalogs.static List<CommerceCatalog>getCommerceCatalogs(long companyId) static List<CommerceCatalog>getCommerceCatalogs(long companyId, boolean system) static List<CommerceCatalog>getCommerceCatalogsByAccountEntryId(long accountEntryId) static intReturns the number of commerce catalogs.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 CommerceCatalogLocalServicestatic List<CommerceCatalog>search(long companyId) static List<CommerceCatalog>search(long companyId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) static intsearchCommerceCatalogsCount(long companyId, String keywords) static CommerceCatalogupdateCommerceCatalog(long commerceCatalogId, long accountEntryId, String name, String commerceCurrencyCode, String catalogDefaultLanguageId) static CommerceCatalogupdateCommerceCatalog(CommerceCatalog commerceCatalog) Updates the commerce catalog in the database or adds it if it does not yet exist.static CommerceCatalogupdateCommerceCatalogExternalReferenceCode(String externalReferenceCode, long commerceCatalogId)
-
Constructor Details
-
CommerceCatalogLocalServiceUtil
public CommerceCatalogLocalServiceUtil()
-
-
Method Details
-
addCommerceCatalog
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
public static CommerceCatalog addCommerceCatalog(String externalReferenceCode, long accountEntryId, String name, String commerceCurrencyCode, 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
public static CommerceCatalog addCommerceCatalog(String externalReferenceCode, String name, String commerceCurrencyCode, String catalogDefaultLanguageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addDefaultCommerceCatalog
public static CommerceCatalog addDefaultCommerceCatalog(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createCommerceCatalog
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
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
-
deleteCommerceCatalog
public static 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
public static 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
public static void deleteCommerceCatalogs(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.CommerceCatalogModelImpl.- 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.CommerceCatalogModelImpl.- 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
-
fetchCommerceCatalog
-
fetchCommerceCatalogByExternalReferenceCode
public static CommerceCatalog fetchCommerceCatalogByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchCommerceCatalogByGroupId
-
fetchCommerceCatalogByUuidAndCompanyId
Returns the commerce catalog with the matching UUID and company.- Parameters:
uuid- the commerce catalog's UUIDcompanyId- the primary key of the company- Returns:
- the matching commerce catalog, or
nullif a matching commerce catalog could not be found
-
forceDeleteCommerceCatalog
public static CommerceCatalog forceDeleteCommerceCatalog(CommerceCatalog commerceCatalog) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getCommerceCatalog
public static 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
public static CommerceCatalog getCommerceCatalogByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCommerceCatalogByUuidAndCompanyId
public static CommerceCatalog getCommerceCatalogByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the commerce catalog with the matching UUID and company.- Parameters:
uuid- the commerce catalog's UUIDcompanyId- the primary key of the company- Returns:
- the matching commerce catalog
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a matching commerce catalog could not be found
-
getCommerceCatalogGroup
public static com.liferay.portal.kernel.model.Group getCommerceCatalogGroup(long commerceCatalogId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCommerceCatalogs
Returns a range of all the commerce catalogs.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.CommerceCatalogModelImpl.- Parameters:
start- the lower bound of the range of commerce catalogsend- the upper bound of the range of commerce catalogs (not inclusive)- Returns:
- the range of commerce catalogs
-
getCommerceCatalogs
-
getCommerceCatalogs
-
getCommerceCatalogsByAccountEntryId
-
getCommerceCatalogsCount
public static int getCommerceCatalogsCount()Returns the number of commerce catalogs.- Returns:
- the number of commerce catalogs
-
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
-
search
public static List<CommerceCatalog> search(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public static List<CommerceCatalog> search(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
-
searchCommerceCatalogsCount
public static int searchCommerceCatalogsCount(long companyId, String keywords) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateCommerceCatalog
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
public static CommerceCatalog updateCommerceCatalog(long commerceCatalogId, long accountEntryId, String name, String commerceCurrencyCode, String catalogDefaultLanguageId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateCommerceCatalogExternalReferenceCode
public static CommerceCatalog updateCommerceCatalogExternalReferenceCode(String externalReferenceCode, long commerceCatalogId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-