com.buildforge.services.common.dbo
Class SysConfigDBO
java.lang.Object
com.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.SysConfigDBO
public class SysConfigDBO
- extends DBObject
Database information representing global system configuration data.
These settings control engine-wide behavior, such as the frequency
of automatic purge activity, the idle timeout for user sessions,
and the location of the license key server.
Field Summary |
static java.lang.String |
TYPE_KEY
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
TYPE_KEY
public static final java.lang.String TYPE_KEY
- See Also:
- Constant Field Values
SysConfigDBO
public SysConfigDBO()
getTypeKey
public java.lang.String getTypeKey()
- Description copied from class:
DBObject
- Retrieve the key that should be used to look up the display name
for a data type.
- Specified by:
getTypeKey
in class DBObject
- Returns:
- the type key for this object's class
isLive
public boolean isLive()
- Description copied from class:
DBObject
- Checks whether or not the object is live. Note that this is not
valid for object types that do not have a unique identifier. Those
for which no reasonable implementation exists should always return
false.
- Specified by:
isLive
in class DBObject
- Returns:
- true iff liveness is a valid concept for this object,
and the object is live; otherwise, false is returned.
getDataType
public java.lang.String getDataType()
getDefaultValue
public java.lang.String getDefaultValue()
getDescription
public java.lang.String getDescription()
getIsPublic
public boolean getIsPublic()
getName
public java.lang.String getName()
getTitle
public java.lang.String getTitle()
getValue
public java.lang.String getValue()
getValidate
public java.lang.String getValidate()
setDataType
public void setDataType(java.lang.String dataType)
setDefaultValue
public void setDefaultValue(java.lang.String defaultValue)
setDescription
public void setDescription(java.lang.String description)
setIsPublic
public void setIsPublic(boolean isPublic)
setName
public void setName(java.lang.String name)
setTitle
public void setTitle(java.lang.String title)
setValidate
public void setValidate(java.lang.String validate)
setValue
public void setValue(java.lang.String value)
sanityCheckName
public static void sanityCheckName(java.lang.String paramName)
throws APIException
- Throws:
APIException
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
toArray
public java.lang.Object[] toArray()
- Description copied from class:
DBObject
- Serializes this database object as an array of objects. As
specified in the description for
Protocol
, all supported
protocols transfer database objects in this form.
- Specified by:
toArray
in class DBObject
fromArray
public SysConfigDBO fromArray(java.lang.Object[] data)
throws APIException
- Description copied from class:
DBObject
- Deserialize the database object's settings from a request array.
This method is used to reconstruct a database object from the
array that was created by
DBObject.toArray()
.
- Specified by:
fromArray
in class DBObject
- Parameters:
data
- the object list that renders this object
- Returns:
- this object, for convenience
- Throws:
APIException
- if there is something wrong with the
serialized data that interferes with the reconstruction of
the object. The most obvious reason for this would be if
the serialized array contains the wrong number of fields
or otherwise does not match the serialized form for this
type of database object.