|
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.CfgService
public class CfgService
Solutions are sets of functions that applications provide. Solutions accomplish particular business tasks in contact centers. The
components
list of a solution can be
populated based on the list of the componentDefinitions the solution
is based on. Then, an application for each component within the
solution should be assigned according to the type of application
specified in SolutionComponentDefinition
this
solution component is based on and whether or not a
solution component is mandatory or optional. Parameters appType,
appVersion, and startupPriority
are READONLY
within solution.
It shall be possible to edit the components
list
of a solution in such a way that one or more copies of a solution
component already defined within the solution can be created. If
such a copy is made, a unique identifier of an application with
the type suitable for the newly created component could be assigned
to appDBID
parameter in this component.
The fact that more than one solution component within a solution may have the
same appType, appVersion
and startupPriority
implies
that the order of activation of corresponding applications within the solution
may be chosen arbitrarily.
For compatibility purposes between 5.1.xx and 5.9.xxx, objects
of type
CfgService
that exist in 5.1.xxx release will
have solutionType=CFGSTDefaultSolutionType.
If one solution component is used by two different solutions,
both solutions should refer to same application of CFGSCS
type
(SCSDBID
)
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgService(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgService(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgService(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 | |
---|---|
CfgTenant |
getAssignedTenant()
A unique identifier of the
Tenant
the solution is assigned to. |
java.lang.Integer |
getAssignedTenantDBID()
Retrieves the dbid of the object that is being linked to by the AssignedTenant property. |
java.util.Collection<CfgSolutionComponentDefinition> |
getComponentDefinitions()
A pointer to a list of predefined solution components for this solution. |
java.util.Collection<CfgSolutionComponent> |
getComponents()
A pointer to a list of solution components defined for this solution (every item of this list is structured as
CfgSolutionComponent
). |
java.lang.Integer |
getDBID()
An identifier of this object in the Configuration Database. |
java.lang.String |
getName()
A pointer to the name of the service/solution. |
java.util.Collection<CfgObjectResource> |
getResources()
|
CfgApplication |
getSCS()
A unique identifier of an
Application
of CFGSCS type which is supposed to control
the solution. |
java.lang.Integer |
getSCSDBID()
Retrieves the dbid of the object that is being linked to by the SCS property. |
CfgSolutionType |
getSolutionType()
The type of the solution. |
CfgStartupType |
getStartupType()
A type of solution/service startup. |
CfgObjectState |
getState()
Current object state. |
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 version of the solution. |
void |
save()
Synchronizes changes in the class with Configuration Server. |
void |
setAssignedTenant(CfgTenant value)
A unique identifier of the
Tenant
the solution is assigned to. |
void |
setAssignedTenantDBID(int dbid)
A unique identifier of the
Tenant
the solution is assigned to. |
void |
setComponentDefinitions(java.util.Collection<CfgSolutionComponentDefinition> value)
A pointer to a list of predefined solution components for this solution. |
void |
setComponents(java.util.Collection<CfgSolutionComponent> value)
A pointer to a list of solution components defined for this solution (every item of this list is structured as
CfgSolutionComponent
). |
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 service/solution. |
void |
setResources(java.util.Collection<CfgObjectResource> value)
|
void |
setSCS(CfgApplication value)
A unique identifier of an
Application
of CFGSCS type which is supposed to control
the solution. |
void |
setSCSDBID(int dbid)
A unique identifier of an
Application
of CFGSCS type which is supposed to control
the solution. |
void |
setSolutionType(CfgSolutionType value)
The type of the solution. |
void |
setStartupType(CfgStartupType value)
A type of solution/service startup. |
void |
setState(CfgObjectState value)
Current object state. |
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 version of the solution. |
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 CfgService(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 CfgService(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 CfgService(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 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()
public final CfgSolutionType getSolutionType()
CfgSolutionType
.
public final void setSolutionType(CfgSolutionType value)
CfgSolutionType
.
value
- new property valuegetSolutionType()
public final java.util.Collection<CfgSolutionComponent> getComponents()
CfgSolutionComponent
).
When used as an entry in CfgDeltaService
, it is a pointer to a list of solution
components added to the existing list.
public final void setComponents(java.util.Collection<CfgSolutionComponent> value)
CfgSolutionComponent
).
When used as an entry in CfgDeltaService
, it is a pointer to a list of solution
components added to the existing list.
value
- new property valuegetComponents()
public final CfgApplication getSCS()
Application
of CFGSCS
type which is supposed to control
the solution. See comment number 4. See also
CfgSolutionComponent
.
public final void setSCS(CfgApplication value)
Application
of CFGSCS
type which is supposed to control
the solution. See comment number 4. See also
CfgSolutionComponent
.
value
- new property valuegetSCS()
public final void setSCSDBID(int dbid)
Application
of CFGSCS
type which is supposed to control
the solution. See comment number 4. See also
CfgSolutionComponent
.
dbid
- DBID identifier of referred objectgetSCS()
public final java.lang.Integer getSCSDBID()
public final CfgTenant getAssignedTenant()
Tenant
the solution is assigned to. Optional. If assignedTenantDBID is managed
(added/modified/removed)
by configuration wizard , the same action (add/modify/remove) has
to be initiated by wizard for property tenantDBIDs
of CfgApplication
if an application belongs to this solution.
public final void setAssignedTenant(CfgTenant value)
Tenant
the solution is assigned to. Optional. If assignedTenantDBID is managed
(added/modified/removed)
by configuration wizard , the same action (add/modify/remove) has
to be initiated by wizard for property tenantDBIDs
of CfgApplication
if an application belongs to this solution.
value
- new property valuegetAssignedTenant()
public final void setAssignedTenantDBID(int dbid)
Tenant
the solution is assigned to. Optional. If assignedTenantDBID is managed
(added/modified/removed)
by configuration wizard , the same action (add/modify/remove) has
to be initiated by wizard for property tenantDBIDs
of CfgApplication
if an application belongs to this solution.
dbid
- DBID identifier of referred objectgetAssignedTenant()
public final java.lang.Integer getAssignedTenantDBID()
public final java.lang.String getVersion()
public final void setVersion(java.lang.String value)
value
- new property valuegetVersion()
public final java.util.Collection<CfgSolutionComponentDefinition> getComponentDefinitions()
CfgSolutionComponentDefinition
.)
public final void setComponentDefinitions(java.util.Collection<CfgSolutionComponentDefinition> value)
CfgSolutionComponentDefinition
.)
value
- new property valuegetComponentDefinitions()
public final CfgStartupType getStartupType()
CfgStartupType.
Read-only. Specified during application prototype definition. The value is
associated with solution type
CfgSolutionType.
The value for the solutions of
CFGSTDefaultSolutionType
and CFGSTFramework
type
is set to CFGSUTManual,
and for other applications
is set to CFGSUTAutomatic.
public final void setStartupType(CfgStartupType value)
CfgStartupType.
Read-only. Specified during application prototype definition. The value is
associated with solution type
CfgSolutionType.
The value for the solutions of
CFGSTDefaultSolutionType
and CFGSTFramework
type
is set to CFGSUTManual,
and for other applications
is set to CFGSUTAutomatic.
value
- new property valuegetStartupType()
public final java.util.Collection<CfgObjectResource> getResources()
public final void setResources(java.util.Collection<CfgObjectResource> value)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |