Store (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.Store

All Implemented Interfaces:: StoreIf

public class Store
extends java.lang.Object
implements StoreIf

A KonaKart Store definition

Constructor Summary

Constructors
Constructor and Description
`Store()` Empty Constructor
`Store(com.workingdogs.village.Record vr, KKCriteria c)` Instantiates the attributes of the AdminShop object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAdminEmail()` Email of the store administrator
`java.lang.String`	`getCssFileName()` File name of the CSS file used by the store
`java.lang.String`	`getCustom1()` Custom attribute
`java.lang.String`	`getCustom2()` Custom attribute
`java.lang.String`	`getCustom3()` Custom attribute
`java.lang.String`	`getCustom4()` Custom attribute
`java.lang.String`	`getCustom5()` Custom attribute
`java.util.Calendar`	`getDateAdded()`
`java.util.Calendar`	`getLastUpdated()` When the store was last updated
`java.lang.String`	`getLogoFileName()` File name of the store logo
`int`	`getMaxProducts()` The maximum number of products that a store may manage
`java.lang.String`	`getStoreDesc()` Description of the store
`java.lang.String`	`getStoreHome()` The instance id of a store that can associate it to a KonaKart instance
`java.lang.String`	`getStoreId()` Used in multi-store mode to configure the engine to use the correct store.
`java.lang.String`	`getStoreName()` The name of the store
`java.lang.String`	`getStoreUrl()` The Url of a store
`int`	`getVendorId()` The numeric id of a vendor that may be associated with the store
`boolean`	`isDeleted()` Defines whether the store has been deleted
`boolean`	`isEnabled()` Defines whether the store is enabled
`boolean`	`isTemplate()` Define a store as a template for creating new stores
`boolean`	`isUnderMaintenance()` Defines whether the store is under maintenance
`void`	`setAdminEmail(java.lang.String adminEmail)` Email of the store administrator
`void`	`setCssFileName(java.lang.String cssFileName)` File name of the CSS file used by the store
`void`	`setCustom1(java.lang.String custom1)` Custom attribute
`void`	`setCustom2(java.lang.String custom2)` Custom attribute
`void`	`setCustom3(java.lang.String custom3)` Custom attribute
`void`	`setCustom4(java.lang.String custom4)` Custom attribute
`void`	`setCustom5(java.lang.String custom5)` Custom attribute
`void`	`setDateAdded(java.util.Calendar dateAdded)`
`void`	`setDeleted(boolean deleted)` Defines whether the store has been deleted
`void`	`setEnabled(boolean enabled)` Defines whether the store is enabled
`void`	`setLastUpdated(java.util.Calendar lastUpdated)` When the store was last updated
`void`	`setLogoFileName(java.lang.String logoFileName)` File name of the store logo
`void`	`setMaxProducts(int maxProducts)` The maximum number of products that a store may manage
`void`	`setStoreDesc(java.lang.String storeDesc)` Description of the store
`void`	`setStoreHome(java.lang.String storeHome)` The instance id of a store that can associate it to a KonaKart instance
`void`	`setStoreId(java.lang.String storeId)` Used in multi-store mode to configure the engine to use the correct store.
`void`	`setStoreName(java.lang.String storeName)` The name of the store
`void`	`setStoreUrl(java.lang.String storeUrl)` The Url of a store
`void`	`setTemplate(boolean template)` Define a store as a template for creating new stores
`void`	`setUnderMaintenance(boolean underMaintenance)` Defines whether the store is under maintenance
`void`	`setVendorId(int vendorId)` The numeric id of a vendor that may be associated with the store
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

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

- Constructor Detail
  - Store
```
public Store()
```
    Empty Constructor
  - Store
```
public Store(com.workingdogs.village.Record vr,
             KKCriteria c)
      throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the AdminShop object from a Record object
    
    Parameters:
    
    vr - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the object.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing the attributes of the OrdersStatus object.
  - getStoreId
```
public java.lang.String getStoreId()
```
    Used in multi-store mode to configure the engine to use the correct store.
    
    Specified by:
    
    getStoreId in interface StoreIf
    
    Returns:
    
    Returns the storeId.
  - setStoreId
```
public void setStoreId(java.lang.String storeId)
```
    Used in multi-store mode to configure the engine to use the correct store.
    
    Specified by:
    
    setStoreId in interface StoreIf
    
    Parameters:
    
    storeId - The storeId to set.
  - getStoreName
```
public java.lang.String getStoreName()
```
    Description copied from interface: StoreIf
    
    The name of the store
    
    Specified by:
    
    getStoreName in interface StoreIf
    
    Returns:
    
    the shopName
  - setStoreName
```
public void setStoreName(java.lang.String storeName)
```
    Description copied from interface: StoreIf
    
    The name of the store
    
    Specified by:
    
    setStoreName in interface StoreIf
    
    Parameters:
    
    storeName - the shopName to set
  - isDeleted
```
public boolean isDeleted()
```
    Description copied from interface: StoreIf
    
    Defines whether the store has been deleted
    
    Specified by:
    
    isDeleted in interface StoreIf
    
    Returns:
    
    the deleted
  - setDeleted
```
public void setDeleted(boolean deleted)
```
    Description copied from interface: StoreIf
    
    Defines whether the store has been deleted
    
    Specified by:
    
    setDeleted in interface StoreIf
    
    Parameters:
    
    deleted - the deleted to set
  - getLastUpdated
```
public java.util.Calendar getLastUpdated()
```
    Description copied from interface: StoreIf
    
    When the store was last updated
    
    Specified by:
    
    getLastUpdated in interface StoreIf
    
    Returns:
    
    the lastUpdated
  - setLastUpdated
```
public void setLastUpdated(java.util.Calendar lastUpdated)
```
    Description copied from interface: StoreIf
    
    When the store was last updated
    
    Specified by:
    
    setLastUpdated in interface StoreIf
    
    Parameters:
    
    lastUpdated - the lastUpdated to set
  - getStoreDesc
```
public java.lang.String getStoreDesc()
```
    Description copied from interface: StoreIf
    
    Description of the store
    
    Specified by:
    
    getStoreDesc in interface StoreIf
    
    Returns:
    
    the storeDesc
  - setStoreDesc
```
public void setStoreDesc(java.lang.String storeDesc)
```
    Description copied from interface: StoreIf
    
    Description of the store
    
    Specified by:
    
    setStoreDesc in interface StoreIf
    
    Parameters:
    
    storeDesc - the storeDesc to set
  - getLogoFileName
```
public java.lang.String getLogoFileName()
```
    Description copied from interface: StoreIf
    
    File name of the store logo
    
    Specified by:
    
    getLogoFileName in interface StoreIf
    
    Returns:
    
    the logoFileName
  - setLogoFileName
```
public void setLogoFileName(java.lang.String logoFileName)
```
    Description copied from interface: StoreIf
    
    File name of the store logo
    
    Specified by:
    
    setLogoFileName in interface StoreIf
    
    Parameters:
    
    logoFileName - the logoFileName to set
  - getCssFileName
```
public java.lang.String getCssFileName()
```
    Description copied from interface: StoreIf
    
    File name of the CSS file used by the store
    
    Specified by:
    
    getCssFileName in interface StoreIf
    
    Returns:
    
    the cssFileName
  - setCssFileName
```
public void setCssFileName(java.lang.String cssFileName)
```
    Description copied from interface: StoreIf
    
    File name of the CSS file used by the store
    
    Specified by:
    
    setCssFileName in interface StoreIf
    
    Parameters:
    
    cssFileName - the cssFileName to set
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: StoreIf
    
    Defines whether the store is enabled
    
    Specified by:
    
    isEnabled in interface StoreIf
    
    Returns:
    
    the enabled
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from interface: StoreIf
    
    Defines whether the store is enabled
    
    Specified by:
    
    setEnabled in interface StoreIf
    
    Parameters:
    
    enabled - the enabled to set
  - isUnderMaintenance
```
public boolean isUnderMaintenance()
```
    Description copied from interface: StoreIf
    
    Defines whether the store is under maintenance
    
    Specified by:
    
    isUnderMaintenance in interface StoreIf
    
    Returns:
    
    the underMaintenance
  - setUnderMaintenance
```
public void setUnderMaintenance(boolean underMaintenance)
```
    Description copied from interface: StoreIf
    
    Defines whether the store is under maintenance
    
    Specified by:
    
    setUnderMaintenance in interface StoreIf
    
    Parameters:
    
    underMaintenance - the underMaintenance to set
  - getAdminEmail
```
public java.lang.String getAdminEmail()
```
    Description copied from interface: StoreIf
    
    Email of the store administrator
    
    Specified by:
    
    getAdminEmail in interface StoreIf
    
    Returns:
    
    the adminEmail
  - setAdminEmail
```
public void setAdminEmail(java.lang.String adminEmail)
```
    Description copied from interface: StoreIf
    
    Email of the store administrator
    
    Specified by:
    
    setAdminEmail in interface StoreIf
    
    Parameters:
    
    adminEmail - the adminEmail to set
  - isTemplate
```
public boolean isTemplate()
```
    Description copied from interface: StoreIf
    
    Define a store as a template for creating new stores
    
    Specified by:
    
    isTemplate in interface StoreIf
    
    Returns:
    
    the template
  - setTemplate
```
public void setTemplate(boolean template)
```
    Description copied from interface: StoreIf
    
    Define a store as a template for creating new stores
    
    Specified by:
    
    setTemplate in interface StoreIf
    
    Parameters:
    
    template - the template to set
  - getMaxProducts
```
public int getMaxProducts()
```
    Description copied from interface: StoreIf
    
    The maximum number of products that a store may manage
    
    Specified by:
    
    getMaxProducts in interface StoreIf
    
    Returns:
    
    the maxProducts
  - setMaxProducts
```
public void setMaxProducts(int maxProducts)
```
    Description copied from interface: StoreIf
    
    The maximum number of products that a store may manage
    
    Specified by:
    
    setMaxProducts in interface StoreIf
    
    Parameters:
    
    maxProducts - the maxProducts to set
  - getStoreHome
```
public java.lang.String getStoreHome()
```
    Description copied from interface: StoreIf
    
    The instance id of a store that can associate it to a KonaKart instance
    
    Specified by:
    
    getStoreHome in interface StoreIf
    
    Returns:
    
    the storeHome
  - setStoreHome
```
public void setStoreHome(java.lang.String storeHome)
```
    Description copied from interface: StoreIf
    
    The instance id of a store that can associate it to a KonaKart instance
    
    Specified by:
    
    setStoreHome in interface StoreIf
    
    Parameters:
    
    storeHome - the storeHome to set
  - getStoreUrl
```
public java.lang.String getStoreUrl()
```
    Description copied from interface: StoreIf
    
    The Url of a store
    
    Specified by:
    
    getStoreUrl in interface StoreIf
    
    Returns:
    
    the storeUrl
  - setStoreUrl
```
public void setStoreUrl(java.lang.String storeUrl)
```
    Description copied from interface: StoreIf
    
    The Url of a store
    
    Specified by:
    
    setStoreUrl in interface StoreIf
    
    Parameters:
    
    storeUrl - the storeUrl to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    getCustom1 in interface StoreIf
    
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    setCustom1 in interface StoreIf
    
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    getCustom2 in interface StoreIf
    
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    setCustom2 in interface StoreIf
    
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    getCustom3 in interface StoreIf
    
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    setCustom3 in interface StoreIf
    
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
public java.lang.String getCustom4()
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    getCustom4 in interface StoreIf
    
    Returns:
    
    the custom4
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    setCustom4 in interface StoreIf
    
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom5
```
public java.lang.String getCustom5()
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    getCustom5 in interface StoreIf
    
    Returns:
    
    the custom5
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Description copied from interface: StoreIf
    
    Custom attribute
    
    Specified by:
    
    setCustom5 in interface StoreIf
    
    Parameters:
    
    custom5 - the custom5 to set
  - getDateAdded
```
public java.util.Calendar getDateAdded()
```
    Specified by:
    
    getDateAdded in interface StoreIf
    
    Returns:
    
    the dateAdded
  - setDateAdded
```
public void setDateAdded(java.util.Calendar dateAdded)
```
    Specified by:
    
    setDateAdded in interface StoreIf
    
    Parameters:
    
    dateAdded - the dateAdded to set
  - getVendorId
```
public int getVendorId()
```
    Description copied from interface: StoreIf
    
    The numeric id of a vendor that may be associated with the store
    
    Specified by:
    
    getVendorId in interface StoreIf
    
    Returns:
    
    the vendorId
  - setVendorId
```
public void setVendorId(int vendorId)
```
    Description copied from interface: StoreIf
    
    The numeric id of a vendor that may be associated with the store
    
    Specified by:
    
    setVendorId in interface StoreIf
    
    Parameters:
    
    vendorId - the vendorId to set

Class Store

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Store

Store

Method Detail

toString

toStringBrief

getStoreId

setStoreId

getStoreName

setStoreName

isDeleted

setDeleted

getLastUpdated

setLastUpdated

getStoreDesc

setStoreDesc

getLogoFileName

setLogoFileName

getCssFileName

setCssFileName

isEnabled

setEnabled

isUnderMaintenance

setUnderMaintenance

getAdminEmail

setAdminEmail

isTemplate

setTemplate

getMaxProducts

setMaxProducts

getStoreHome

setStoreHome

getStoreUrl

setStoreUrl

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getDateAdded

setDateAdded

getVendorId

setVendorId