Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgScheduledTask

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.objects.CfgScheduledTask
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgScheduledTask
extends CfgObject

A Scheduled Task is a GVP Object in which you schedule the GVP tasks

See also:

CfgDeltaScheduledTask


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
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.
 
Method Summary
 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.
 
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

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgScheduledTask

public CfgScheduledTask(IConfService confService,
                        ConfObject objData,
                        boolean isSaved,
                        java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgScheduledTask

public CfgScheduledTask(IConfService confService,
                        org.w3c.dom.Node xmlData,
                        java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgScheduledTask

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

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

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

setName

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

Parameters:
value - new property value
See Also:
getName()

getType

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

Returns:
property value or null

setType

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

Parameters:
value - new property value
See Also:
getType()

getDescription

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

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
An optional short description of this ScheduledTask.

Parameters:
value - new property value
See Also:
getDescription()

getStartTime

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

Returns:
property value or null

setStartTime

public final void setStartTime(java.lang.Integer value)
The time the task is to begin.

Parameters:
value - new property value
See Also:
getStartTime()

getResources

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

setResources

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

Parameters:
value - new property value
See Also:
getResources()

getState

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

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final 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.

Returns:
property value or null

setUserProperties

public final 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.

Parameters:
value - new property value
See Also:
getUserProperties()

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.