|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.SysConfig
public class SysConfig
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 |
---|
public static final java.lang.Class<SysConfig> CLASS
Constructor Detail |
---|
public SysConfig(APIClientConnection conn)
conn
- Method Detail |
---|
public static SysConfig findById(APIClientConnection conn, java.lang.String parameterName) throws java.io.IOException, ServiceException
conn
- parameterName
- The name to retrieve, e.g.: "console_url"
java.io.IOException
ServiceException
public static java.util.List<SysConfig> findAll(APIClientConnection conn) throws java.io.IOException, ServiceException
conn
-
java.io.IOException
ServiceException
public SysConfig update() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public java.lang.String getDataType()
public java.lang.String getDefaultValue()
public java.lang.String getDescription()
public boolean getIsPublic()
true
) or not (false
) this parameter is directly editable by an Administrative console user
public java.lang.String getName()
public java.lang.String getTitle()
public java.lang.String getValidate()
public java.lang.String getValue()
public void setDataType(java.lang.String dataType)
dataType
- public void setDefaultValue(java.lang.String defaultValue)
defaultValue
- public void setDescription(java.lang.String description)
description
- public void setIsPublic(boolean isPublic)
true
) or not (false
) this parameter is directly editable by an Administrative console user
isPublic
- public void setName(java.lang.String name)
name
- public void setTitle(java.lang.String title)
title
- public void setValidate(java.lang.String validate)
validate
- public void setValue(java.lang.String value)
value
- public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |