pulse - the web application framework Get pulse at SourceForge.net. Fast, secure and Free Open Source software downloads Ohloh project report for pulse-java

org.torweg.pulse.component.store.model
Interface StoreItem

All Superinterfaces:
IHasAlternativeImages, IHasMainImage, IHasVariants, INameable, INamed, JDOMable, java.io.Serializable
All Known Subinterfaces:
ShopItem
All Known Implementing Classes:
ShopContent, ShopVariant, StoreContent, StoreVariant

public interface StoreItem
extends INameable, IHasAlternativeImages, IHasVariants, JDOMable, java.io.Serializable

Version:
$Revision: 1469 $
Author:
Christian Schatt

Method Summary
 boolean equals(java.lang.Object pObject)
          Determines whether the given Object is equal to the StoreItem.
 java.util.Set<StoreContentImageGroup> getAlternativeImages()
          Returns the alternative images of the StoreItem.
 java.util.Set<VirtualFile> getAssociatedVirtualFiles()
          Returns the associated VirtualFiles of the StoreItem.
 java.util.Set<Attachment> getAttachments()
          Returns the Attachments of the StoreItem.
 java.lang.String getDescription()
          Returns the description of the StoreItem.
 org.jdom.Element getDescriptionElement()
          Returns the description of the StoreItem as a JDOM Element.
 java.lang.StringBuilder getFullTextValue()
          Returns the String to be indexed for site full text searches.
 java.lang.Long getId()
          Returns the id of the StoreItem.
 StoreContentImageGroup getMainImage()
          Returns the main image of StoreItem.
 java.lang.String getOrderCode()
          Returns the order code of the StoreItem.
 java.lang.String getSummary()
          Returns the summary of the StoreItem.
 org.jdom.Element getSummaryElement()
          Returns the summary of the StoreItem as a JDOM Element.
 int hashCode()
          Returns a hash code for the StoreItem.
 void onVirtualFileSystemChange(VirtualFile file)
          Is called by the VirtualFileSystem, if any associated VirtualFiles have been moved in the file system.
 void setAlternativeImages(java.util.Set<StoreContentImageGroup> pAlternativeImages)
          Sets the alternative images of the StoreItem.
 void setAssociatedVirtualFiles(java.util.Set<VirtualFile> pAssociatedVirtualFiles)
          Sets the associated VirtualFiles of the StoreItem.
 void setAttachments(java.util.Set<Attachment> pAttachments)
          Sets the Attachments of the StoreItem.
 void setDescription(org.jdom.Element pDescription)
          Sets the description of the StoreItem by extracting it from the given JDOM Element.
 void setMainImage(StoreContentImageGroup pMainImage)
          Sets the main image of the StoreItem.
 void setOrderCode(java.lang.String code)
          Sets the order code of the StoreItem.
 void setSummary(org.jdom.Element pSummary)
          Sets the summary of the StoreItem by extracting it from the given JDOM Element.
 
Methods inherited from interface org.torweg.pulse.util.INameable
setName
 
Methods inherited from interface org.torweg.pulse.util.INamed
getName
 
Methods inherited from interface org.torweg.pulse.site.content.IHasVariants
getVariants
 
Methods inherited from interface org.torweg.pulse.bundle.JDOMable
deserializeToJDOM
 

Method Detail

getId

java.lang.Long getId()
Returns the id of the StoreItem.

Returns:
the id of the StoreItem.

getOrderCode

java.lang.String getOrderCode()
Returns the order code of the StoreItem.

Returns:
the order code of the StoreItem.

setOrderCode

void setOrderCode(java.lang.String code)
Sets the order code of the StoreItem.

Parameters:
code - the order code to be set.

getSummary

java.lang.String getSummary()
Returns the summary of the StoreItem.

Returns:
the summary of the StoreItem.

setSummary

void setSummary(org.jdom.Element pSummary)
Sets the summary of the StoreItem by extracting it from the given JDOM Element.

Parameters:
pSummary - the summary to be set.

getSummaryElement

org.jdom.Element getSummaryElement()
Returns the summary of the StoreItem as a JDOM Element.

Returns:
the summary of the StoreItem as a JDOM Element.

getDescription

java.lang.String getDescription()
Returns the description of the StoreItem.

Returns:
the description of the StoreItem.

setDescription

void setDescription(org.jdom.Element pDescription)
Sets the description of the StoreItem by extracting it from the given JDOM Element.

Parameters:
pDescription - the description to be set.

getDescriptionElement

org.jdom.Element getDescriptionElement()
Returns the description of the StoreItem as a JDOM Element.

Returns:
the description of the StoreItem as a JDOM Element.

getMainImage

StoreContentImageGroup getMainImage()
Returns the main image of StoreItem.

Specified by:
getMainImage in interface IHasMainImage
Returns:
the main image of StoreItem.

setMainImage

void setMainImage(StoreContentImageGroup pMainImage)
Sets the main image of the StoreItem.

Parameters:
pMainImage - the main image to be set.

getAlternativeImages

java.util.Set<StoreContentImageGroup> getAlternativeImages()
Returns the alternative images of the StoreItem.

Specified by:
getAlternativeImages in interface IHasAlternativeImages
Returns:
the alternative images of the StoreItem.

setAlternativeImages

void setAlternativeImages(java.util.Set<StoreContentImageGroup> pAlternativeImages)
Sets the alternative images of the StoreItem.

Parameters:
pAlternativeImages - the alternative images to be set.

getAssociatedVirtualFiles

java.util.Set<VirtualFile> getAssociatedVirtualFiles()
Returns the associated VirtualFiles of the StoreItem.

Returns:
the associated VirtualFiles of the StoreItem.

setAssociatedVirtualFiles

void setAssociatedVirtualFiles(java.util.Set<VirtualFile> pAssociatedVirtualFiles)
Sets the associated VirtualFiles of the StoreItem.

Parameters:
pAssociatedVirtualFiles - the associated VirtualFiles to be set.

getAttachments

java.util.Set<Attachment> getAttachments()
Returns the Attachments of the StoreItem.

Returns:
the Attachments of the StoreItem.

setAttachments

void setAttachments(java.util.Set<Attachment> pAttachments)
Sets the Attachments of the StoreItem.

Parameters:
pAttachments - the Attachments to be set.

equals

boolean equals(java.lang.Object pObject)
Determines whether the given Object is equal to the StoreItem.

Overrides:
equals in class java.lang.Object
Parameters:
pObject - the Object to be checked for equality with the StoreItem.
Returns:
true, if the given Object is equal to the StoreItem. Returns false, otherwise.

hashCode

int hashCode()
Returns a hash code for the StoreItem.

Overrides:
hashCode in class java.lang.Object
Returns:
a hash code for the StoreItem.

getFullTextValue

java.lang.StringBuilder getFullTextValue()
Returns the String to be indexed for site full text searches.

Returns:
the String to be indexed for site full text searches.

onVirtualFileSystemChange

void onVirtualFileSystemChange(VirtualFile file)
Is called by the VirtualFileSystem, if any associated VirtualFiles have been moved in the file system.

Parameters:
file - the files that have been moved.