ClaimableTools (ATG Java API)

java.lang.Object
- atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
- - atg.nucleus.GenericService
  - - atg.commerce.claimable.ClaimableTools

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener
```
public class ClaimableTools
extends GenericService
```

Field Summary

Fields
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

Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors
Constructor and Description

ClaimableTools()
Empty constructor.

Constructors
Constructor and Description
`ClaimableTools()` Empty constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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 pCouponPropertyValues)` 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 pCouponPropertyValues)` 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.

Methods inherited from class atg.nucleus.GenericService
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, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
  - sResourceBundle
```
protected static java.util.ResourceBundle sResourceBundle
```
    Resource Bundle
  - CLAIMED
```
public static final java.lang.String CLAIMED
```
    claimed option from the item property named by DEFAULT_STATUS_PROPERTY_NAME
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLAIMABLE_ITEM_DESCRIPTOR
```
public static final java.lang.String DEFAULT_CLAIMABLE_ITEM_DESCRIPTOR
```
    Default name of the base claimable item descriptor. This can be overriden by setting the claimableItemDescriptorName property. This is the item descriptor that is searched for a particular item id.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STATUS_PROPERTY_NAME
```
public static final java.lang.String DEFAULT_STATUS_PROPERTY_NAME
```
    Default name of the property of the item descriptor that signals the status of the claimable object. When an item is claimed, or adjusted in another way its status will get changed.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COUPON_FOLDER_ITEM_DESCRIPTOR_NAME
```
public static final java.lang.String DEFAULT_COUPON_FOLDER_ITEM_DESCRIPTOR_NAME
```
    Default name of the coupon folder item descriptor.
    
    See Also:
    
    Constant Field Values
  - mPricingTools
```
protected PricingTools mPricingTools
```
- Constructor Detail
  - ClaimableTools
```
public ClaimableTools()
```
    Empty constructor.
- Method Detail
  - getPricingTools
```
public PricingTools getPricingTools()
```
  - setPricingTools
```
public void setPricingTools(PricingTools pPricingTools)
```
  - setPromotionPropertyName
```
public void setPromotionPropertyName(java.lang.String pPromotionPropertyName)
```
    Set the PromotionPropertyName property.
    
    Parameters:
    
    pPromotionPropertyName - the PromotionPropertyName property.
  - getPromotionPropertyName
```
public java.lang.String getPromotionPropertyName()
```
    Get the PromotionPropertyName property.
    
    Returns:
    
    the PromotionPropertyName property.
  - setCaseInsensitiveClaimableIds
```
public void setCaseInsensitiveClaimableIds(boolean pCaseInsensitiveClaimableIds)
```
    Set the caseInsensitiveClaimableIds property. If set to true the claimable lookup will case insensitive. The default is false which will be case sensitive lookup.
    
    Parameters:
    
    pCaseInsensitiveClaimableIds - the caseInsensitiveClaimableIds property.
  - isCaseInsensitiveClaimableIds
```
public boolean isCaseInsensitiveClaimableIds()
```
    Get the CaseInsensitiveClaimableIds property.
    
    Returns:
    
    CaseInsensitiveClaimableIds property.
  - setRedeemableOnPromotionSitesPropertyName
```
public void setRedeemableOnPromotionSitesPropertyName(java.lang.String pRedeemableOnPromotionSitesPropertyName)
```
    Set the RedeemableOnPromotionSitesPropertyName property.
    
    Parameters:
    
    pRedeemableOnPromotionSitesPropertyName - the RedeemableOnPromotionSitesPropertyName property.
  - getRedeemableOnPromotionSitesPropertyName
```
public java.lang.String getRedeemableOnPromotionSitesPropertyName()
```
    Get the RedeemableOnPromotionSitesPropertyName property.
    
    Returns:
    
    the RedeemableOnPromotionSitesPropertyName property.
  - setPromotionsPropertyName
```
public void setPromotionsPropertyName(java.lang.String pPromotionsPropertyName)
```
    Set the PromotionsPropertyName property.
    
    Parameters:
    
    pPromotionsPropertyName - the PromotionsPropertyName property.
  - getPromotionsPropertyName
```
public java.lang.String getPromotionsPropertyName()
```
    Get the PromotionsPropertyName property.
    
    Returns:
    
    the PromotionsPropertyName property.
  - setGiftCertificateLastUsedPropertyName
```
public void setGiftCertificateLastUsedPropertyName(java.lang.String pGiftCertificateLastUsedPropertyName)
```
    Set the giftCertificateLastUsedPropertyName property.
    
    Parameters:
    
    pGiftCertificateLastUsedPropertyName - the giftCertificateLastUsedPropertyName property.
  - getGiftCertificateLastUsedPropertyName
```
public java.lang.String getGiftCertificateLastUsedPropertyName()
```
    Get the giftCertificateLastUsedPropertyName property.
    
    Returns:
    
    the giftCertificateLastUsedPropertyName property.
  - setCouponItemDescriptorName
```
public void setCouponItemDescriptorName(java.lang.String pCouponItemDescriptorName)
```
    Set the CouponItemDescriptorName property.
    
    Parameters:
    
    pCouponItemDescriptorName - the CouponItemDescriptorName property.
  - getCouponItemDescriptorName
```
public java.lang.String getCouponItemDescriptorName()
```
    Get the CouponItemDescriptorName property.
    
    Returns:
    
    the CouponItemDescriptorName property.
  - setGiftCertificateItemDescriptorName
```
public void setGiftCertificateItemDescriptorName(java.lang.String pGiftCertificateItemDescriptorName)
```
    Set the giftCertificateItemDescriptorName property.
    
    Parameters:
    
    pGiftCertificateItemDescriptorName - the giftCertificateItemDescriptorName property.
  - getGiftCertificateItemDescriptorName
```
public java.lang.String getGiftCertificateItemDescriptorName()
```
    Get the giftCertificateItemDescriptorName property.
    
    Returns:
    
    the giftCertificateItemDescriptorName property.
  - setGiftCertificateAmountPropertyName
```
public void setGiftCertificateAmountPropertyName(java.lang.String pGiftCertificateAmountPropertyName)
```
    Set the giftCertificateAmountPropertyName property.
    
    Parameters:
    
    pGiftCertificateAmountPropertyName - the giftCertificateAmountPropertyName property.
  - getGiftCertificateAmountPropertyName
```
public java.lang.String getGiftCertificateAmountPropertyName()
```
    Get the giftCertificateAmountPropertyName property.
    
    Returns:
    
    the giftCertificateAmountPropertyName property.
  - setDisplayNamePropertyName
```
public void setDisplayNamePropertyName(java.lang.String pDisplayNamePropertyName)
```
    Set the DisplayNamePropertyName property.
    
    Parameters:
    
    pDisplayNamePropertyName - the DisplayNamePropertyName property.
  - getDisplayNamePropertyName
```
public java.lang.String getDisplayNamePropertyName()
```
    Get the DisplayNamePropertyName property.
    
    Returns:
    
    the DisplayNamePropertyName property.
  - setGiftCertificateAmountRemainingPropertyName
```
public void setGiftCertificateAmountRemainingPropertyName(java.lang.String pGiftCertificateAmountRemainingPropertyName)
```
    Set the giftCertificateAmountRemainingPropertyName property.
    
    Parameters:
    
    pGiftCertificateAmountRemainingPropertyName - the giftCertificateAmountRemainingPropertyName property.
  - getGiftCertificateAmountRemainingPropertyName
```
public java.lang.String getGiftCertificateAmountRemainingPropertyName()
```
    Get the giftCertificateAmountRemainingPropertyName property.
    
    Returns:
    
    the giftCertificateAmountRemainingPropertyName property.
  - setGiftCertificateAmountAvailablePropertyName
```
public void setGiftCertificateAmountAvailablePropertyName(java.lang.String pGiftCertificateAmountAvailablePropertyName)
```
    Set the giftCertificateAmountAvailablePropertyName property.
    
    Parameters:
    
    pGiftCertificateAmountAvailablePropertyName - the giftCertificateAmountAvailablePropertyName property.
  - getGiftCertificateAmountAvailablePropertyName
```
public java.lang.String getGiftCertificateAmountAvailablePropertyName()
```
    Get the giftCertificateAmountAvailablePropertyName property.
    
    Returns:
    
    the giftCertificateAmountAvailablePropertyName property.
  - setExpirePropertyName
```
public void setExpirePropertyName(java.lang.String pExpirePropertyName)
```
    Set the ExpirePropertyName property.
    
    Parameters:
    
    pExpirePropertyName -
  - getExpirePropertyName
```
public java.lang.String getExpirePropertyName()
```
    Get the ExpirePropertyName property.
    
    Returns:
    
    the expire date property name
  - getStartDatePropertyName
```
public java.lang.String getStartDatePropertyName()
```
    Get the start date property name
    
    Returns:
    
    the start date property name
  - setStartDatePropertyName
```
public void setStartDatePropertyName(java.lang.String pStartDatePropertyName)
```
    Set the start date property name
    
    Parameters:
    
    pStartDatePropertyName -
  - setGiftCertificateAmountAuthorizedPropertyName
```
public void setGiftCertificateAmountAuthorizedPropertyName(java.lang.String pGiftCertificateAmountAuthorizedPropertyName)
```
    Sets property giftCertificateAmountAuthorizedPropertyName
    
    Parameters:
    
    pGiftCertificateAmountAuthorizedPropertyName - the value to set for property giftCertificateAmountAuthorizedPropertyName
  - getGiftCertificateAmountAuthorizedPropertyName
```
public java.lang.String getGiftCertificateAmountAuthorizedPropertyName()
```
    Get the property giftCertificateAmountAuthorizedPropertyName
    
    Returns:
    
    returns property giftCertificateAmountAuthorizedPropertyName
  - setGiftCertificatePurchaserIdPropertyName
```
public void setGiftCertificatePurchaserIdPropertyName(java.lang.String pGiftCertificatePurchaserIdPropertyName)
```
    Set the giftCertificatePurchaserIdPropertyName property.
    
    Parameters:
    
    pGiftCertificatePurchaserIdPropertyName - the giftCertificatePurchaserIdPropertyName property.
  - getGiftCertificatePurchaserIdPropertyName
```
public java.lang.String getGiftCertificatePurchaserIdPropertyName()
```
    Get the giftCertificatePurchaserIdPropertyName property.
    
    Returns:
    
    the giftCertificatePurchaserIdPropertyName property.
  - setGiftCertificatePurchaseDatePropertyName
```
public void setGiftCertificatePurchaseDatePropertyName(java.lang.String pGiftCertificatePurchaseDatePropertyName)
```
    Set the giftCertificatePurchaseDatePropertyName property.
    
    Parameters:
    
    pGiftCertificatePurchaseDatePropertyName - the giftCertificatePurchaseDatePropertyName property.
  - getGiftCertificatePurchaseDatePropertyName
```
public java.lang.String getGiftCertificatePurchaseDatePropertyName()
```
    Get the giftCertificatePurchaseDatePropertyName property.
    
    Returns:
    
    the giftCertificatePurchaseDatePropertyName property.
  - setTypePropertyName
```
public void setTypePropertyName(java.lang.String pTypePropertyName)
```
    Set the typePropertyName property.
    
    Parameters:
    
    pTypePropertyName - the typePropertyName property.
  - getTypePropertyName
```
public java.lang.String getTypePropertyName()
```
    Get the typePropertyName property.
    
    Returns:
    
    the typePropertyName property.
  - setClaimableRepository
```
public void setClaimableRepository(Repository pClaimableRepository)
```
    Set the claimableRepository property.
    
    Parameters:
    
    pClaimableRepository - the claimableRepository property.
  - getClaimableRepository
```
public Repository getClaimableRepository()
```
    Get the claimableRepository property.
    
    Returns:
    
    the claimableRepository property.
  - setStatusPropertyName
```
public void setStatusPropertyName(java.lang.String pStatusPropertyName)
```
    Set the statusPropertyName property.
    
    Parameters:
    
    pStatusPropertyName - the statusPropertyName property.
  - getStatusPropertyName
```
public java.lang.String getStatusPropertyName()
```
    Get the statusPropertyName property.
    
    Returns:
    
    the statusPropertyName property.
  - setClaimableItemDescriptorName
```
public void setClaimableItemDescriptorName(java.lang.String pClaimableItemDescriptorName)
```
    Set the claimableItemDescriptorName property.
    
    Parameters:
    
    pClaimableItemDescriptorName - the claimableItemDescriptorName property.
  - getClaimableItemDescriptorName
```
public java.lang.String getClaimableItemDescriptorName()
```
    Get the claimableItemDescriptorName property.
    
    Returns:
    
    the claimableItemDescriptorName property.
  - getStoreCreditItemDescriptorName
```
public java.lang.String getStoreCreditItemDescriptorName()
```
    Get the property storeCreditItemDescriptorName
    
    Returns:
    
    the property storeCreditItemDescriptorName
  - setStoreCreditItemDescriptorName
```
public void setStoreCreditItemDescriptorName(java.lang.String pStoreCreditItemDescriptorName)
```
    Sets property storeCreditItemDescriptorName
    
    Parameters:
    
    pStoreCreditItemDescriptorName - the value to set for property storeCreditItemDescriptorName
  - getStoreCreditAmountPropertyName
```
public java.lang.String getStoreCreditAmountPropertyName()
```
    Get the property storeCreditAmountPropertyName
    
    Returns:
    
    the property storeCreditAmountPropertyName
  - setStoreCreditAmountPropertyName
```
public void setStoreCreditAmountPropertyName(java.lang.String pStoreCreditAmountPropertyName)
```
    Sets property storeCreditAmountPropertyName
    
    Parameters:
    
    pStoreCreditAmountPropertyName - the value to set for property storeCreditAmountPropertyName
  - getStoreCreditAmountAuthorizedPropertyName
```
public java.lang.String getStoreCreditAmountAuthorizedPropertyName()
```
    Get the property storeCreditAmountAuthorizedPropertyName
    
    Returns:
    
    the property storeCreditAmountAuthorizedPropertyName
  - setStoreCreditAmountAuthorizedPropertyName
```
public void setStoreCreditAmountAuthorizedPropertyName(java.lang.String pStoreCreditAmountAuthorizedPropertyName)
```
    Sets property storeCreditAmountAuthorizedPropertyName
    
    Parameters:
    
    pStoreCreditAmountAuthorizedPropertyName - the value to set for property storeCreditAmountAuthorizedPropertyName
  - getStoreCreditAmountRemainingPropertyName
```
public java.lang.String getStoreCreditAmountRemainingPropertyName()
```
    Get the property storeCreditAmountRemainingPropertyName
    
    Returns:
    
    the property storeCreditAmountRemainingPropertyName
  - setStoreCreditAmountRemainingPropertyName
```
public void setStoreCreditAmountRemainingPropertyName(java.lang.String pStoreCreditAmountRemainingPropertyName)
```
    Sets property storeCreditAmountRemainingPropertyName
    
    Parameters:
    
    pStoreCreditAmountRemainingPropertyName - the value to set for property storeCreditAmountRemainingPropertyName
  - getStoreCreditAmountAvailablePropertyName
```
public java.lang.String getStoreCreditAmountAvailablePropertyName()
```
    Returns property storeCreditAmountAvailablePropertyName
    
    Returns:
    
    returns property storeCreditAmountAvailablePropertyName
  - setStoreCreditAmountAvailablePropertyName
```
public void setStoreCreditAmountAvailablePropertyName(java.lang.String pStoreCreditAmountAvailablePropertyName)
```
    Sets property storeCreditAmountAvailablePropertyName
    
    Parameters:
    
    pStoreCreditAmountAvailablePropertyName - the value to set for property storeCreditAmountAvailablePropertyName
  - getStoreCreditOwnerIdPropertyName
```
public java.lang.String getStoreCreditOwnerIdPropertyName()
```
    Returns property storeCreditOwnerIdPropertyName
    
    Returns:
    
    returns property storeCreditOwnerIdPropertyName
  - setStoreCreditOwnerIdPropertyName
```
public void setStoreCreditOwnerIdPropertyName(java.lang.String pStoreCreditOwnerIdPropertyName)
```
    Sets property storeCreditOwnerIdPropertyName
    
    Parameters:
    
    pStoreCreditOwnerIdPropertyName - the value to set for property storeCreditOwnerIdPropertyName
  - getStoreCreditLastUsedPropertyName
```
public java.lang.String getStoreCreditLastUsedPropertyName()
```
    Returns property storeCreditLastUsedPropertyName
    
    Returns:
    
    returns property storeCreditLastUsedPropertyName
  - setStoreCreditLastUsedPropertyName
```
public void setStoreCreditLastUsedPropertyName(java.lang.String pStoreCreditLastUsedPropertyName)
```
    Sets property storeCreditLastUsedPropertyName
    
    Parameters:
    
    pStoreCreditLastUsedPropertyName - the value to set for property storeCreditLastUsedPropertyName
  - getStoreCreditIssueDatePropertyName
```
public java.lang.String getStoreCreditIssueDatePropertyName()
```
    Returns property storeCreditIssueDatePropertyName
    
    Returns:
    
    returns property storeCreditIssueDatePropertyName
  - setStoreCreditIssueDatePropertyName
```
public void setStoreCreditIssueDatePropertyName(java.lang.String pStoreCreditIssueDatePropertyName)
```
    Sets property storeCreditIssueDatePropertyName
    
    Parameters:
    
    pStoreCreditIssueDatePropertyName - the value to set for property storeCreditIssueDatePropertyName
  - getStoreCreditExpirationDatePropertyName
```
public java.lang.String getStoreCreditExpirationDatePropertyName()
```
    Returns property storeCreditExpirationDatePropertyName
    
    Returns:
    
    returns property storeCreditExpirationDatePropertyName
  - setStoreCreditExpirationDatePropertyName
```
public void setStoreCreditExpirationDatePropertyName(java.lang.String pStoreCreditExpirationDatePropertyName)
```
    Sets property storeCreditExpirationDatePropertyName
    
    Parameters:
    
    pStoreCreditExpirationDatePropertyName - the value to set for property storeCreditExpirationDatePropertyName
  - getParentFolderPropertyName
```
public java.lang.String getParentFolderPropertyName()
```
    Returns property parentFolderPropertyName
    
    Returns:
    
    returns property parentFolderPropertyName
  - setParentFolderPropertyName
```
public void setParentFolderPropertyName(java.lang.String pParentFolderPropertyName)
```
    Sets property parentFolderPropertyName
    
    Parameters:
    
    pParentFolderPropertyName - the value to set for property parentFolderPropertyName
  - getLastModifiedPropertyName
```
public java.lang.String getLastModifiedPropertyName()
```
    Returns property lastModifiedPropertyName
    
    Returns:
    
    returns property lastModifiedPropertyName
  - setLastModifiedPropertyName
```
public void setLastModifiedPropertyName(java.lang.String pLastModifiedPropertyName)
```
    Sets property lastModifiedPropertyName
    
    Parameters:
    
    pLastModifiedPropertyName - the value to set for property lastModifiedPropertyName
  - getStrictAuthorization
```
public boolean getStrictAuthorization()
```
    Returns property strictAuthorization This is true by default.
    
    Returns:
    
    returns property strictAuthorization
  - setStrictAuthorization
```
public void setStrictAuthorization(boolean pStrictAuthorization)
```
    Sets property strictAuthorization
    
    Parameters:
    
    pStrictAuthorization - the value to set for property strictAuthorization
  - getTransactionManager
```
public javax.transaction.TransactionManager getTransactionManager()
```
    Gets the transactionManager.
    
    Returns:
    
    the transactionManager.
  - setTransactionManager
```
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
```
    Sets the transactionManager.
    
    Parameters:
    
    pTransactionManager - the transactionManager.
  - getParentFolderProperty
```
public java.lang.String getParentFolderProperty()
```
    Get the coupon parent folder property.
    
    Returns:
    
    the coupon parent folder property.
  - setParentFolderProperty
```
public void setParentFolderProperty(java.lang.String pParentFolderProperty)
```
    Set the coupon parent folder property.
    
    Parameters:
    
    pParentFolderProperty - the coupon parent folder property.
  - getCouponFolderItemDescriptorName
```
public java.lang.String getCouponFolderItemDescriptorName()
```
    Get the coupon folder item descriptor name.
    
    Returns:
    
    the coupon folder item descriptor name.
  - setCouponFolderItemDescriptorName
```
public void setCouponFolderItemDescriptorName(java.lang.String pCouponFolderItemDescriptorName)
```
    Set the coupon folder item descriptor name.
    
    Parameters:
    
    pCouponFolderItemDescriptorName - the coupon folder item descriptor name.
  - getCouponFolderNameProperty
```
public java.lang.String getCouponFolderNameProperty()
```
    Get the coupon folder name property.
    
    Returns:
    
    the coupon folder name property.
  - setCouponFolderNameProperty
```
public void setCouponFolderNameProperty(java.lang.String pCouponFolderNameProperty)
```
    Set the coupon folder name property.
    
    Parameters:
    
    pCouponFolderNameProperty - the coupon folder name property.
  - getCouponFolderParentFolderProperty
```
public java.lang.String getCouponFolderParentFolderProperty()
```
    Get the coupon folder parent folder property.
    
    Returns:
    
    the coupon folder parent folder property.
  - setCouponFolderParentFolderProperty
```
public void setCouponFolderParentFolderProperty(java.lang.String pCouponFolderParentFolderProperty)
```
    Set the coupon folder parent folder property.
    
    Parameters:
    
    pCouponFolderParentFolderProperty - the coupon folder parent folder property.
  - getIdPropertyName
```
public java.lang.String getIdPropertyName()
```
    Get the id property name
    
    Returns:
    
    the id property name
  - setIdPropertyName
```
public void setIdPropertyName(java.lang.String pIdPropertyName)
```
    Set the id property name
    
    Parameters:
    
    pIdPropertyName - the id property name
  - getUsesPropertyName
```
public java.lang.String getUsesPropertyName()
```
    Get the uses property name.
  - setUsesPropertyName
```
public void setUsesPropertyName(java.lang.String pUsesPropertyName)
```
    Set uses Property name
  - getMaxUsesPropertyName
```
public java.lang.String getMaxUsesPropertyName()
```
    Get the max uses property name.
  - setMaxUsesPropertyName
```
public void setMaxUsesPropertyName(java.lang.String pMaxUsesPropertyName)
```
    Set max uses Property name
  - getTypeCodeToItemDescriptorMap
```
public java.util.Properties getTypeCodeToItemDescriptorMap()
```
    Get the typeCodeToItemDescriptorMap property.
  - setTypeCodeToItemDescriptorMap
```
public void setTypeCodeToItemDescriptorMap(java.util.Properties pTypeCodeToItemDescriptorMap)
```
    Set the typeCodeToItemDescriptorMap property.
  - getDefaultTypeCode
```
public java.lang.String getDefaultTypeCode()
```
    Get the default type code.
  - setDefaultTypeCode
```
public void setDefaultTypeCode(java.lang.String pDefaultTypeCode)
```
    Set default type code Property name
  - getClaimableItem
```
public RepositoryItem getClaimableItem(java.lang.String pId)
                                throws RepositoryException
```
    Return the repository item from the claimable repository whose id is equal to pId. The repository and item descriptors specified by the ClaimableRepository and ClaimableItemDescriptorName properties are used to perform the search.
    
    Parameters:
    
    pId - the repository ID of the item to be claimed
    
    Throws:
    
    RepositoryException
  - getClaimableItems
```
public RepositoryItem[] getClaimableItems(java.lang.String[] pIds)
                                   throws RepositoryException
```
    Return the RepositoryItems from the claimable repository whose ids are equal to the members of pIds. The repository and item descriptors specified by the ClaimableRepository and ClaimableItemDescriptorName properties are used to perform the search.
    
    Parameters:
    
    pIds - the String repository IDs of the item to be claimed
    
    Throws:
    
    RepositoryException
    
    See Also:
    
    ClaimableTools#getRepositoryItem
  - adjustStatus
```
protected void adjustStatus(RepositoryItem pClaimableItem,
                            java.lang.String pStatus)
                     throws PropertyNotFoundException,
                            RepositoryException
```
    Change the status of a claimable repository item so that its status reflects the appropriate status.
    
    Parameters:
    
    pClaimableItem - the RepositoryItem whose status should be changed
    
    pStatus - the new status
    
    Throws:
    
    PropertyNotFoundException
    
    RepositoryException
  - adjustStatus
```
protected void adjustStatus(RepositoryItem[] pClaimableItems,
                            java.lang.String pStatus)
                     throws PropertyNotFoundException,
                            RepositoryException
```
    Change the status of a claimable repository item so that its status reflects the appropriate status.
    
    Parameters:
    
    pClaimableItems - the RepositoryItems whose status should be changed
    
    pStatus - the new status
    
    Throws:
    
    PropertyNotFoundException
    
    RepositoryException
  - createClaimableItem
```
public RepositoryItem createClaimableItem(java.lang.String pItemDescriptorType)
                                   throws ClaimableException
```
    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.
    
    Parameters:
    
    pItemDescriptorType - The name of the item descriptor type for the new claimable.
    
    Throws:
    
    ClaimableException - if the repository throws any exception during item creation. The ClaimableException will wrap the underlying RepositoryException.
  - createClaimableItem
```
public RepositoryItem createClaimableItem(java.lang.String pId,
                                          java.lang.String pItemDescriptorType,
                                          boolean pTransient)
                                   throws ClaimableException
```
    Create a new repository item in the claimable repository with the specified id, using the given item descriptor type.
    
    Parameters:
    
    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.
    
    Throws:
    
    ClaimableException - if the repository throws any exception during item creation. The ClaimableException will wrap the underlying RepositoryException.
  - createClaimableItem
```
public RepositoryItem createClaimableItem(java.lang.String pId,
                                          java.lang.String pItemDescriptorType)
                                   throws ClaimableException
```
    Create a new repository item in the claimable repository with the specified id, using the given item descriptor type.
    
    Parameters:
    
    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.
    
    Throws:
    
    ClaimableException - if the repository throws any exception during item creation. The ClaimableException will wrap the underlying RepositoryException.
  - persistTransientClaimableItem
```
public void persistTransientClaimableItem(RepositoryItem pClaimableItem)
                                   throws ClaimableException
```
    This method persist the claimable item into the repository.
    
    Parameters:
    
    pClaimableItem -
    
    Throws:
    
    ClaimableException
  - createCoupon
```
public RepositoryItem createCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
                            throws ClaimableException
```
    This method creates a coupon repository item (i.e. PromotionClaimable) and sets its properties to the values specified in the map parameter. If an id is not specified in the map, it is generated.
    
    Parameters:
    
    pCouponPropertyValues - - a map of the coupon property names and their values.
    
    Returns:
    
    - the newly created coupon repository item.
    
    Throws:
    
    ClaimableException
  - getCoupon
```
@Deprecated
public RepositoryItem getCoupon(java.lang.String pCouponId)
                                     throws ClaimableException
```
    Deprecated. as of 10.2; use (Map pCouponPropertyValues) which handles different types of claimables (as opposed to just PromotionClaimable)
    
    This method retrieves a coupon repository item using the specified id.
    
    Parameters:
    
    pCouponId - - the id of the coupon repository item to retrieve.
    
    Returns:
    
    - the coupon repository item.
    
    Throws:
    
    ClaimableException
  - getCoupon
```
public RepositoryItem getCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
                         throws ClaimableException
```
    This method retrieves a coupon repository item using the specified id.
    
    Parameters:
    
    pCouponPropertyValues - - a map of the property names and their values.
    
    Returns:
    
    - the coupon repository item.
    
    Throws:
    
    ClaimableException
  - updateCoupon
```
public RepositoryItem updateCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
                            throws ClaimableException
```
    This method updates a coupon repository item, setting its properties to the values specified in the map parameter.
    
    Parameters:
    
    pCouponPropertyValues - - a map of the property names and their values.
    
    Returns:
    
    - the updated coupon repository item.
    
    Throws:
    
    ClaimableException
  - getCouponsForPromotion
```
public RepositoryItem[] getCouponsForPromotion(java.lang.String pPromotionId)
                                        throws ClaimableException
```
    This method retrieves of all of the coupons associated with a particular promotion.
    
    Parameters:
    
    pPromotionId - - the id of the promotion.
    
    Returns:
    
    - an array of coupon repository items, which are associated with the promotion id.
    
    Throws:
    
    ClaimableException
  - deleteCoupon
```
@Deprecated
public void deleteCoupon(java.lang.String pCouponId)
                              throws ClaimableException
```
    Deprecated. as of 10.2; use (Map pCouponPropertyValues) which handles different types of claimables (as opposed to just PromotionClaimable)
    
    This method deletes a coupon from the claimable repository.
    
    Parameters:
    
    pCouponId - - the id of the coupon to be deleted.
    
    Throws:
    
    ClaimableException
  - deleteCoupon
```
public void deleteCoupon(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
                  throws ClaimableException
```
    This method deletes a coupon from the claimable repository.
    
    Parameters:
    
    pCouponPropertyValues - - a map of the coupon property names and their values.
    
    Throws:
    
    ClaimableException
  - createCouponFolderFromPath
```
public RepositoryItem createCouponFolderFromPath(java.lang.String pCouponFolderPath)
                                          throws ClaimableException
```
    This method creates a series of coupon folders, from the path provided. A couponFolder repository item is created for each token in the path, and those repository items are chained together to form part of the folder tree. An example path is "/Summer/Mens/Shoes".
    
    Parameters:
    
    pCouponFolderpath - - the full path of the coupon folder.
    
    Returns:
    
    - the repository item corresponding to the last token of the path.
    
    Throws:
    
    ClaimableException
  - getCouponFolderPath
```
public java.lang.String getCouponFolderPath(java.lang.String pCouponFolderId)
                                     throws ClaimableException
```
    This method retrieves the coupon folder's full path. It creates the path by starting at the folder specified and working its way up the tree to the root.
    
    Parameters:
    
    pCouponFolderId - - the id of the couponFolder item, for which the path is to be constructed.
    
    Returns:
    
    - the logical path for specified coupon folder.
    
    Throws:
    
    ClaimableException
  - createCouponFolder
```
public RepositoryItem createCouponFolder(java.util.Map<java.lang.String,java.lang.String> pCouponFolderPropertyValues)
                                  throws ClaimableException
```
    This method creates a coupon folder repository item and sets its properties to the values specified in the map parameter. If an id is not specified in the map, it is generated.
    
    Parameters:
    
    pCouponFolderPropertyValues - - a map of the coupon folder property names and their values.
    
    Returns:
    
    - the newly created coupon folder repository item.
    
    Throws:
    
    ClaimableException
  - getCouponFolder
```
public RepositoryItem getCouponFolder(java.lang.String pCouponFolderId)
                               throws ClaimableException
```
    This method retrieves a coupon folder repository item using the specified id.
    
    Parameters:
    
    pCouponFolderId - - the id of the repository item to retrieve
    
    Returns:
    
    - the coupon folder repository item.
    
    Throws:
    
    ClaimableException
  - processCoupons
