ICfgBase
, ICfgObject
, java.lang.Cloneable
@Generated(value="com.genesyslab.platform.applicationblocks.com.generator.COMGenerator", date="2021-06-14T15:47:12-07:00") public class CfgScheduledTask extends CfgObject
Modifier and Type | Field | Description |
---|---|---|
static CfgObjectType |
OBJECT_TYPE |
Constructor | Description |
---|---|
CfgScheduledTask(IConfService confService) |
This constructor is intended for creation of detached objects.
|
CfgScheduledTask(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters) |
This constructor is intended for creation of objects from configuration protocol messages.
|
CfgScheduledTask(IConfService confService,
org.w3c.dom.Node xmlData,
java.lang.Object[] additionalParameters) |
This constructor is intended for creation of objects from configuration protocol messages.
|
Modifier and Type | Method | Description |
---|---|---|
java.lang.Integer |
getDBID() |
An identifier of this object in the Configuration Database.
|
java.lang.String |
getDescription() |
An optional short description of this ScheduledTask.
|
java.lang.String |
getName() |
A pointer to name of the ScheduledTask.
|
java.util.Collection<CfgObjectResource> |
getResources() |
A pointer to the list of the objects associated with this ScheduledTask
(every item of this list is structured as
CfgObjectResource
). |
java.lang.Integer |
getStartTime() |
The time the task is to begin.
|
CfgObjectState |
getState() |
Current object state.
|
CfgTaskType |
getType() |
Type of the ScheduledTask.
|
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.
|
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 |
setDescription(java.lang.String value) |
An optional short description of this ScheduledTask.
|
void |
setName(java.lang.String value) |
A pointer to name of the ScheduledTask.
|
void |
setResources(java.util.Collection<CfgObjectResource> value) |
A pointer to the list of the objects associated with this ScheduledTask
(every item of this list is structured as
CfgObjectResource
). |
void |
setStartTime(java.lang.Integer value) |
The time the task is to begin.
|
void |
setState(CfgObjectState value) |
Current object state.
|
void |
setType(CfgTaskType value) |
Type of the ScheduledTask.
|
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.
|
equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getParent, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toStringProperties, toXml, updateChildrenSavedState
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, updateACL
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
public static final CfgObjectType OBJECT_TYPE
public CfgScheduledTask(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 CfgScheduledTask(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 CfgScheduledTask(IConfService confService)
confService
- configuration service instancepublic 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 CfgTaskType getType()
CfgTaskType
.public final void setType(CfgTaskType value)
CfgTaskType
.value
- new property valuegetType()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final java.lang.Integer getStartTime()
public final void setStartTime(java.lang.Integer value)
value
- new property valuegetStartTime()
public final java.util.Collection<CfgObjectResource> getResources()
CfgObjectResource
). When used as an entry
in
CfgDeltaScheduledTask
, it is a pointer to a list of resources
added to the existing list.
Only objects of type
CfgHost
,
CfgSwitch
,
CfgGVPCustomer
and
can be associated with ScheduledTask object through resources
public final void setResources(java.util.Collection<CfgObjectResource> value)
CfgObjectResource
). When used as an entry
in
CfgDeltaScheduledTask
, it is a pointer to a list of resources
added to the existing list.
Only objects of type
CfgHost
,
CfgSwitch
,
CfgGVPCustomer
and
can be associated with ScheduledTask object through resources
value
- new property valuegetResources()
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()
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.