|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgAppPrototype
public class CfgAppPrototype
An application prototype. An application prototype cannot be deleted as long as there is at least one application associated with it. Parameter
options
has the following structure:
Each key-value pair of the primary list (TKVList *options
) uses
the key for the name of a configuration section, and the value for a secondary
list, that also has the TKVList
structure and specifies the
configuration options defined within that section. Each key-value pair of the
secondary list uses the key for the name of a configuration option, and the
value for its current setting. Configuration options can be defined as variables
of integer, character, or binary type. Names of sections must be
unique within the primary list. Names of options must be unique
within the secondary list. NOTE: Configuration Server is not concerned with
logical meanings of application-specific configuration sections,
options, or their values.
An application prototype of CFGConfigServer
type
with DBID
set to 99
shall be pre-defined (scripted)
in the Configuration Database before Configuration
Server is started for the first time. The object that represents
this application prototype cannot be deleted.
An application prototype of CFGSCE
type with
DBID
set to 100
shall be pre-defined (scripted)
in the Configuration Database before Configuration
Server is started for the first time. The object that represents
this application prototype cannot be deleted.
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgAppPrototype(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgAppPrototype(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgAppPrototype(IConfService confService,
org.w3c.dom.Node xmlData,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
Method Summary | |
---|---|
java.lang.Integer |
getDBID()
An identifier of this object in the Configuration Database. |
java.lang.String |
getName()
A pointer to the name of the application prototype. |
KeyValueCollection |
getOptions()
A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below). |
CfgObjectState |
getState()
Current object state. |
CfgAppType |
getType()
Type of the application. |
KeyValueCollection |
getUserProperties()
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section. |
java.lang.String |
getVersion()
A pointer to the application version. |
void |
save()
Synchronizes changes in the class with Configuration Server. |
void |
setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. |
void |
setName(java.lang.String value)
A pointer to the name of the application prototype. |
void |
setOptions(KeyValueCollection value)
A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below). |
void |
setState(CfgObjectState value)
Current object state. |
void |
setType(CfgAppType value)
Type of the application. |
void |
setUserProperties(KeyValueCollection value)
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section. |
void |
setVersion(java.lang.String value)
A pointer to the application version. |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject |
---|
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, updateACL |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase |
---|
equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getParent, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toStringProperties, toXml, updateChildrenSavedState |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase |
---|
getEndpoint, getProperty, getRawObjectData, setProperty, toXml |
Field Detail |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgAppPrototype(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgAppPrototype(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgAppPrototype(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final CfgAppType getType()
CfgAppType
.
public final void setType(CfgAppType value)
CfgAppType
.
value
- new property valuegetType()
public final java.lang.String getVersion()
public final void setVersion(java.lang.String value)
value
- new property valuegetVersion()
public final KeyValueCollection getOptions()
CfgDeltaApplication
, it is
a pointer to a list of options added to the existing list.
public final void setOptions(KeyValueCollection value)
CfgDeltaApplication
, it is
a pointer to a list of options added to the existing list.
value
- new property valuegetOptions()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |