Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.configuration.protocol.confserver.requests.objects
Class RequestDeleteObject

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.DataObject
      extended bycom.genesyslab.platform.commons.protocol.Message
          extended bycom.genesyslab.platform.configuration.protocol.confserver.requests.objects.RequestDeleteObject
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestDeleteObject
extends Message

A request to delete an object from the Genesys Configuration Layer.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestDeleteObject create()
          Creates instance of RequestDeleteObject with no parameters set.
static RequestDeleteObject create(java.lang.Integer objectType, java.lang.Integer dbid)
          Creates instance of RequestDeleteObject with required parameters set.
static RequestDeleteObject create(java.lang.Integer objectType, java.lang.Integer dbid, KeyValueCollection parameters)
          Creates instance of RequestDeleteObject with all parameters set.
abstract  java.lang.Integer getDbid()
          An identifier of an object in the Configuration Database.
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  KeyValueCollection getParameters()
          TKVList containing additional parameters (if needed)
abstract  java.lang.Integer getReferenceId()
          Reference id to connect responce to request.
abstract  void setDbid(int dbid)
          An identifier of an object in the Configuration Database.
abstract  void setDbid(java.lang.Integer dbid)
          An identifier of an object in the Configuration Database.
abstract  void setObjectType(int objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setObjectType(java.lang.Integer objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setParameters(KeyValueCollection parameters)
          TKVList containing additional parameters (if needed)
abstract  void setReferenceId(int referenceId)
          Reference id to connect responce to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference id to connect responce to request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestDeleteObject create()
Creates instance of RequestDeleteObject with no parameters set.

Returns:
instance of RequestDeleteObject

create

public static RequestDeleteObject create(java.lang.Integer objectType,
                                         java.lang.Integer dbid,
                                         KeyValueCollection parameters)
Creates instance of RequestDeleteObject with all parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
dbid - An identifier of an object in the Configuration Database. Generated by Configuration Server and is unique within an object type
parameters - TKVList containing additional parameters (if needed)
Returns:
instance of RequestDeleteObject

create

public static RequestDeleteObject create(java.lang.Integer objectType,
                                         java.lang.Integer dbid)
Creates instance of RequestDeleteObject with required parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
dbid - An identifier of an object in the Configuration Database. Generated by Configuration Server and is unique within an object type
Returns:
instance of RequestDeleteObject

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference id to connect responce to request. If set to 0, it means that ReferenceID should be assighed by ReferenceBuilder.

Returns:
property value

setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference id to connect responce to request. If set to 0, it means that ReferenceID should be assighed by ReferenceBuilder.

Parameters:
referenceId - new value of the property

setReferenceId

public abstract void setReferenceId(int referenceId)
Reference id to connect responce to request. If set to 0, it means that ReferenceID should be assighed by ReferenceBuilder.

Parameters:
referenceId - new value of the property

getObjectType

public abstract java.lang.Integer getObjectType()
Type of configuration object as defined in ConfServerObject enum

Returns:
property value

setObjectType

public abstract void setObjectType(java.lang.Integer objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

setObjectType

public abstract void setObjectType(int objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

getDbid

public abstract java.lang.Integer getDbid()
An identifier of an object in the Configuration Database. Generated by Configuration Server and is unique within an object type

Returns:
property value

setDbid

public abstract void setDbid(java.lang.Integer dbid)
An identifier of an object in the Configuration Database. Generated by Configuration Server and is unique within an object type

Parameters:
dbid - new value of the property

setDbid

public abstract void setDbid(int dbid)
An identifier of an object in the Configuration Database. Generated by Configuration Server and is unique within an object type

Parameters:
dbid - new value of the property

getParameters

public abstract KeyValueCollection getParameters()
TKVList containing additional parameters (if needed)

Returns:
property value

setParameters

public abstract void setParameters(KeyValueCollection parameters)
TKVList containing additional parameters (if needed)

Parameters:
parameters - new value of the property

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.