Class CPDefinitionServiceUtil
java.lang.Object
com.liferay.commerce.product.service.CPDefinitionServiceUtil
Provides the remote service utility for CPDefinition. This utility wraps
com.liferay.commerce.product.service.impl.CPDefinitionServiceImpl and is an
access point for service operations in application layer code running on a
remote server. Methods of this service are expected to have security checks
based on the propagated JAAS credentials because this service can be
accessed remotely.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic CPDefinitionaddCPDefinition(String externalReferenceCode, long groupId, long cpTaxCategoryId, boolean accountGroupFilterEnabled, boolean channelFilterEnabled, String ddmStructureKey, String defaultSku, long deliveryMaxSubscriptionCycles, boolean deliverySubscriptionEnabled, int deliverySubscriptionLength, String deliverySubscriptionType, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties, double depth, Map<Locale, String> descriptionMap, int displayDateDay, int displayDateHour, int displayDateMinute, int displayDateMonth, int displayDateYear, int expirationDateDay, int expirationDateHour, int expirationDateMinute, int expirationDateMonth, int expirationDateYear, boolean freeShipping, double height, boolean ignoreSKUCombinations, long maxSubscriptionCycles, Map<Locale, String> metaDescriptionMap, Map<Locale, String> metaKeywordsMap, Map<Locale, String> metaTitleMap, Map<Locale, String> nameMap, boolean neverExpire, String productTypeName, boolean published, boolean shipSeparately, boolean shippable, double shippingExtraPrice, Map<Locale, String> shortDescriptionMap, boolean subscriptionEnabled, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, boolean taxExempt, boolean telcoOrElectronics, Map<Locale, String> urlTitleMap, double weight, double width, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CPDefinitionaddOrUpdateCPDefinition(String externalReferenceCode, long groupId, long cpDefinitionId, long cpTaxCategoryId, boolean accountGroupFilterEnabled, boolean channelFilterEnabled, String ddmStructureKey, String defaultSku, long deliveryMaxSubscriptionCycles, boolean deliverySubscriptionEnabled, int deliverySubscriptionLength, String deliverySubscriptionType, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties, double depth, Map<Locale, String> descriptionMap, int displayDateDay, int displayDateHour, int displayDateMinute, int displayDateMonth, int displayDateYear, int expirationDateDay, int expirationDateHour, int expirationDateMinute, int expirationDateMonth, int expirationDateYear, boolean freeShipping, double height, boolean ignoreSKUCombinations, long maxSubscriptionCycles, Map<Locale, String> metaDescriptionMap, Map<Locale, String> metaKeywordsMap, Map<Locale, String> metaTitleMap, Map<Locale, String> nameMap, boolean neverExpire, String productTypeName, boolean published, boolean shipSeparately, boolean shippable, double shippingExtraPrice, Map<Locale, String> shortDescriptionMap, boolean subscriptionEnabled, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, boolean taxExempt, boolean telcoOrElectronics, Map<Locale, String> urlTitleMap, double weight, double width, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CPDefinitioncloneCPDefinition(long cpDefinitionId, long groupId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CPDefinitioncopyCPDefinition(long sourceCPDefinitionId, long groupId, int status) static voiddeleteAssetCategoryCPDefinition(long cpDefinitionId, long categoryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static voiddeleteCPDefinition(long cpDefinitionId) static CPDefinitionfetchCPDefinition(long cpDefinitionId) static CPDefinitionfetchCPDefinitionByCProductExternalReferenceCode(String externalReferenceCode, long companyId, boolean excludeDraft) static CPDefinitionfetchCPDefinitionByCProductExternalReferenceCode(String externalReferenceCode, long companyId, int status) static CPDefinitionfetchCPDefinitionByCProductId(long cProductId, boolean excludeDraft) static CPDefinitionfetchCPDefinitionByCProductId(long cProductId, int status) static CPDefinitiongetCPDefinition(long cpDefinitionId) static List<CPDefinition> getCPDefinitions(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPDefinition> orderByComparator) static intgetCPDefinitionsCount(long groupId, int status) static CPDefinitiongetCProductCPDefinition(long cProductId, int version) static List<CPDefinition> getCProductCPDefinitions(long cProductId, int status, int start, int end) static CPAttachmentFileEntrygetDefaultImageCPAttachmentFileEntry(long cpDefinitionId) static StringReturns the OSGi service identifier.static CPDefinitionServicegetUrlTitleMap(long cpDefinitionId) static StringgetUrlTitleMapAsXML(long cpDefinitionId) static booleanisVersionable(CPDefinition cpDefinition) static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDefinition> searchCPDefinitions(long companyId, String keywords, int status, boolean ignoreCommerceAccountGroup, int start, int end, com.liferay.portal.kernel.search.Sort sort) static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDefinition> searchCPDefinitions(long companyId, String keywords, String filterFields, String filterValues, int start, int end, com.liferay.portal.kernel.search.Sort sort) static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDefinition> searchCPDefinitionsByChannelGroupId(long companyId, long commerceChannelGroupId, String keywords, int status, boolean ignoreCommerceAccountGroup, int start, int end, com.liferay.portal.kernel.search.Sort sort) static CPDefinitionupdateCPDefinition(long cpDefinitionId, long cpTaxCategoryId, boolean accountGroupFilterEnabled, boolean channelFilterEnabled, String ddmStructureKey, double depth, Map<Locale, String> descriptionMap, int displayDateDay, int displayDateHour, int displayDateMinute, int displayDateMonth, int displayDateYear, int expirationDateDay, int expirationDateHour, int expirationDateMinute, int expirationDateMonth, int expirationDateYear, boolean freeShipping, double height, boolean ignoreSKUCombinations, Map<Locale, String> metaDescriptionMap, Map<Locale, String> metaKeywordsMap, Map<Locale, String> metaTitleMap, Map<Locale, String> nameMap, boolean neverExpire, boolean published, boolean shipSeparately, boolean shippable, double shippingExtraPrice, Map<Locale, String> shortDescriptionMap, boolean taxExempt, boolean telcoOrElectronics, Map<Locale, String> urlTitleMap, double weight, double width, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CPDefinitionupdateCPDefinitionAccountGroupFilter(long cpDefinitionId, boolean enable) static CPDefinitionupdateCPDefinitionCategorization(long cpDefinitionId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CPDefinitionupdateCPDefinitionChannelFilter(long cpDefinitionId, boolean enable) static CPDefinitionupdateExternalReferenceCode(String externalReferenceCode, long cpDefinitionId) static CPDefinitionupdateShippingInfo(long cpDefinitionId, boolean shippable, boolean freeShipping, boolean shipSeparately, double shippingExtraPrice, double width, double height, double depth, double weight, com.liferay.portal.kernel.service.ServiceContext serviceContext) static CPDefinitionupdateStatus(long cpDefinitionId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String, Serializable> workflowContext) static CPDefinitionupdateSubscriptionInfo(long cpDefinitionId, boolean subscriptionEnabled, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, long maxSubscriptionCycles, boolean deliverySubscriptionEnabled, int deliverySubscriptionLength, String deliverySubscriptionType, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties, long deliveryMaxSubscriptionCycles) static CPDefinitionupdateTaxCategoryInfo(long cpDefinitionId, long cpTaxCategoryId, boolean taxExempt, boolean telcoOrElectronics)
-
Constructor Details
-
CPDefinitionServiceUtil
public CPDefinitionServiceUtil()
-
-
Method Details
-
addCPDefinition
public static CPDefinition addCPDefinition(String externalReferenceCode, long groupId, long cpTaxCategoryId, boolean accountGroupFilterEnabled, boolean channelFilterEnabled, String ddmStructureKey, String defaultSku, long deliveryMaxSubscriptionCycles, boolean deliverySubscriptionEnabled, int deliverySubscriptionLength, String deliverySubscriptionType, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties, double depth, Map<Locale, String> descriptionMap, int displayDateDay, int displayDateHour, int displayDateMinute, int displayDateMonth, int displayDateYear, int expirationDateDay, int expirationDateHour, int expirationDateMinute, int expirationDateMonth, int expirationDateYear, boolean freeShipping, double height, boolean ignoreSKUCombinations, long maxSubscriptionCycles, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> metaDescriptionMap, Map<Locale, String> metaKeywordsMap, Map<Locale, String> metaTitleMap, Map<Locale, String> nameMap, boolean neverExpire, String productTypeName, boolean published, boolean shipSeparately, boolean shippable, double shippingExtraPrice, Map<Locale, String> shortDescriptionMap, boolean subscriptionEnabled, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, boolean taxExempt, boolean telcoOrElectronics, Map<Locale, String> urlTitleMap, double weight, double width, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addOrUpdateCPDefinition
public static CPDefinition addOrUpdateCPDefinition(String externalReferenceCode, long groupId, long cpDefinitionId, long cpTaxCategoryId, boolean accountGroupFilterEnabled, boolean channelFilterEnabled, String ddmStructureKey, String defaultSku, long deliveryMaxSubscriptionCycles, boolean deliverySubscriptionEnabled, int deliverySubscriptionLength, String deliverySubscriptionType, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties, double depth, Map<Locale, String> descriptionMap, int displayDateDay, int displayDateHour, int displayDateMinute, int displayDateMonth, int displayDateYear, int expirationDateDay, int expirationDateHour, int expirationDateMinute, int expirationDateMonth, int expirationDateYear, boolean freeShipping, double height, boolean ignoreSKUCombinations, long maxSubscriptionCycles, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> metaDescriptionMap, Map<Locale, String> metaKeywordsMap, Map<Locale, String> metaTitleMap, Map<Locale, String> nameMap, boolean neverExpire, String productTypeName, boolean published, boolean shipSeparately, boolean shippable, double shippingExtraPrice, Map<Locale, String> shortDescriptionMap, boolean subscriptionEnabled, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, boolean taxExempt, boolean telcoOrElectronics, Map<Locale, String> urlTitleMap, double weight, double width, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
cloneCPDefinition
public static CPDefinition cloneCPDefinition(long cpDefinitionId, long groupId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyCPDefinition
public static CPDefinition copyCPDefinition(long sourceCPDefinitionId, long groupId, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteAssetCategoryCPDefinition
public static void deleteAssetCategoryCPDefinition(long cpDefinitionId, long categoryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteCPDefinition
public static void deleteCPDefinition(long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchCPDefinition
public static CPDefinition fetchCPDefinition(long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchCPDefinitionByCProductExternalReferenceCode
public static CPDefinition fetchCPDefinitionByCProductExternalReferenceCode(String externalReferenceCode, long companyId, boolean excludeDraft) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchCPDefinitionByCProductExternalReferenceCode
public static CPDefinition fetchCPDefinitionByCProductExternalReferenceCode(String externalReferenceCode, long companyId, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchCPDefinitionByCProductId
public static CPDefinition fetchCPDefinitionByCProductId(long cProductId, boolean excludeDraft) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchCPDefinitionByCProductId
public static CPDefinition fetchCPDefinitionByCProductId(long cProductId, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCPDefinition
public static CPDefinition getCPDefinition(long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCPDefinitions
public static List<CPDefinition> getCPDefinitions(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPDefinition> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCPDefinitionsCount
public static int getCPDefinitionsCount(long groupId, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCProductCPDefinition
public static CPDefinition getCProductCPDefinition(long cProductId, int version) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCProductCPDefinitions
public static List<CPDefinition> getCProductCPDefinitions(long cProductId, int status, int start, int end) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDefaultImageCPAttachmentFileEntry
public static CPAttachmentFileEntry getDefaultImageCPAttachmentFileEntry(long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getUrlTitleMap
public static Map<Locale,String> getUrlTitleMap(long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getUrlTitleMapAsXML
public static String getUrlTitleMapAsXML(long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
isVersionable
public static boolean isVersionable(CPDefinition cpDefinition) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
searchCPDefinitions
public static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDefinition> searchCPDefinitions(long companyId, String keywords, int status, boolean ignoreCommerceAccountGroup, 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
-
searchCPDefinitions
public static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDefinition> searchCPDefinitions(long companyId, String keywords, String filterFields, String filterValues, 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
-
searchCPDefinitionsByChannelGroupId
public static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDefinition> searchCPDefinitionsByChannelGroupId(long companyId, long commerceChannelGroupId, String keywords, int status, boolean ignoreCommerceAccountGroup, 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
-
updateCPDefinition
public static CPDefinition updateCPDefinition(long cpDefinitionId, long cpTaxCategoryId, boolean accountGroupFilterEnabled, boolean channelFilterEnabled, String ddmStructureKey, double depth, Map<Locale, String> descriptionMap, int displayDateDay, int displayDateHour, int displayDateMinute, int displayDateMonth, int displayDateYear, int expirationDateDay, int expirationDateHour, int expirationDateMinute, int expirationDateMonth, int expirationDateYear, boolean freeShipping, double height, boolean ignoreSKUCombinations, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> metaDescriptionMap, Map<Locale, String> metaKeywordsMap, Map<Locale, String> metaTitleMap, Map<Locale, String> nameMap, boolean neverExpire, boolean published, boolean shipSeparately, boolean shippable, double shippingExtraPrice, Map<Locale, String> shortDescriptionMap, boolean taxExempt, boolean telcoOrElectronics, Map<Locale, String> urlTitleMap, double weight, double width, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateCPDefinitionAccountGroupFilter
public static CPDefinition updateCPDefinitionAccountGroupFilter(long cpDefinitionId, boolean enable) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateCPDefinitionCategorization
public static CPDefinition updateCPDefinitionCategorization(long cpDefinitionId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateCPDefinitionChannelFilter
public static CPDefinition updateCPDefinitionChannelFilter(long cpDefinitionId, boolean enable) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateExternalReferenceCode
public static CPDefinition updateExternalReferenceCode(String externalReferenceCode, long cpDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateShippingInfo
public static CPDefinition updateShippingInfo(long cpDefinitionId, boolean shippable, boolean freeShipping, boolean shipSeparately, double shippingExtraPrice, double width, double height, double depth, double weight, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStatus
public static CPDefinition updateStatus(long cpDefinitionId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateSubscriptionInfo
public static CPDefinition updateSubscriptionInfo(long cpDefinitionId, boolean subscriptionEnabled, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, long maxSubscriptionCycles, boolean deliverySubscriptionEnabled, int deliverySubscriptionLength, String deliverySubscriptionType, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties, long deliveryMaxSubscriptionCycles) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateTaxCategoryInfo
public static CPDefinition updateTaxCategoryInfo(long cpDefinitionId, long cpTaxCategoryId, boolean taxExempt, boolean telcoOrElectronics) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-