public class ClaimableTools extends GenericService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLAIMED
claimed option from the item property named by DEFAULT_STATUS_PROPERTY_NAME
|
static java.lang.String |
CLASS_VERSION |
static java.lang.String |
DEFAULT_CLAIMABLE_ITEM_DESCRIPTOR
Default name of the base claimable item descriptor.
|
static java.lang.String |
DEFAULT_COUPON_FOLDER_ITEM_DESCRIPTOR_NAME
Default name of the coupon folder item descriptor.
|
static java.lang.String |
DEFAULT_STATUS_PROPERTY_NAME
Default name of the property of the item descriptor that
signals the status of the claimable object.
|
protected PricingTools |
mPricingTools |
protected static java.util.ResourceBundle |
sResourceBundle
Resource Bundle
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ClaimableTools()
Empty constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
adjustStatus(RepositoryItem[] pClaimableItems,
java.lang.String pStatus)
Change the status of a claimable repository item so that its status
reflects the appropriate status.
|
protected void |
adjustStatus(RepositoryItem pClaimableItem,
java.lang.String pStatus)
Change the status of a claimable repository item so that its status
reflects the appropriate status.
|
RepositoryItem |
createClaimableItem(java.lang.String pItemDescriptorType)
Create a new repository item in the claimable repository using
the given item descriptor type and allowing the repository to
generate a default repository id for the item.
|
RepositoryItem |
createClaimableItem(java.lang.String pId,
java.lang.String pItemDescriptorType)
Create a new repository item in the claimable repository with the
specified id, using the given item descriptor type.
|
RepositoryItem |
createClaimableItem(java.lang.String pId,
java.lang.String pItemDescriptorType,
boolean pTransient)
Create a new repository item in the claimable repository with the
specified id, using the given item descriptor type.
|
RepositoryItem |
createCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
This method creates a coupon repository item (i.e.
|
RepositoryItem |
createCouponFolder(java.util.Map<java.lang.String,java.lang.String> pCouponFolderPropertyValues)
This method creates a coupon folder repository item and sets its properties to the
values specified in the map parameter.
|
RepositoryItem |
createCouponFolderFromPath(java.lang.String pCouponFolderPath)
This method creates a series of coupon folders, from the path provided.
|
void |
deleteCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
This method deletes a coupon from the claimable repository.
|
void |
deleteCoupon(java.lang.String pCouponId)
Deprecated.
as of 10.2; use
(Map which handles
different types of claimables (as opposed to just PromotionClaimable) |
RepositoryItem |
getClaimableItem(java.lang.String pId)
Return the repository item from the claimable repository whose id is equal
to pId.
|
java.lang.String |
getClaimableItemDescriptorName()
Get the claimableItemDescriptorName property.
|
RepositoryItem[] |
getClaimableItems(java.lang.String[] pIds)
Return the RepositoryItems from the claimable repository whose ids are equal
to the members of pIds.
|
Repository |
getClaimableRepository()
Get the claimableRepository property.
|
RepositoryItem |
getCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
This method retrieves a coupon repository item using the specified id.
|
RepositoryItem |
getCoupon(java.lang.String pCouponId)
Deprecated.
as of 10.2; use
(Map which handles
different types of claimables (as opposed to just PromotionClaimable) |
RepositoryItem |
getCouponFolder(java.lang.String pCouponFolderId)
This method retrieves a coupon folder repository item using the specified id.
|
java.lang.String |
getCouponFolderItemDescriptorName()
Get the coupon folder item descriptor name.
|
java.lang.String |
getCouponFolderNameProperty()
Get the coupon folder name property.
|
java.lang.String |
getCouponFolderParentFolderProperty()
Get the coupon folder parent folder property.
|
java.lang.String |
getCouponFolderPath(java.lang.String pCouponFolderId)
This method retrieves the coupon folder's full path.
|
java.lang.String |
getCouponItemDescriptorName()
Get the CouponItemDescriptorName property.
|
RepositoryItem[] |
getCouponsForPromotion(java.lang.String pPromotionId)
This method retrieves of all of the coupons associated with a particular promotion.
|
java.lang.String |
getDefaultTypeCode()
Get the default type code.
|
java.lang.String |
getDisplayNamePropertyName()
Get the DisplayNamePropertyName property.
|
java.lang.String |
getExpirePropertyName()
Get the ExpirePropertyName property.
|
java.lang.String |
getGiftCertificateAmountAuthorizedPropertyName()
Get the property giftCertificateAmountAuthorizedPropertyName
|
java.lang.String |
getGiftCertificateAmountAvailablePropertyName()
Get the giftCertificateAmountAvailablePropertyName property.
|
java.lang.String |
getGiftCertificateAmountPropertyName()
Get the giftCertificateAmountPropertyName property.
|
java.lang.String |
getGiftCertificateAmountRemainingPropertyName()
Get the giftCertificateAmountRemainingPropertyName property.
|
java.lang.String |
getGiftCertificateItemDescriptorName()
Get the giftCertificateItemDescriptorName property.
|
java.lang.String |
getGiftCertificateLastUsedPropertyName()
Get the giftCertificateLastUsedPropertyName property.
|
java.lang.String |
getGiftCertificatePurchaseDatePropertyName()
Get the giftCertificatePurchaseDatePropertyName property.
|
java.lang.String |
getGiftCertificatePurchaserIdPropertyName()
Get the giftCertificatePurchaserIdPropertyName property.
|
java.lang.String |
getIdPropertyName()
Get the id property name
|
java.lang.String |
getItemDescriptorName(java.lang.Integer pType)
Helper method that returns an item descriptor name based on its type code.
|
java.lang.String |
getItemDescriptorName(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
Helper method that returns an item descriptor name based on its type code.
|
java.lang.String |
getLastModifiedPropertyName()
Returns property lastModifiedPropertyName
|
java.lang.String |
getMaxUsesPropertyName()
Get the max uses property name.
|
java.lang.String |
getParentFolderProperty()
Get the coupon parent folder property.
|
java.lang.String |
getParentFolderPropertyName()
Returns property parentFolderPropertyName
|
PricingTools |
getPricingTools() |
java.lang.String |
getPromotionPropertyName()
Get the PromotionPropertyName property.
|
java.lang.String |
getPromotionsPropertyName()
Get the PromotionsPropertyName property.
|
java.lang.String |
getRedeemableOnPromotionSitesPropertyName()
Get the RedeemableOnPromotionSitesPropertyName property.
|
double |
getRemainingAmount(RepositoryItem pClaimable)
This method returns the remaining amount for the Store Credit and Gift Certificate.
This method supports only store credit and gift certificates. |
java.lang.String |
getStartDatePropertyName()
Get the start date property name
|
java.lang.String |
getStatusPropertyName()
Get the statusPropertyName property.
|
java.lang.String |
getStoreCreditAmountAuthorizedPropertyName()
Get the property storeCreditAmountAuthorizedPropertyName
|
java.lang.String |
getStoreCreditAmountAvailablePropertyName()
Returns property storeCreditAmountAvailablePropertyName
|
java.lang.String |
getStoreCreditAmountPropertyName()
Get the property storeCreditAmountPropertyName
|
java.lang.String |
getStoreCreditAmountRemainingPropertyName()
Get the property storeCreditAmountRemainingPropertyName
|
java.lang.String |
getStoreCreditExpirationDatePropertyName()
Returns property storeCreditExpirationDatePropertyName
|
java.lang.String |
getStoreCreditIssueDatePropertyName()
Returns property storeCreditIssueDatePropertyName
|
java.lang.String |
getStoreCreditItemDescriptorName()
Get the property storeCreditItemDescriptorName
|
java.lang.String |
getStoreCreditLastUsedPropertyName()
Returns property storeCreditLastUsedPropertyName
|
java.lang.String |
getStoreCreditOwnerIdPropertyName()
Returns property storeCreditOwnerIdPropertyName
|
boolean |
getStrictAuthorization()
Returns property strictAuthorization
This is true by default.
|
javax.transaction.TransactionManager |
getTransactionManager()
Gets the transactionManager.
|
java.util.Properties |
getTypeCodeToItemDescriptorMap()
Get the typeCodeToItemDescriptorMap property.
|
java.lang.String |
getTypePropertyName()
Get the typePropertyName property.
|
java.lang.String |
getUsesPropertyName()
Get the uses property name.
|
boolean |
isCaseInsensitiveClaimableIds()
Get the CaseInsensitiveClaimableIds property.
|
void |
persistTransientClaimableItem(RepositoryItem pClaimableItem)
This method persist the claimable item into the repository.
|
java.util.List<CouponImportExportInfo> |
processCoupons(RepositoryItem[] pCoupons)
This method processes an array of coupon repository items to get the property values.
|
void |
setCaseInsensitiveClaimableIds(boolean pCaseInsensitiveClaimableIds)
Set the caseInsensitiveClaimableIds property.
|
void |
setClaimableItemDescriptorName(java.lang.String pClaimableItemDescriptorName)
Set the claimableItemDescriptorName property.
|
void |
setClaimableRepository(Repository pClaimableRepository)
Set the claimableRepository property.
|
void |
setCouponFolderItemDescriptorName(java.lang.String pCouponFolderItemDescriptorName)
Set the coupon folder item descriptor name.
|
void |
setCouponFolderNameProperty(java.lang.String pCouponFolderNameProperty)
Set the coupon folder name property.
|
void |
setCouponFolderParentFolderProperty(java.lang.String pCouponFolderParentFolderProperty)
Set the coupon folder parent folder property.
|
void |
setCouponItemDescriptorName(java.lang.String pCouponItemDescriptorName)
Set the CouponItemDescriptorName property.
|
void |
setDefaultTypeCode(java.lang.String pDefaultTypeCode)
Set default type code Property name
|
void |
setDisplayNamePropertyName(java.lang.String pDisplayNamePropertyName)
Set the DisplayNamePropertyName property.
|
void |
setExpirePropertyName(java.lang.String pExpirePropertyName)
Set the ExpirePropertyName property.
|
void |
setGiftCertificateAmountAuthorizedPropertyName(java.lang.String pGiftCertificateAmountAuthorizedPropertyName)
Sets property giftCertificateAmountAuthorizedPropertyName
|
void |
setGiftCertificateAmountAvailablePropertyName(java.lang.String pGiftCertificateAmountAvailablePropertyName)
Set the giftCertificateAmountAvailablePropertyName property.
|
void |
setGiftCertificateAmountPropertyName(java.lang.String pGiftCertificateAmountPropertyName)
Set the giftCertificateAmountPropertyName property.
|
void |
setGiftCertificateAmountRemainingPropertyName(java.lang.String pGiftCertificateAmountRemainingPropertyName)
Set the giftCertificateAmountRemainingPropertyName property.
|
void |
setGiftCertificateItemDescriptorName(java.lang.String pGiftCertificateItemDescriptorName)
Set the giftCertificateItemDescriptorName property.
|
void |
setGiftCertificateLastUsedPropertyName(java.lang.String pGiftCertificateLastUsedPropertyName)
Set the giftCertificateLastUsedPropertyName property.
|
void |
setGiftCertificatePurchaseDatePropertyName(java.lang.String pGiftCertificatePurchaseDatePropertyName)
Set the giftCertificatePurchaseDatePropertyName property.
|
void |
setGiftCertificatePurchaserIdPropertyName(java.lang.String pGiftCertificatePurchaserIdPropertyName)
Set the giftCertificatePurchaserIdPropertyName property.
|
void |
setIdPropertyName(java.lang.String pIdPropertyName)
Set the id property name
|
void |
setLastModifiedPropertyName(java.lang.String pLastModifiedPropertyName)
Sets property lastModifiedPropertyName
|
void |
setMaxUsesPropertyName(java.lang.String pMaxUsesPropertyName)
Set max uses Property name
|
void |
setParentFolderProperty(java.lang.String pParentFolderProperty)
Set the coupon parent folder property.
|
void |
setParentFolderPropertyName(java.lang.String pParentFolderPropertyName)
Sets property parentFolderPropertyName
|
void |
setPricingTools(PricingTools pPricingTools) |
void |
setPromotionPropertyName(java.lang.String pPromotionPropertyName)
Set the PromotionPropertyName property.
|
void |
setPromotionsPropertyName(java.lang.String pPromotionsPropertyName)
Set the PromotionsPropertyName property.
|
void |
setRedeemableOnPromotionSitesPropertyName(java.lang.String pRedeemableOnPromotionSitesPropertyName)
Set the RedeemableOnPromotionSitesPropertyName property.
|
void |
setStartDatePropertyName(java.lang.String pStartDatePropertyName)
Set the start date property name
|
void |
setStatusPropertyName(java.lang.String pStatusPropertyName)
Set the statusPropertyName property.
|
void |
setStoreCreditAmountAuthorizedPropertyName(java.lang.String pStoreCreditAmountAuthorizedPropertyName)
Sets property storeCreditAmountAuthorizedPropertyName
|
void |
setStoreCreditAmountAvailablePropertyName(java.lang.String pStoreCreditAmountAvailablePropertyName)
Sets property storeCreditAmountAvailablePropertyName
|
void |
setStoreCreditAmountPropertyName(java.lang.String pStoreCreditAmountPropertyName)
Sets property storeCreditAmountPropertyName
|
void |
setStoreCreditAmountRemainingPropertyName(java.lang.String pStoreCreditAmountRemainingPropertyName)
Sets property storeCreditAmountRemainingPropertyName
|
void |
setStoreCreditExpirationDatePropertyName(java.lang.String pStoreCreditExpirationDatePropertyName)
Sets property storeCreditExpirationDatePropertyName
|
void |
setStoreCreditIssueDatePropertyName(java.lang.String pStoreCreditIssueDatePropertyName)
Sets property storeCreditIssueDatePropertyName
|
void |
setStoreCreditItemDescriptorName(java.lang.String pStoreCreditItemDescriptorName)
Sets property storeCreditItemDescriptorName
|
void |
setStoreCreditLastUsedPropertyName(java.lang.String pStoreCreditLastUsedPropertyName)
Sets property storeCreditLastUsedPropertyName
|
void |
setStoreCreditOwnerIdPropertyName(java.lang.String pStoreCreditOwnerIdPropertyName)
Sets property storeCreditOwnerIdPropertyName
|
void |
setStrictAuthorization(boolean pStrictAuthorization)
Sets property strictAuthorization
|
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Sets the transactionManager.
|
void |
setTypeCodeToItemDescriptorMap(java.util.Properties pTypeCodeToItemDescriptorMap)
Set the typeCodeToItemDescriptorMap property.
|
void |
setTypePropertyName(java.lang.String pTypePropertyName)
Set the typePropertyName property.
|
void |
setUsesPropertyName(java.lang.String pUsesPropertyName)
Set uses Property name
|
RepositoryItem |
updateCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
This method updates a coupon repository item, setting its properties to the
values specified in the map parameter.
|
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
protected static java.util.ResourceBundle sResourceBundle
public static final java.lang.String CLAIMED
public static final java.lang.String DEFAULT_CLAIMABLE_ITEM_DESCRIPTOR
public static final java.lang.String DEFAULT_STATUS_PROPERTY_NAME
public static final java.lang.String DEFAULT_COUPON_FOLDER_ITEM_DESCRIPTOR_NAME
protected PricingTools mPricingTools
public PricingTools getPricingTools()
public void setPricingTools(PricingTools pPricingTools)
public void setPromotionPropertyName(java.lang.String pPromotionPropertyName)
pPromotionPropertyName
- the PromotionPropertyName property.public java.lang.String getPromotionPropertyName()
public void setCaseInsensitiveClaimableIds(boolean pCaseInsensitiveClaimableIds)
pCaseInsensitiveClaimableIds
- the caseInsensitiveClaimableIds property.public boolean isCaseInsensitiveClaimableIds()
public void setRedeemableOnPromotionSitesPropertyName(java.lang.String pRedeemableOnPromotionSitesPropertyName)
pRedeemableOnPromotionSitesPropertyName
- the RedeemableOnPromotionSitesPropertyName property.public java.lang.String getRedeemableOnPromotionSitesPropertyName()
public void setPromotionsPropertyName(java.lang.String pPromotionsPropertyName)
pPromotionsPropertyName
- the PromotionsPropertyName property.public java.lang.String getPromotionsPropertyName()
public void setGiftCertificateLastUsedPropertyName(java.lang.String pGiftCertificateLastUsedPropertyName)
pGiftCertificateLastUsedPropertyName
- the giftCertificateLastUsedPropertyName property.public java.lang.String getGiftCertificateLastUsedPropertyName()
public void setCouponItemDescriptorName(java.lang.String pCouponItemDescriptorName)
pCouponItemDescriptorName
- the CouponItemDescriptorName property.public java.lang.String getCouponItemDescriptorName()
public void setGiftCertificateItemDescriptorName(java.lang.String pGiftCertificateItemDescriptorName)
pGiftCertificateItemDescriptorName
- the giftCertificateItemDescriptorName property.public java.lang.String getGiftCertificateItemDescriptorName()
public void setGiftCertificateAmountPropertyName(java.lang.String pGiftCertificateAmountPropertyName)
pGiftCertificateAmountPropertyName
- the giftCertificateAmountPropertyName property.public java.lang.String getGiftCertificateAmountPropertyName()
public void setDisplayNamePropertyName(java.lang.String pDisplayNamePropertyName)
pDisplayNamePropertyName
- the DisplayNamePropertyName property.public java.lang.String getDisplayNamePropertyName()
public void setGiftCertificateAmountRemainingPropertyName(java.lang.String pGiftCertificateAmountRemainingPropertyName)
pGiftCertificateAmountRemainingPropertyName
- the giftCertificateAmountRemainingPropertyName property.public java.lang.String getGiftCertificateAmountRemainingPropertyName()
public void setGiftCertificateAmountAvailablePropertyName(java.lang.String pGiftCertificateAmountAvailablePropertyName)
pGiftCertificateAmountAvailablePropertyName
- the giftCertificateAmountAvailablePropertyName property.public java.lang.String getGiftCertificateAmountAvailablePropertyName()
public void setExpirePropertyName(java.lang.String pExpirePropertyName)
pExpirePropertyName
- public java.lang.String getExpirePropertyName()
public java.lang.String getStartDatePropertyName()
public void setStartDatePropertyName(java.lang.String pStartDatePropertyName)
pStartDatePropertyName
- public void setGiftCertificateAmountAuthorizedPropertyName(java.lang.String pGiftCertificateAmountAuthorizedPropertyName)
pGiftCertificateAmountAuthorizedPropertyName
- the value to set for property giftCertificateAmountAuthorizedPropertyNamepublic java.lang.String getGiftCertificateAmountAuthorizedPropertyName()
public void setGiftCertificatePurchaserIdPropertyName(java.lang.String pGiftCertificatePurchaserIdPropertyName)
pGiftCertificatePurchaserIdPropertyName
- the giftCertificatePurchaserIdPropertyName property.public java.lang.String getGiftCertificatePurchaserIdPropertyName()
public void setGiftCertificatePurchaseDatePropertyName(java.lang.String pGiftCertificatePurchaseDatePropertyName)
pGiftCertificatePurchaseDatePropertyName
- the giftCertificatePurchaseDatePropertyName property.public java.lang.String getGiftCertificatePurchaseDatePropertyName()
public void setTypePropertyName(java.lang.String pTypePropertyName)
pTypePropertyName
- the typePropertyName property.public java.lang.String getTypePropertyName()
public void setClaimableRepository(Repository pClaimableRepository)
pClaimableRepository
- the claimableRepository property.public Repository getClaimableRepository()
public void setStatusPropertyName(java.lang.String pStatusPropertyName)
pStatusPropertyName
- the statusPropertyName property.public java.lang.String getStatusPropertyName()
public void setClaimableItemDescriptorName(java.lang.String pClaimableItemDescriptorName)
pClaimableItemDescriptorName
- the claimableItemDescriptorName property.public java.lang.String getClaimableItemDescriptorName()
public java.lang.String getStoreCreditItemDescriptorName()
public void setStoreCreditItemDescriptorName(java.lang.String pStoreCreditItemDescriptorName)
pStoreCreditItemDescriptorName
- the value to set for property storeCreditItemDescriptorNamepublic java.lang.String getStoreCreditAmountPropertyName()
public void setStoreCreditAmountPropertyName(java.lang.String pStoreCreditAmountPropertyName)
pStoreCreditAmountPropertyName
- the value to set for property storeCreditAmountPropertyNamepublic java.lang.String getStoreCreditAmountAuthorizedPropertyName()
public void setStoreCreditAmountAuthorizedPropertyName(java.lang.String pStoreCreditAmountAuthorizedPropertyName)
pStoreCreditAmountAuthorizedPropertyName
- the value to set for property storeCreditAmountAuthorizedPropertyNamepublic java.lang.String getStoreCreditAmountRemainingPropertyName()
public void setStoreCreditAmountRemainingPropertyName(java.lang.String pStoreCreditAmountRemainingPropertyName)
pStoreCreditAmountRemainingPropertyName
- the value to set for property storeCreditAmountRemainingPropertyNamepublic java.lang.String getStoreCreditAmountAvailablePropertyName()
public void setStoreCreditAmountAvailablePropertyName(java.lang.String pStoreCreditAmountAvailablePropertyName)
pStoreCreditAmountAvailablePropertyName
- the value to set for property storeCreditAmountAvailablePropertyNamepublic java.lang.String getStoreCreditOwnerIdPropertyName()
public void setStoreCreditOwnerIdPropertyName(java.lang.String pStoreCreditOwnerIdPropertyName)
pStoreCreditOwnerIdPropertyName
- the value to set for property storeCreditOwnerIdPropertyNamepublic java.lang.String getStoreCreditLastUsedPropertyName()
public void setStoreCreditLastUsedPropertyName(java.lang.String pStoreCreditLastUsedPropertyName)
pStoreCreditLastUsedPropertyName
- the value to set for property storeCreditLastUsedPropertyNamepublic java.lang.String getStoreCreditIssueDatePropertyName()
public void setStoreCreditIssueDatePropertyName(java.lang.String pStoreCreditIssueDatePropertyName)
pStoreCreditIssueDatePropertyName
- the value to set for property storeCreditIssueDatePropertyNamepublic java.lang.String getStoreCreditExpirationDatePropertyName()
public void setStoreCreditExpirationDatePropertyName(java.lang.String pStoreCreditExpirationDatePropertyName)
pStoreCreditExpirationDatePropertyName
- the value to set for property storeCreditExpirationDatePropertyNamepublic java.lang.String getParentFolderPropertyName()
public void setParentFolderPropertyName(java.lang.String pParentFolderPropertyName)
pParentFolderPropertyName
- the value to set for property parentFolderPropertyNamepublic java.lang.String getLastModifiedPropertyName()
public void setLastModifiedPropertyName(java.lang.String pLastModifiedPropertyName)
pLastModifiedPropertyName
- the value to set for property lastModifiedPropertyNamepublic boolean getStrictAuthorization()
public void setStrictAuthorization(boolean pStrictAuthorization)
pStrictAuthorization
- the value to set for property strictAuthorizationpublic javax.transaction.TransactionManager getTransactionManager()
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
pTransactionManager
- the transactionManager.public java.lang.String getParentFolderProperty()
public void setParentFolderProperty(java.lang.String pParentFolderProperty)
pParentFolderProperty
- the coupon parent folder property.public java.lang.String getCouponFolderItemDescriptorName()
public void setCouponFolderItemDescriptorName(java.lang.String pCouponFolderItemDescriptorName)
pCouponFolderItemDescriptorName
- the coupon folder item descriptor name.public java.lang.String getCouponFolderNameProperty()
public void setCouponFolderNameProperty(java.lang.String pCouponFolderNameProperty)
pCouponFolderNameProperty
- the coupon folder name property.public java.lang.String getCouponFolderParentFolderProperty()
public void setCouponFolderParentFolderProperty(java.lang.String pCouponFolderParentFolderProperty)
pCouponFolderParentFolderProperty
- the coupon folder parent folder property.public java.lang.String getIdPropertyName()
public void setIdPropertyName(java.lang.String pIdPropertyName)
pIdPropertyName
- the id property namepublic java.lang.String getUsesPropertyName()
public void setUsesPropertyName(java.lang.String pUsesPropertyName)
public java.lang.String getMaxUsesPropertyName()
public void setMaxUsesPropertyName(java.lang.String pMaxUsesPropertyName)
public java.util.Properties getTypeCodeToItemDescriptorMap()
public void setTypeCodeToItemDescriptorMap(java.util.Properties pTypeCodeToItemDescriptorMap)
public java.lang.String getDefaultTypeCode()
public void setDefaultTypeCode(java.lang.String pDefaultTypeCode)
public RepositoryItem getClaimableItem(java.lang.String pId) throws RepositoryException
pId
- the repository ID of the item to be claimedRepositoryException
public RepositoryItem[] getClaimableItems(java.lang.String[] pIds) throws RepositoryException
pIds
- the String repository IDs of the item to be claimedRepositoryException
ClaimableTools#getRepositoryItem
protected void adjustStatus(RepositoryItem pClaimableItem, java.lang.String pStatus) throws PropertyNotFoundException, RepositoryException
pClaimableItem
- the RepositoryItem whose status should be changedpStatus
- the new statusPropertyNotFoundException
RepositoryException
protected void adjustStatus(RepositoryItem[] pClaimableItems, java.lang.String pStatus) throws PropertyNotFoundException, RepositoryException
pClaimableItems
- the RepositoryItems whose status should be changedpStatus
- the new statusPropertyNotFoundException
RepositoryException
public RepositoryItem createClaimableItem(java.lang.String pItemDescriptorType) throws ClaimableException
pItemDescriptorType
- The name of the item descriptor type for the new claimable.ClaimableException
- if the repository throws any exception during item creation.
The ClaimableException will wrap the underlying RepositoryException.public RepositoryItem createClaimableItem(java.lang.String pId, java.lang.String pItemDescriptorType, boolean pTransient) throws ClaimableException
pId
- The repository id of the new item, which must be unique or null.
A null id indicates that the claimable repository should generate
its own unique id. If a non-null id is supplied and is not unique,
a ClaimableException will be thrown that wraps the DuplicateIdException
generated by the claimable repository.pItemDescriptorType
- The name of the item descriptor type for the new claimable.pTransient
- If the claimable does not need to be persisted right away, use this option.ClaimableException
- if the repository throws any exception during item creation.
The ClaimableException will wrap the underlying RepositoryException.public RepositoryItem createClaimableItem(java.lang.String pId, java.lang.String pItemDescriptorType) throws ClaimableException
pId
- The repository id of the new item, which must be unique or null.
A null id indicates that the claimable repository should generate
its own unique id. If a non-null id is supplied and is not unique,
a ClaimableException will be thrown that wraps the DuplicateIdException
generated by the claimable repository.pItemDescriptorType
- The name of the item descriptor type for the new claimable.ClaimableException
- if the repository throws any exception during item creation.
The ClaimableException will wrap the underlying RepositoryException.public void persistTransientClaimableItem(RepositoryItem pClaimableItem) throws ClaimableException
pClaimableItem
- ClaimableException
public RepositoryItem createCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues) throws ClaimableException
pCouponPropertyValues
- - a map of the coupon property names and their values.ClaimableException
@Deprecated public RepositoryItem getCoupon(java.lang.String pCouponId) throws ClaimableException
(Map pCouponPropertyValues)
which handles
different types of claimables (as opposed to just PromotionClaimable)pCouponId
- - the id of the coupon repository item to retrieve.ClaimableException
public RepositoryItem getCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues) throws ClaimableException
pCouponPropertyValues
- - a map of the property names and their values.ClaimableException
public RepositoryItem updateCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues) throws ClaimableException
pCouponPropertyValues
- - a map of the property names and their values.ClaimableException
public RepositoryItem[] getCouponsForPromotion(java.lang.String pPromotionId) throws ClaimableException
pPromotionId
- - the id of the promotion.ClaimableException
@Deprecated public void deleteCoupon(java.lang.String pCouponId) throws ClaimableException
(Map pCouponPropertyValues)
which handles
different types of claimables (as opposed to just PromotionClaimable)pCouponId
- - the id of the coupon to be deleted.ClaimableException
public void deleteCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues) throws ClaimableException
pCouponPropertyValues
- - a map of the coupon property names and their values.ClaimableException
public RepositoryItem createCouponFolderFromPath(java.lang.String pCouponFolderPath) throws ClaimableException
pCouponFolderpath
- - the full path of the coupon folder.ClaimableException
public java.lang.String getCouponFolderPath(java.lang.String pCouponFolderId) throws ClaimableException
pCouponFolderId
- - the id of the couponFolder item, for which the path is to be constructed.ClaimableException
public RepositoryItem createCouponFolder(java.util.Map<java.lang.String,java.lang.String> pCouponFolderPropertyValues) throws ClaimableException
pCouponFolderPropertyValues
- - a map of the coupon folder property names and their values.ClaimableException
public RepositoryItem getCouponFolder(java.lang.String pCouponFolderId) throws ClaimableException
pCouponFolderId
- - the id of the repository item to retrieveClaimableException
public java.util.List<CouponImportExportInfo> processCoupons(RepositoryItem[] pCoupons) throws ClaimableException
pCoupons
- - the array of coupon repository itemsClaimableException
public double getRemainingAmount(RepositoryItem pClaimable) throws RepositoryException
The maximum amount is computed as follows:
false
), pClaimable
- the claimable itemRepositoryException
public java.lang.String getItemDescriptorName(java.lang.Integer pType) throws ClaimableException
pType
- - type codeClaimableException
- if the supplied type was invalidpublic java.lang.String getItemDescriptorName(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues) throws ClaimableException
pCouponPropertyValues
- - a map of the coupon property names and their values.ClaimableException
- if the supplied type was invalid