Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaScheduledTask

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgObject
          extended by com.genesyslab.platform.applicationblocks.com.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaScheduledTask
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaScheduledTask
extends CfgDelta

The changes to make to a CfgScheduledTask object.


Constructor Summary
CfgDeltaScheduledTask(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaScheduledTask(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaScheduledTask(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<CfgObjectResource> getAddedResources()
          A pointer to the list of the objects associated with this ScheduledTask (every item of this list is structured as CfgObjectResource ).
 KeyValueCollection getAddedUserProperties()
          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.util.Collection<CfgObjectResource> getChangedResources()
          A pointer to the list of structures CfgObjectResource type.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getDBID()
          The DBID of the target CfgScheduledTask configuration object.
 java.util.Collection<CfgResourceID> getDeletedResources()
          A pointer to the list of deleted resources (every item of this list is structured as CfgID ).
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          An optional short description of this ScheduledTask.
 java.lang.String getName()
          A pointer to name of the ScheduledTask.
 java.lang.Integer getStartTime()
          The time the task is to begin.
 CfgObjectState getState()
          Current object state.
 CfgTaskType getType()
          Type of the ScheduledTask.
 CfgScheduledTask retrieveCfgScheduledTask()
          Read base CfgScheduledTask configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaScheduledTask

public CfgDeltaScheduledTask(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance

CfgDeltaScheduledTask

public CfgDeltaScheduledTask(IConfService confService,
                             ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaScheduledTask

public CfgDeltaScheduledTask(IConfService confService,
                             org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgScheduledTask configuration object.

Returns:
target object DBID

retrieveCfgScheduledTask

public final CfgScheduledTask retrieveCfgScheduledTask()
                                                throws ConfigException
Read base CfgScheduledTask configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

getName

public final java.lang.String getName()
A pointer to name of the ScheduledTask. Mandatory. Must be unique within the Configuration Database.

Returns:
property value or null

getType

public final CfgTaskType getType()
Type of the ScheduledTask. Mandatory. Once specified, cannot be changed. See type CfgTaskType .

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
An optional short description of this ScheduledTask.

Returns:
property value or null

getStartTime

public final java.lang.Integer getStartTime()
The time the task is to begin.

Returns:
property value or null

getAddedResources

public final java.util.Collection<CfgObjectResource> getAddedResources()
A pointer to the list of the objects associated with this ScheduledTask (every item of this list is structured as 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

Returns:
list of structures or null

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()
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.

Returns:
property value or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

getDeletedResources

public final java.util.Collection<CfgResourceID> getDeletedResources()
A pointer to the list of deleted resources (every item of this list is structured as CfgID ).

Returns:
list of structures or null

getChangedResources

public final java.util.Collection<CfgObjectResource> getChangedResources()
A pointer to the list of structures CfgObjectResource type. Each structure contains information about the resource parameters that have been changed.

Returns:
list of structures or null

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.