```
public java.util.List<CouponImportExportInfo> processCoupons(RepositoryItem[] pCoupons)
                                                      throws ClaimableException
```
    This method processes an array of coupon repository items to get the property values.
    
    Parameters:
    
    pCoupons - - the array of coupon repository items
    
    Returns:
    
    - a list of CouponImportExportInfo objects
    
    Throws:
    
    ClaimableException
  - getRemainingAmount
```
public double getRemainingAmount(RepositoryItem pClaimable)
                          throws RepositoryException
```
    This method returns the remaining amount for the Store Credit and Gift Certificate.
    This method supports only store credit and gift certificates. If you want to compute the
    remaining amount for any other type of claimable item, you need to extend this method.
    The maximum amount is computed as follows:
    - If the claimables are configured NOT to honor the strict authorization (false),
      then returns claimables item's remaining amount property value.
    - Otherwise remaining amount = amount property value - authorized amount property value.
    Parameters:
    
    pClaimable - the claimable item
    
    Returns:
    
    double the remaining amount for the store credit or gift certificate.
    
    Throws:
    
    RepositoryException
  - getItemDescriptorName
```
public java.lang.String getItemDescriptorName(java.lang.Integer pType)
                                       throws ClaimableException
```
    Helper method that returns an item descriptor name based on its type code.
    
    Parameters:
    
    pType - - type code
    
    Returns:
    
    item descriptor name
    
    Throws:
    
    ClaimableException - if the supplied type was invalid
  - getItemDescriptorName
```
public java.lang.String getItemDescriptorName(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)
                                       throws ClaimableException
```
    Helper method that returns an item descriptor name based on its type code.
    
    Parameters:
    
    pCouponPropertyValues - - a map of the coupon property names and their values.
    
    Returns:
    
    item descriptor name
    
    Throws:
    
    ClaimableException - if the supplied type was invalid

Class ClaimableTools

Field Summary

Fields inherited from class atg.nucleus.GenericService

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

Constructor Summary

Method Summary

Methods inherited from class atg.nucleus.GenericService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

sResourceBundle

CLAIMED

DEFAULT_CLAIMABLE_ITEM_DESCRIPTOR

DEFAULT_STATUS_PROPERTY_NAME

DEFAULT_COUPON_FOLDER_ITEM_DESCRIPTOR_NAME

mPricingTools

Constructor Detail

ClaimableTools

Method Detail

getPricingTools

setPricingTools

setPromotionPropertyName

getPromotionPropertyName

setCaseInsensitiveClaimableIds

isCaseInsensitiveClaimableIds

setRedeemableOnPromotionSitesPropertyName

getRedeemableOnPromotionSitesPropertyName

setPromotionsPropertyName

getPromotionsPropertyName

setGiftCertificateLastUsedPropertyName

getGiftCertificateLastUsedPropertyName

setCouponItemDescriptorName

getCouponItemDescriptorName

setGiftCertificateItemDescriptorName

getGiftCertificateItemDescriptorName

setGiftCertificateAmountPropertyName

getGiftCertificateAmountPropertyName

setDisplayNamePropertyName

getDisplayNamePropertyName

setGiftCertificateAmountRemainingPropertyName

getGiftCertificateAmountRemainingPropertyName

setGiftCertificateAmountAvailablePropertyName

getGiftCertificateAmountAvailablePropertyName

setExpirePropertyName

getExpirePropertyName

getStartDatePropertyName

setStartDatePropertyName

setGiftCertificateAmountAuthorizedPropertyName

getGiftCertificateAmountAuthorizedPropertyName

setGiftCertificatePurchaserIdPropertyName

getGiftCertificatePurchaserIdPropertyName

setGiftCertificatePurchaseDatePropertyName

getGiftCertificatePurchaseDatePropertyName

setTypePropertyName

getTypePropertyName

setClaimableRepository

getClaimableRepository

setStatusPropertyName

getStatusPropertyName

setClaimableItemDescriptorName

getClaimableItemDescriptorName

getStoreCreditItemDescriptorName

setStoreCreditItemDescriptorName

getStoreCreditAmountPropertyName

setStoreCreditAmountPropertyName

getStoreCreditAmountAuthorizedPropertyName

setStoreCreditAmountAuthorizedPropertyName

getStoreCreditAmountRemainingPropertyName

setStoreCreditAmountRemainingPropertyName

getStoreCreditAmountAvailablePropertyName

setStoreCreditAmountAvailablePropertyName

getStoreCreditOwnerIdPropertyName

setStoreCreditOwnerIdPropertyName

getStoreCreditLastUsedPropertyName

setStoreCreditLastUsedPropertyName

getStoreCreditIssueDatePropertyName

setStoreCreditIssueDatePropertyName

getStoreCreditExpirationDatePropertyName