|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectatg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.commerce.gifts.GiftlistTools
public class GiftlistTools
This class provides the low level functionality for giftlist and gift item creation/manipulation. It performs the calls required to read and write information to and from the giftlist repository.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
GiftlistTools()
Constructs a GiftlistTools object. |
Method Summary | |
---|---|
boolean |
addGiftlistToProfile(MutableRepositoryItem pProfile,
RepositoryItem pGiftlist)
Add the given giftlist to the given profile. |
void |
addItem(RepositoryItem pItem)
Add the given item to the repository |
boolean |
addItemToGiftlist(java.lang.String pGiftlistId,
java.lang.String pGiftlistItemId)
Add the given giftlistItem to the giftlist |
boolean |
addOtherGiftlistToProfile(MutableRepositoryItem pProfile,
RepositoryItem pGiftlist)
Adds a giftlist to a customer's otherGiftlist property. |
MutableRepositoryItem |
createGiftlist()
Creates and returns a new instance of a Giftlist repository item. |
MutableRepositoryItem |
createGiftlistItem()
Creates a new giftlist item in the repository and returns the item. |
RepositoryItem |
getAddress(java.lang.String pAddressId)
Return the address repository item for the given address id |
java.lang.String |
getCatalogRefIdProperty()
Property to store Catalog Ref Id property on a giftlist item |
CatalogTools |
getCatalogTools()
Returns property catalogTools. |
ClientLockManager |
getClientLockManager()
The obtaining and releasing of locks on an item during writes is handled by the client lock manager. |
java.lang.String |
getCommentsProperty()
Property to store Comments property on a giftlist |
java.lang.String |
getDefaultAddressType()
returns the defaultAddressType |
java.lang.String |
getDefaultGiftlistItemType()
Returns the defaultGiftlistItemType |
java.lang.String |
getDefaultGiftlistType()
Returns the defaultGiftlistType. |
java.lang.String |
getDefaultProfileType()
Returns the defaultProfileType. |
java.lang.String |
getDescriptionProperty()
Property to store Description property on a giftlist |
java.lang.String |
getDisplayNameProperty()
Property to store displayName property on a giftlist |
java.lang.String |
getEventDateProperty()
Property to store eventDate property on a giftlist |
java.lang.String |
getEventNameProperty()
Property to store eventName property on a giftlist |
java.lang.String |
getEventTypeProperty()
Property to store eventType property on a giftlist |
RepositoryItem |
getGiftitem(java.lang.String pId)
Returns a repository item giftitem with the id passed in. |
java.lang.String |
getGiftItemDescriptor()
Property to store repository item descriptor name for gifts |
RepositoryItem |
getGiftlist(java.lang.String pId)
Returns a repository item giftlist with the id passed in. |
java.lang.String |
getGiftlistItemDescriptor()
Property to store repository item descriptor name for giftlists |
java.util.Collection |
getGiftlistItems(RepositoryItem pGiftlist)
Return the collection of giftlist items in the given giftlist |
java.lang.String |
getGiftlistItemsProperty()
Property of the profile to which we add new giftlist items |
Repository |
getGiftlistRepository()
Returns property giftlistRepository. |
java.util.Collection |
getGiftlists(RepositoryItem pProfile)
Returns a collection of the giftlists owned by the given profile |
java.lang.String |
getInstructionsProperty()
Property to store Instructions property on a giftlist |
java.lang.String |
getItemsProperty()
Property to store Items property on a giftlist |
java.lang.String |
getLastModifiedDateProperty()
Property to store LastModifiedDate property on a giftlist |
java.lang.String |
getOtherGiftlistsProperty()
Property of the profile to which we add other people's giftlists a a customer finds. |
java.lang.String |
getOwnerProperty()
Property to store Owner property on a giftlist |
java.lang.String |
getPersonalGiftlistsProperty()
Property of the profile to which we add new giftlists |
java.lang.String |
getProductIdProperty()
Property to store Product Id property on a gift item |
MutableRepositoryItem |
getProfile(java.lang.String pProfileId)
Return the profile with the specified Id. |
Repository |
getProfileRepository()
Returns property profileRepository. |
java.lang.String |
getPublicProperty()
Property to store Public property on a giftlist |
java.lang.String |
getPublishedProperty()
Property to store Published property on a giftlist |
java.lang.String |
getQuantityDesiredProperty()
Property to store QuantityDesired property on a giftlist |
java.lang.String |
getQuantityPurchasedProperty()
Property to store QuantityPurchased property on a giftlist |
java.lang.String |
getShippingAddressProperty()
Property to store the id of hte shipping address property on a giftlist |
java.lang.String |
getSiteProperty()
Property to store the id of site property of a giftlist |
java.lang.String |
getSpecialInstructionsProperty()
Property to store SpecialInstructions property on a giftlist |
javax.transaction.TransactionManager |
getTransactionManager()
The beginning and ending of transactions are handled by the transaction manager. |
java.lang.String |
getWishlistProperty()
Property of the profile to which we add new wishlist |
boolean |
removeGiftlistFromOtherProfiles(RepositoryItem pGiftlist)
Removes a person's giftlist from the profiles of those shopping for the person. |
boolean |
removeGiftlistFromProfile(MutableRepositoryItem pProfile,
RepositoryItem pGiftlist)
Removes a giftlist from a person's profile. |
boolean |
removeItemFromGiftlist(MutableRepositoryItem pGiftlist,
MutableRepositoryItem pGiftitem)
Remove the given giftlistItem from the giftlist |
boolean |
removeItemFromGiftlist(java.lang.String pGiftlistId,
java.lang.String pGiftlistItemId)
Remove the given giftlistItem from the giftlist |
boolean |
removeOtherGiftlistFromProfile(MutableRepositoryItem pProfile,
RepositoryItem pGiftlist)
Removes a giftlist from a customer's otherGiftlist property. |
void |
setCatalogRefIdProperty(java.lang.String pCatalogRefIdProperty)
Sets the catalogRefIdProperty |
void |
setCatalogTools(CatalogTools pCatalogTools)
Sets property catalogTools. |
void |
setClientLockManager(ClientLockManager pClientLockManager)
Sets property clientLockManager |
void |
setCommentsProperty(java.lang.String pCommentsProperty)
Sets the comments property |
void |
setDefaultAddressType(java.lang.String pDefaultAddressType)
Sets the defaultAddressType |
void |
setDefaultGiftlistItemType(java.lang.String pDefaultGiftlistItemType)
Sets the defaultGiftlistItemType |
void |
setDefaultGiftlistType(java.lang.String pDefaultGiftlistType)
Sets the defaultGiftlistType. |
void |
setDefaultProfileType(java.lang.String pDefaultProfileType)
Sets the defaultProfileType. |
void |
setDescriptionProperty(java.lang.String pDescriptionProperty)
Sets the description property |
void |
setDisplayNameProperty(java.lang.String pDisplayNameProperty)
Sets the displayNameProperty |
void |
setEventDateProperty(java.lang.String pEventDateProperty)
Sets the eventDate property |
void |
setEventNameProperty(java.lang.String pEventNameProperty)
Sets the eventName property |
void |
setEventTypeProperty(java.lang.String pEventTypeProperty)
Sets the eventTypeProperty |
void |
setGiftItemDescriptor(java.lang.String pGiftItemDescriptor)
Sets the giftItemDescriptor |
void |
setGiftlistItemDescriptor(java.lang.String pGiftlistItemDescriptor)
Sets the giftlistItemDescriptor |
void |
setGiftlistItemsProperty(java.lang.String pGiftlistItemsProperty)
Sets the giftlistItemsProperty. |
void |
setGiftlistRepository(Repository pGiftlistRepository)
Sets property giftlistRepository. |
void |
setInstructionsProperty(java.lang.String pInstructionsProperty)
Sets the instructions property |
void |
setItemsProperty(java.lang.String pItemsProperty)
Sets the itemsProperty |
void |
setLastModifiedDateProperty(java.lang.String pLastModifiedDateProperty)
Sets the lastModifiedDateProperty |
void |
setOtherGiftlistsProperty(java.lang.String pOtherGiftlistsProperty)
Sets the otherGiftlistsProperty |
void |
setOwnerProperty(java.lang.String pOwnerProperty)
Sets the ownerProperty |
void |
setPersonalGiftlistsProperty(java.lang.String pPersonalGiftlistsProperty)
Sets the personalGiftlistsProperty |
void |
setProductIdProperty(java.lang.String pProductIdProperty)
Sets the productIdProperty |
void |
setProfileRepository(Repository pProfileRepository)
Sets property profileRepository. |
void |
setPublicProperty(java.lang.String pPublicProperty)
Sets the publicProperty |
void |
setPublishedProperty(java.lang.String pPublishedProperty)
Sets the publishedProperty |
void |
setQuantityDesiredProperty(java.lang.String pQuantityDesiredProperty)
Sets the quantityDesiredProperty |
void |
setQuantityPurchasedProperty(java.lang.String pQuantityPurchasedProperty)
Sets the quantityPurchasedProperty |
void |
setShippingAddressProperty(java.lang.String pShippingAddressProperty)
Sets the shippingAddressProperty |
void |
setSiteProperty(java.lang.String pSiteProperty)
Sets the siteProperty |
void |
setSpecialInstructionsProperty(java.lang.String pSpecialInstructionsProperty)
Sets the specialInstructions property |
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Sets property transactionManager |
void |
setWishlistProperty(java.lang.String pWishlistProperty)
Sets the wishlistProperty |
boolean |
updateGiftlist(java.lang.String pProfileId,
MutableRepositoryItem pGiftlist,
boolean pPublished,
java.lang.String pEventName,
java.util.Date pEventDate,
java.lang.String pEventType,
java.lang.String pShippingAddressId,
java.lang.String pDescription,
java.lang.String pComments,
java.lang.String pInstructions)
Update the given giftlist with the given parameters. |
boolean |
updateGiftlist(java.lang.String pProfileId,
MutableRepositoryItem pGiftlist,
boolean pPublished,
java.lang.String pEventName,
java.util.Date pEventDate,
java.lang.String pEventType,
java.lang.String pShippingAddressId,
java.lang.String pDescription,
java.lang.String pComments,
java.lang.String pInstructions,
java.lang.String pSiteId)
Update the given giftlist with the given parameters. |
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 final java.lang.String CLASS_VERSION
Constructor Detail |
---|
public GiftlistTools()
Method Detail |
---|
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
pTransactionManager
- The beginning and ending of transactions are handled by the transaction manager.public javax.transaction.TransactionManager getTransactionManager()
public void setClientLockManager(ClientLockManager pClientLockManager)
pClientLockManager
- The client lock manager acquires and releases locks to during a transactionpublic ClientLockManager getClientLockManager()
public void setCatalogTools(CatalogTools pCatalogTools)
pCatalogTools
- the catalogTools which provides low level operations on the catalog.public CatalogTools getCatalogTools()
catalogTools
.
catalogTools
.public void setProfileRepository(Repository pProfileRepository)
pProfileRepository
- The property to store the value of the profile repository.public Repository getProfileRepository()
ProfileRepository
.
ProfileRepository
.public void setGiftlistRepository(Repository pGiftlistRepository)
pGiftlistRepository
- The property to store the value of the giftlist repository.public Repository getGiftlistRepository()
Giftlists
.
Giftlists
.public void setDefaultProfileType(java.lang.String pDefaultProfileType)
pDefaultProfileType
- The property to store the default profile type.public java.lang.String getDefaultProfileType()
public void setDefaultAddressType(java.lang.String pDefaultAddressType)
pDefaultAddressType
- The property to store the default address type.public java.lang.String getDefaultAddressType()
public void setDefaultGiftlistType(java.lang.String pDefaultGiftlistType)
pDefaultGiftlistType
- The property to store the default giftlist type.public java.lang.String getDefaultGiftlistType()
public void setDefaultGiftlistItemType(java.lang.String pDefaultGiftlistItemType)
pDefaultGiftlistItemType
- The property to store the default giftitem type.public java.lang.String getDefaultGiftlistItemType()
public void setGiftlistItemsProperty(java.lang.String pGiftlistItemsProperty)
pGiftlistItemsProperty
- Property of the profile to which we add new giftlist itemspublic java.lang.String getGiftlistItemsProperty()
public void setPersonalGiftlistsProperty(java.lang.String pPersonalGiftlistsProperty)
pPersonalGiftlistsProperty
- Property of the profile to which we add new giftlistspublic java.lang.String getPersonalGiftlistsProperty()
public void setWishlistProperty(java.lang.String pWishlistProperty)
pWishlistProperty
- Property of the profile to which we add new wishlistpublic java.lang.String getWishlistProperty()
public void setOtherGiftlistsProperty(java.lang.String pOtherGiftlistsProperty)
pOtherGiftlistsProperty
- Property of the profile to which we add giftlists a customer finds for others.public java.lang.String getOtherGiftlistsProperty()
public void setEventTypeProperty(java.lang.String pEventTypeProperty)
pEventTypeProperty
- public java.lang.String getEventTypeProperty()
public void setOwnerProperty(java.lang.String pOwnerProperty)
pOwnerProperty
- public java.lang.String getOwnerProperty()
public void setEventDateProperty(java.lang.String pEventDateProperty)
pEventDateProperty
- public java.lang.String getEventDateProperty()
public void setEventNameProperty(java.lang.String pEventNameProperty)
pEventNameProperty
- public java.lang.String getEventNameProperty()
public void setCommentsProperty(java.lang.String pCommentsProperty)
pCommentsProperty
- The comments property of the giftlist in the repositorypublic java.lang.String getCommentsProperty()
public void setDescriptionProperty(java.lang.String pDescriptionProperty)
pDescriptionProperty
- The description property of the giftlist in the repositorypublic java.lang.String getDescriptionProperty()
public void setInstructionsProperty(java.lang.String pInstructionsProperty)
pInstructionsProperty
- The instructions property of the giftlist in the repositorypublic java.lang.String getInstructionsProperty()
public void setSpecialInstructionsProperty(java.lang.String pSpecialInstructionsProperty)
pSpecialInstructionsProperty
- The special instructions property of the giftlist in the repositorypublic java.lang.String getSpecialInstructionsProperty()
public void setPublicProperty(java.lang.String pPublicProperty)
pPublicProperty
- public java.lang.String getPublicProperty()
public void setPublishedProperty(java.lang.String pPublishedProperty)
pPublishedProperty
- public java.lang.String getPublishedProperty()
public void setShippingAddressProperty(java.lang.String pShippingAddressProperty)
pShippingAddressProperty
- public java.lang.String getShippingAddressProperty()
public void setSiteProperty(java.lang.String pSiteProperty)
pSiteProperty
- public java.lang.String getSiteProperty()
public void setItemsProperty(java.lang.String pItemsProperty)
pItemsProperty
- public java.lang.String getItemsProperty()
public void setLastModifiedDateProperty(java.lang.String pLastModifiedDateProperty)
pLastModifiedDateProperty
- public java.lang.String getLastModifiedDateProperty()
public void setCatalogRefIdProperty(java.lang.String pCatalogRefIdProperty)
pCatalogRefIdProperty
- public java.lang.String getCatalogRefIdProperty()
public void setProductIdProperty(java.lang.String pProductIdProperty)
pProductIdProperty
- public java.lang.String getProductIdProperty()
public void setQuantityDesiredProperty(java.lang.String pQuantityDesiredProperty)
pQuantityDesiredProperty
- public java.lang.String getQuantityDesiredProperty()
public void setQuantityPurchasedProperty(java.lang.String pQuantityPurchasedProperty)
pQuantityPurchasedProperty
- public java.lang.String getQuantityPurchasedProperty()
public void setDisplayNameProperty(java.lang.String pDisplayNameProperty)
pDisplayNameProperty
- public java.lang.String getDisplayNameProperty()
public void setGiftlistItemDescriptor(java.lang.String pGiftlistItemDescriptor)
pGiftlistItemDescriptor
- public java.lang.String getGiftlistItemDescriptor()
public void setGiftItemDescriptor(java.lang.String pGiftItemDescriptor)
pGiftItemDescriptor
- public java.lang.String getGiftItemDescriptor()
public MutableRepositoryItem createGiftlist() throws CommerceException
CommerceException
- if the creation of the giftlist fails.public RepositoryItem getGiftlist(java.lang.String pId) throws CommerceException
pId
- The id of the giftlist
CommerceException
- if the retrieval of the giftlist fails.public RepositoryItem getGiftitem(java.lang.String pId) throws CommerceException
pId
- The id of the giftitem
CommerceException
- if the retrieval of the giftitem fails.public boolean addItemToGiftlist(java.lang.String pGiftlistId, java.lang.String pGiftlistItemId) throws CommerceException
pGiftlistId
- the id of the giftlist to add the item topGiftlistItemId
- the id of the item to add to the giftlist
CommerceException
- if there was a problem adding the item to the giftlist.public boolean removeItemFromGiftlist(java.lang.String pGiftlistId, java.lang.String pGiftlistItemId) throws CommerceException
pGiftlistId
- the id of the giftlist to remove the gift frompGiftlistItemId
- the id of the item to remove from the giftlist
CommerceException
- if there was a problem removing the item from the giftlist.public boolean removeItemFromGiftlist(MutableRepositoryItem pGiftlist, MutableRepositoryItem pGiftitem) throws CommerceException
pGiftlist
- the giftlist to remove the gift frompGiftitem
- the item to remove
CommerceException
- if there was a problem removing the item from the giftlist.public boolean addOtherGiftlistToProfile(MutableRepositoryItem pProfile, RepositoryItem pGiftlist) throws CommerceException
pProfile
- the profile to add the giftlist topGiftlist
- the giftlist to add to the profile
CommerceException
- if there was a problem adding the giftlist to the customer's profilepublic boolean removeOtherGiftlistFromProfile(MutableRepositoryItem pProfile, RepositoryItem pGiftlist) throws CommerceException
pProfile
- the profile to add the giftlist topGiftlist
- the giftlist to add to the profile
CommerceException
- if there was a problem removing the giftlist from the customer's profilepublic MutableRepositoryItem createGiftlistItem() throws CommerceException
CommerceException
- if the creation of the giftlist item fails.public void addItem(RepositoryItem pItem) throws RepositoryException
pItem
- the item to add to the repository
RepositoryException
- if there was a problem accessing the repositorypublic java.util.Collection getGiftlistItems(RepositoryItem pGiftlist) throws CommerceException
pGiftlist
- the giftlist to get items from.
CommerceException
- if the retrieval of the giftlist items fails.public java.util.Collection getGiftlists(RepositoryItem pProfile) throws CommerceException
pProfile
- the profile of which to get the giftlists.
CommerceException
- if the retrieval of the giftlists fails.public MutableRepositoryItem getProfile(java.lang.String pProfileId)
pProfileId
- the id of the profile
public RepositoryItem getAddress(java.lang.String pAddressId)
pAddressId
- the id of the address
public boolean addGiftlistToProfile(MutableRepositoryItem pProfile, RepositoryItem pGiftlist) throws CommerceException
pProfile
- the profile to add the giftlist topGiftlist
- the giftlist to add to the profile
CommerceException
- if there was a problem adding the giftlist to the profile.public boolean removeGiftlistFromOtherProfiles(RepositoryItem pGiftlist) throws CommerceException, RepositoryException
pGiftlist
- the giftlist to remove from the profile
CommerceException
- if there was a problem removing the giftlist from the profile.
RepositoryException
public boolean removeGiftlistFromProfile(MutableRepositoryItem pProfile, RepositoryItem pGiftlist) throws CommerceException, RepositoryException
pProfile
- the profile to remove the giftlist frompGiftlist
- the giftlist to add to the profile
CommerceException
- if there was a problem removing the giftlist from the profile.
RepositoryException
public boolean updateGiftlist(java.lang.String pProfileId, MutableRepositoryItem pGiftlist, boolean pPublished, java.lang.String pEventName, java.util.Date pEventDate, java.lang.String pEventType, java.lang.String pShippingAddressId, java.lang.String pDescription, java.lang.String pComments, java.lang.String pInstructions) throws CommerceException
pProfileId
- the owner of the giftlist.pGiftlist
- the giftlist to update.pPublished
- boolean to identify whether giftlist is published.pEventName
- the name of the event for the giftlist.pEventDate
- the date of the event.pEventType
- the event type (e.g. birthday).pShippingAddressId
- the address where to ship the items.pDescription
- the description of the giftlist/event.pComments
- comments.pInstructions
- any special instructions on the giftlist.
CommerceException
- if there was a problem updating the giftlist.public boolean updateGiftlist(java.lang.String pProfileId, MutableRepositoryItem pGiftlist, boolean pPublished, java.lang.String pEventName, java.util.Date pEventDate, java.lang.String pEventType, java.lang.String pShippingAddressId, java.lang.String pDescription, java.lang.String pComments, java.lang.String pInstructions, java.lang.String pSiteId) throws CommerceException
pProfileId
- the owner of the giftlist.pGiftlist
- the giftlist to update.pPublished
- boolean to identify whether giftlist is published.pEventName
- the name of the event for the giftlist.pEventDate
- the date of the event.pEventType
- the event type (e.g. birthday).pShippingAddressId
- the address where to ship the items.pDescription
- the description of the giftlist/event.pComments
- comments.pInstructions
- any special instructions on the giftlist.pSiteId
- site id
CommerceException
- if there was a problem updating the giftlist.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |