com.pepper.platform.program
Class PepperProgramConfig

java.lang.Object
  extended by com.pepper.platform.program.PepperProgramConfig

public class PepperProgramConfig
extends Object

The PepperProgramConfig class encapsulates the properties of an individual Pepper package/program.


Field Summary
static String CLASS_NAME
          Class Name
static String COVER
          Cover
static String DELETABLE
           
static String DESCRIPTION
          Description
static String DISPLAY_NAME
          Display Name
static String DOWNLOAD_DOMAIN_TYPES
           
static String ICON
          Icon
static String MIME_TYPES
           
static String PACKAGE_OWNER
          Package owner
static String PACKAGE_OWNER_MAC
          MAC for Package owner value
static String PAGES_LIMIT
          New pages limit
static String PROGRAM_TYPE
          Program Type
static String SECTION
          Section
static String SINGLETON
           
static String THUMB_IMAGE
          Thumb Image
static String TITLE
          Title
static String UNIQUE_ID
          Unique ID
static String URL
          URL
static String VERSION
          Version
 
Constructor Summary
PepperProgramConfig(Properties configInfo)
          Constructs a new PepperProgramConfig object for this package with the given parameters.
 
Method Summary
 String getClassName()
          Returns the package's CLASS_NAME property value.
 String getCoverPage()
          Returns the package's COVER property value.
 String getDisplayName()
          Returns the package's DISPLAY_NAME property value.
 String getIcon()
          Returns the package's ICON property value.
 Object getObjectProperty(String key)
          Get the property as an object
 String getPackageOwner()
          Returns the package's PackageOwner property value.
 String getPackageOwnerMAC()
          Returns the package's PackageOwnerMAC property value.
 String getPagesLimit()
          Returns the package's PagesLimit property value.
 String getProgramDescription()
          Returns the package's DESCRIPTION property value.
 String getProgramType()
          Returns the package's PROGRAM_TYPE property value.
 String getProgramVersion()
          Returns the package's VERSION property value.
 String getProperty(String key)
          Returns the specified property value for this package.
 String getSectionName()
          Returns the package's SECTION_NAME property value.
 String getThumbImage()
          Returns the package's THUMB_IMAGE property value.
 String getTitle()
          Returns the package's TITLE property value.
 String getUniqueId()
          Returns the package's UNIQUE_ID property value.
 String getURL()
          Return the package's URL property value.
 boolean isDeletable()
          Return true if the package can be deleted.
 boolean isSingleton()
          Return true if there should only be one instance of the package in a Keeper.
 void setClassName(String value)
          Sets the package's CLASS_NAME property value.
 void setCoverPage(String coverPage)
          Sets the package's COVER property value.
 void setDisplayName(String value)
          Sets the package's DISPLAY_NAME property value.
 void setIcon(String imagePath)
          Sets the package's ICON property value.
 void setObjectProperty(String key, Object value)
          Set the property as an object
 void setPackageOwner(String owner)
          Set the package's PackageOwner property value.
 void setPackageOwnerMAC(String ownerMAC)
          Set the package's PackageOwnerMAC property value.
 void setProgramDescription(String value)
          Sets the package's DESCRIPTION property value.
 void setProgramType(String programType)
          Sets the package's PROGRAM_TYPE property value.
 void setProgramVersion(String value)
          Sets the package's VERSION property value.
 void setProperties(Properties props)
          Sets the properties of this PepperProgramConfig object.
 void setProperty(String key, String value)
          Sets a specified property.
 void setSectionName(String value)
          Sets the package's SECTION_NAME property value.
 void setThumbImage(String imagePath)
          Sets the package's THUMB_IMAGE property value.
 void setTitle(String value)
          Sets the package's TITLE property value.
 void setUniqueId(String id)
           
 void setURL(String value)
          Sets the package's URL property value.
 String toString()
          Returns a string representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TITLE

public static String TITLE
Title

Since:
3.2

DISPLAY_NAME

public static String DISPLAY_NAME
Display Name


CLASS_NAME

public static String CLASS_NAME
Class Name


VERSION

public static String VERSION
Version


DESCRIPTION

public static String DESCRIPTION
Description


ICON

public static String ICON
Icon


SECTION

public static String SECTION
Section


URL

public static String URL
URL


COVER

public static String COVER
Cover


THUMB_IMAGE

public static String THUMB_IMAGE
Thumb Image


UNIQUE_ID

public static String UNIQUE_ID
Unique ID


PROGRAM_TYPE

public static String PROGRAM_TYPE
Program Type


PAGES_LIMIT

public static String PAGES_LIMIT
New pages limit


PACKAGE_OWNER

public static String PACKAGE_OWNER
Package owner


PACKAGE_OWNER_MAC

public static String PACKAGE_OWNER_MAC
MAC for Package owner value


MIME_TYPES

public static String MIME_TYPES

DOWNLOAD_DOMAIN_TYPES

public static String DOWNLOAD_DOMAIN_TYPES

DELETABLE

public static String DELETABLE

SINGLETON

public static String SINGLETON
Constructor Detail

PepperProgramConfig

public PepperProgramConfig(Properties configInfo)
Constructs a new PepperProgramConfig object for this package with the given parameters.

Parameters:
configInfo - a Properties object specifying the properties for the package.
Method Detail

setProperties

public void setProperties(Properties props)
Sets the properties of this PepperProgramConfig object.

Parameters:
props - a Properties object specifying the program properties.

setProperty

public void setProperty(String key,
                        String value)
Sets a specified property.

Parameters:
key - a String specifying the property key to be set.
value - a String specifying the new value of the property.

