Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.util.config
Class ConfigPropertyDef

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar] 
java.lang.Object
  |
  +--com.sapportals.wcm.util.config.ConfigPropertyDef
public class ConfigPropertyDef
extends java.lang.Object

ConfigPropertyDef is a definition of a configuration property. Copyright (c) SAP AG 2001-2002

Field Summary
static int BOOLEAN
           
static int EXISTINGFILE
           
static int EXISTINGPATH
           
static int INTEGER
           
static int JAVACLASS
           
static int STRING
           
static int URI
           
static int URL
           
 
Constructor Summary
ConfigPropertyDef(java.lang.String name, java.lang.String displayName, int type, boolean required, java.lang.String defaultValue)
          Create a ConfigPropertyDef.
 
Method Summary
 java.lang.String check(ConfigCollection collection)
          Check if a property matches its definition.
 java.lang.String getDefaultValue()
          Get the default value of the property.
 java.lang.String getDisplayName()
          Get the display name of the configuration property.
 java.lang.String getName()
          Get the name of the configuration property.
 int getType()
          Get the type of the configuration property.
 boolean isRequired()
          Chreck if the configuration property is required.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STRING

public static final int STRING

INTEGER

public static final int INTEGER

EXISTINGPATH

public static final int EXISTINGPATH

EXISTINGFILE

public static final int EXISTINGFILE

JAVACLASS

public static final int JAVACLASS

URL

public static final int URL

URI

public static final int URI

BOOLEAN

public static final int BOOLEAN
Constructor Detail

ConfigPropertyDef

public ConfigPropertyDef(java.lang.String name,
                         java.lang.String displayName,
                         int type,
                         boolean required,
                         java.lang.String defaultValue)
Create a ConfigPropertyDef.
Parameters:
name - The name (relativ path) of the property
displayName - The display name of the property
type - The type of the property. Valid Types are:
  • STRING: A string
  • INTEGER: An integer
  • EXISTINGPATH: A path on the (local) filesystem
  • EXISTINGFILE: A file on the (local) filesystem
  • JAVACLASS: A java class in the (local) classpath
  • URL: A fully qualified URL
  • URI: An URI
  • BOOLEAN: A boolean value (true/false)
    • required - true if the property is required
    defaultValue - The default value of the property (null if none)
Method Detail

getName

public java.lang.String getName()
Get the name of the configuration property.
Returns:
The name of the configuration property

getDisplayName

public java.lang.String getDisplayName()
Get the display name of the configuration property.
Returns:
The display name of the configuration property

getType

public int getType()
Get the type of the configuration property.
Returns:
The type of the configuration property

isRequired

public boolean isRequired()
Chreck if the configuration property is required.
Returns:
true if the configuration property is required

getDefaultValue

public java.lang.String getDefaultValue()
Get the default value of the property.
Returns:
The default value of the property

check

public java.lang.String check(ConfigCollection collection)
Check if a property matches its definition.
Parameters:
collection - The configuration collection to be checked
Returns:
a problem report or null if the check passed
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.