|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.commerce.claimable.ClaimableTools
public class ClaimableTools
Field Summary | |
---|---|
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_STATUS_PROPERTY_NAME
Default name of the property of the item descriptor that signals the status of the claimable object. |
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 | |
---|---|
ClaimableTools()
Empty constructor. |
Method Summary | |
---|---|
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. |
protected RepositoryItem |
getClaimableItem(java.lang.String pId)
Return the repository item from the claimable repository whose id is equal to pId. |
java.lang.String |
getClaimableItemDescriptorName()
Return the claimableItemDescriptorName property. |
protected RepositoryItem[] |
getClaimableItems(java.lang.String[] pIds)
Return the matching RepositoryItems |
Repository |
getClaimableRepository()
Return the claimableRepository property. |
java.lang.String |
getCouponItemDescriptorName()
Return the CouponItemDescriptorName property. |
java.lang.String |
getExpirePropertyName()
Return the ExpirePropertyName property. |
java.lang.String |
getGiftCertificateAmountAuthorizedPropertyName()
Returns property giftCertificateAmountAuthorizedPropertyName |
java.lang.String |
getGiftCertificateAmountPropertyName()
Return the giftCertificateAmountPropertyName property. |
java.lang.String |
getGiftCertificateAmountRemainingPropertyName()
Return the giftCertificateAmountRemainingPropertyName property. |
java.lang.String |
getGiftCertificateItemDescriptorName()
Return the giftCertificateItemDescriptorName property. |
java.lang.String |
getGiftCertificateLastUsedPropertyName()
Return the giftCertificateLastUsedPropertyName property. |
java.lang.String |
getGiftCertificatePurchaseDatePropertyName()
Return the giftCertificatePurchaseDatePropertyName property. |
java.lang.String |
getGiftCertificatePurchaserIdPropertyName()
Return the giftCertificatePurchaserIdPropertyName property. |
java.lang.String |
getPromotionPropertyName()
Return the PromotionPropertyName property. |
java.lang.String |
getStatusPropertyName()
Return the statusPropertyName property. |
java.lang.String |
getStoreCreditAmountAuthorizedPropertyName()
Returns property storeCreditAmountAuthorizedPropertyName |
java.lang.String |
getStoreCreditAmountPropertyName()
Returns property storeCreditAmountPropertyName |
java.lang.String |
getStoreCreditAmountRemainingPropertyName()
Returns property storeCreditAmountRemainingPropertyName |
java.lang.String |
getStoreCreditExpirationDatePropertyName()
Returns property storeCreditExpirationDatePropertyName |
java.lang.String |
getStoreCreditIssueDatePropertyName()
Returns property storeCreditIssueDatePropertyName |
java.lang.String |
getStoreCreditItemDescriptorName()
Returns 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. |
java.lang.String |
getTypePropertyName()
Return the typePropertyName property. |
void |
persistTransientClaimableItem(RepositoryItem pClaimableItem)
This method persist the claimable item into the repository. |
void |
setClaimableItemDescriptorName(java.lang.String pClaimableItemDescriptorName)
Set the claimableItemDescriptorName property. |
void |
setClaimableRepository(Repository pClaimableRepository)
Set the claimableRepository property. |
void |
setCouponItemDescriptorName(java.lang.String pCouponItemDescriptorName)
Set the CouponItemDescriptorName property. |
void |
setExpirePropertyName(java.lang.String pExpirePropertyName)
Set the ExpirePropertyName property. |
void |
setGiftCertificateAmountAuthorizedPropertyName(java.lang.String pGiftCertificateAmountAuthorizedPropertyName)
Sets property giftCertificateAmountAuthorizedPropertyName |
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 |
setPromotionPropertyName(java.lang.String pPromotionPropertyName)
Set the PromotionPropertyName property. |
void |
setStatusPropertyName(java.lang.String pStatusPropertyName)
Set the statusPropertyName property. |
void |
setStoreCreditAmountAuthorizedPropertyName(java.lang.String pStoreCreditAmountAuthorizedPropertyName)
Sets property storeCreditAmountAuthorizedPropertyName |
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 |
setTypePropertyName(java.lang.String pTypePropertyName)
Set the typePropertyName property. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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, toString, wait, wait, wait |
Field Detail |
---|
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
Constructor Detail |
---|
public ClaimableTools()
Method Detail |
---|
public void setPromotionPropertyName(java.lang.String pPromotionPropertyName)
public java.lang.String getPromotionPropertyName()
public void setGiftCertificateLastUsedPropertyName(java.lang.String pGiftCertificateLastUsedPropertyName)
public java.lang.String getGiftCertificateLastUsedPropertyName()
public void setCouponItemDescriptorName(java.lang.String pCouponItemDescriptorName)
public java.lang.String getCouponItemDescriptorName()
public void setGiftCertificateItemDescriptorName(java.lang.String pGiftCertificateItemDescriptorName)
public java.lang.String getGiftCertificateItemDescriptorName()
public void setGiftCertificateAmountPropertyName(java.lang.String pGiftCertificateAmountPropertyName)
public java.lang.String getGiftCertificateAmountPropertyName()
public void setGiftCertificateAmountRemainingPropertyName(java.lang.String pGiftCertificateAmountRemainingPropertyName)
public java.lang.String getGiftCertificateAmountRemainingPropertyName()
public void setExpirePropertyName(java.lang.String pExpirePropertyName)
public java.lang.String getExpirePropertyName()
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)
public java.lang.String getGiftCertificatePurchaserIdPropertyName()
public void setGiftCertificatePurchaseDatePropertyName(java.lang.String pGiftCertificatePurchaseDatePropertyName)
public java.lang.String getGiftCertificatePurchaseDatePropertyName()
public void setTypePropertyName(java.lang.String pTypePropertyName)
public java.lang.String getTypePropertyName()
public void setClaimableRepository(Repository pClaimableRepository)
public Repository getClaimableRepository()
public void setStatusPropertyName(java.lang.String pStatusPropertyName)
public java.lang.String getStatusPropertyName()
public void setClaimableItemDescriptorName(java.lang.String pClaimableItemDescriptorName)
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 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 boolean getStrictAuthorization()
public void setStrictAuthorization(boolean pStrictAuthorization)
pStrictAuthorization
- the value to set for property strictAuthorizationprotected RepositoryItem getClaimableItem(java.lang.String pId) throws RepositoryException
RepositoryException
protected RepositoryItem[] getClaimableItems(java.lang.String[] pIds) throws RepositoryException
RepositoryException
ClaimableTools#getRepositoryItem
protected void adjustStatus(RepositoryItem pClaimableItem, java.lang.String pStatus) throws PropertyNotFoundException, RepositoryException
pClaimableItem
- a value of type 'RepositoryItem'
PropertyNotFoundException
RepositoryException
protected void adjustStatus(RepositoryItem[] pClaimableItems, java.lang.String pStatus) throws PropertyNotFoundException, RepositoryException
pClaimableItem
- a value of type 'RepositoryItem'
PropertyNotFoundException
RepositoryException
public RepositoryItem createClaimableItem(java.lang.String pItemDescriptorType) throws ClaimableException
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |