com.buildforge.services.client.dbo
Class SysConfig

java.lang.Object
  extended by com.buildforge.services.client.dbo.SysConfig

public class SysConfig
extends java.lang.Object

SysConfig objects represent system-wide configuration parameters that determine the global behaviour of the Build Forge system. Metadata such as the address of the license server and the port on which the management console is attached are stored in this configuration store.


Field Summary
static java.lang.Class<SysConfig> CLASS
           
 
Constructor Summary
SysConfig(APIClientConnection conn)
          Defines a new SysConfig object
 
Method Summary
static java.util.List<SysConfig> findAll(APIClientConnection conn)
          Retrieves all defined SysConfig parameters.
static SysConfig findById(APIClientConnection conn, java.lang.String parameterName)
          Retrieves a SysConfig parameter by name
 java.lang.String getDataType()
          Returns a description of the type of data stored in this parameter
 java.lang.String getDefaultValue()
          Returns the value used when the actual value is unset
 java.lang.String getDescription()
          Returns the string key into the language table that contains the localized, long description of this parameter
 boolean getIsPublic()
          Returns whether (true) or not (false) this parameter is directly editable by an Administrative console user
 java.lang.String getName()
          Returns the name of this configuration parameter
 java.lang.String getTitle()
          Returns the string key into the language table that contains the localized, short description of this parameter
 java.lang.String getValidate()
          Returns the regular expression used to recognize valid values and reject invalid ones
 java.lang.String getValue()
          Returns the value of this parameter
 void setDataType(java.lang.String dataType)
          Sets a description of the type of data stored in this parameter
 void setDefaultValue(java.lang.String defaultValue)
          sets the value used when the actual value is unset
 void setDescription(java.lang.String description)
          Sets the string key into the language table that contains the localized, long description of this parameter
 void setIsPublic(boolean isPublic)
          Sets whether (true) or not (false) this parameter is directly editable by an Administrative console user
 void setName(java.lang.String name)
          Sets the name of this configuration parameter
 void setTitle(java.lang.String title)
          Sets the string key into the language table that contains the localized, short description of this parameter
 void setValidate(java.lang.String validate)
          Sets the regular expression used to recognize valid values and reject invalid ones
 void setValue(java.lang.String value)
          Sets the value of this parameter
 java.lang.String toString()
           
 SysConfig update()
          Commits any changes to the values of this parameter to the database
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS

public static final java.lang.Class<SysConfig> CLASS
Constructor Detail

SysConfig

public SysConfig(APIClientConnection conn)
Defines a new SysConfig object

Parameters:
conn -
Method Detail

findById

public static SysConfig findById(APIClientConnection conn,
                                 java.lang.String parameterName)
                          throws java.io.IOException,
                                 ServiceException
Retrieves a SysConfig parameter by name

Parameters:
conn -
parameterName - The name to retrieve, e.g.: "console_url"
Returns:
Throws:
java.io.IOException
ServiceException

findAll

public static java.util.List<SysConfig> findAll(APIClientConnection conn)
                                         throws java.io.IOException,
                                                ServiceException
Retrieves all defined SysConfig parameters. For most users, only public SysConfig parameters will be accessible.

Parameters:
conn -
Returns:
Throws:
java.io.IOException
ServiceException

update

public SysConfig update()
                 throws java.io.IOException,
                        ServiceException
Commits any changes to the values of this parameter to the database

Returns:
Throws:
java.io.IOException
ServiceException

getDataType

public java.lang.String getDataType()
Returns a description of the type of data stored in this parameter


getDefaultValue

public java.lang.String getDefaultValue()
Returns the value used when the actual value is unset


getDescription

public java.lang.String getDescription()
Returns the string key into the language table that contains the localized, long description of this parameter


getIsPublic

public boolean getIsPublic()
Returns whether (true) or not (false) this parameter is directly editable by an Administrative console user


getName

public java.lang.String getName()
Returns the name of this configuration parameter


getTitle

public java.lang.String getTitle()
Returns the string key into the language table that contains the localized, short description of this parameter


getValidate

public java.lang.String getValidate()
Returns the regular expression used to recognize valid values and reject invalid ones


getValue

public java.lang.String getValue()
Returns the value of this parameter


setDataType

public void setDataType(java.lang.String dataType)
Sets a description of the type of data stored in this parameter

Parameters:
dataType -

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
sets the value used when the actual value is unset

Parameters:
defaultValue -

setDescription

public void setDescription(java.lang.String description)
Sets the string key into the language table that contains the localized, long description of this parameter

Parameters:
description -

setIsPublic

public void setIsPublic(boolean isPublic)
Sets whether (true) or not (false) this parameter is directly editable by an Administrative console user

Parameters:
isPublic -

setName

public void setName(java.lang.String name)
Sets the name of this configuration parameter

Parameters:
name -

setTitle

public void setTitle(java.lang.String title)
Sets the string key into the language table that contains the localized, short description of this parameter

Parameters:
title -

setValidate

public void setValidate(java.lang.String validate)
Sets the regular expression used to recognize valid values and reject invalid ones

Parameters:
validate -

setValue

public void setValue(java.lang.String value)
Sets the value of this parameter

Parameters:
value -

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object