getSectionName

public String getSectionName()
Returns the package's SECTION_NAME property value.

Returns:
a String containing the value of the package's SECTION property.

setSectionName

public void setSectionName(String value)
Sets the package's SECTION_NAME property value.

Parameters:
value - a String containing the value of the SECTION property to set.

setCoverPage

public void setCoverPage(String coverPage)
Sets the package's COVER property value.

Parameters:
coverPage - a String containing the value of the COVER property to set.

getCoverPage

public String getCoverPage()
Returns the package's COVER property value.

Returns:
a String containing the value of the package's COVER property.

getProperty

public String getProperty(String key)
Returns the specified property value for this package.

Parameters:
key - a String value containing the key name of the property to retrieve.
Returns:
a String containing the value of the specified property for this package.

setObjectProperty

public void setObjectProperty(String key,
                              Object value)
Set the property as an object

Parameters:
key - a String value
value - an Object value

getObjectProperty

public Object getObjectProperty(String key)
Get the property as an object

Parameters:
key - a String value
Returns:
an Object value

getTitle

public String getTitle()
Returns the package's TITLE property value.

Returns:
a String containing the value of the package's TITLE property.
Since:
3.2

setTitle

public void setTitle(String value)
Sets the package's TITLE property value.

Parameters:
value - a String containing the value of the TITLE property to set.
Since:
3.2

getDisplayName

public String getDisplayName()
Returns the package's DISPLAY_NAME property value.

Returns:
a String containing the value of the package's DISPLAY_NAME property.

setDisplayName

public void setDisplayName(String value)
Sets the package's DISPLAY_NAME property value.

Parameters:
value - a String containing the value of the DISPLAY_NAME property to set.

getClassName

public String getClassName()
Returns the package's CLASS_NAME property value.

Returns:
a String containing the value of the package's CLASS_NAME property.

setClassName

public void setClassName(String value)
Sets the package's CLASS_NAME property value.

Parameters:
value - a String containing the value of the CLASS_NAME property to set.

getURL

public String getURL()
Return the package's URL property value.

Returns:
a String containing the value of the package's URL property.

setURL

public void setURL(String value)
Sets the package's URL property value.

Parameters:
value - a String containing the value of the CLASS_NAME property to set.

getProgramVersion

public String getProgramVersion()
Returns the package's VERSION property value.

Returns:
a String containing the value of the package's VERSION property.

setProgramVersion

public void setProgramVersion(String value)
Sets the package's VERSION property value.

Parameters:
value - a String containing the value of the VERSION property to set.

getUniqueId

public String getUniqueId()
Returns the package's UNIQUE_ID property value. This is equivalent to the package id for the package (i.e. BillsJournal-12345667)

Returns:
a String containing the value of the package's UNIQUE_ID property.

setUniqueId

public void setUniqueId(String id)

getProgramDescription

public String getProgramDescription()
Returns the package's DESCRIPTION property value.

Returns:
a String containing the value of the package's DESCRIPTION property.

setProgramDescription

public void setProgramDescription(String value)
Sets the package's DESCRIPTION property value.

Parameters:
value - a String containing the value of the DESCRIPTION property to set.

getThumbImage

public String getThumbImage()
Returns the package's THUMB_IMAGE property value.

Returns:
a String containing the value of the package's THUMB_IMAGE property.

setThumbImage

public void setThumbImage(String imagePath)
Sets the package's THUMB_IMAGE property value.

Parameters:
imagePath - a String containing the value of the THUMB_IMAGE property to set.

getIcon

public String getIcon()
Returns the package's ICON property value.

Returns:
a String containing the value of the package's ICON property.

setIcon

public void setIcon(String imagePath)
Sets the package's ICON property value.

Parameters:
imagePath - a String containing the value of the ICON property to set.

getProgramType

public String getProgramType()
Returns the package's PROGRAM_TYPE property value.

Returns:
a String containing the value of the package's PROGRAM_TYPE property.

setProgramType

public void setProgramType(String programType)
Sets the package's PROGRAM_TYPE property value.

Parameters:
programType - a String containing the value of the PROGRAM_TYPE property to set.

getPagesLimit

public String getPagesLimit()
Returns the package's PagesLimit property value.

Returns:
a String containing the value of the package's PROGRAM_TYPE property.

getPackageOwner

public String getPackageOwner()
Returns the package's PackageOwner property value.

Returns:
a String containing the value of the package's PACKAGE_OWNER property.

setPackageOwner

public void setPackageOwner(String owner)
Set the package's PackageOwner property value.

Parameters:
owner - value for the owner.

getPackageOwnerMAC

public String getPackageOwnerMAC()
Returns the package's PackageOwnerMAC property value.

Returns:
a String containing the value of the package's PACKAGE_OWNER_MAC property.

setPackageOwnerMAC

public void setPackageOwnerMAC(String ownerMAC)
Set the package's PackageOwnerMAC property value.

Parameters:
ownerMAC - value for the owner.

isDeletable

public boolean isDeletable()
Return true if the package can be deleted.

Returns:
true if the package can be deleted

isSingleton

public boolean isSingleton()
Return true if there should only be one instance of the package in a Keeper.

Returns:
true if there should only be one instance of the package in a Keeper.

toString

public String toString()
Returns a string representation of this object.

Overrides:
toString in class Object
Returns:
a String value containing the NAME, DESCRIPTION, VERSION and CLASS properties of this package.
See Also:
AbstractPepperProgram


Copyright © 2006-2007 Pepper Computer, Inc. All Rights Reserved.