Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgFilter

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

public class CfgFilter
extends CfgObject

Use Filters to specify conditions for data selection from a data repository (for example, from a database table).

Filter used by Outbound applications is defined by two kv-pairs that must be present in userProperties under default section:

Two ways of editing are provided:

If value of kv-pair exceeds character string limit ( >255 symbols) the string has to be separated into two or more strings. Two or more kv-pairs with same names have to be used to locate such string in userProperties.

The order of kv-pairs in userProperties is defined by application the filter is intended to. String concatenation is application responsibility.

Deletion of Filter X will cause the following events set out in the order of arrival:



See also:

CfgDeltaFilter

CfgTableAccess

CfgFormat


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgFilter(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgFilter(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgFilter(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()
          A pointer to filter description.
 CfgFormat getFormat()
          A unique identifier of CfgFormat to which this filter is dedicated.
 java.lang.Integer getFormatDBID()
          Retrieves the dbid of the object that is being linked to by the Format property.
 java.lang.String getName()
          A pointer to filter name.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this filter is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 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)
          A pointer to filter description.
 void setFormat(CfgFormat value)
          A unique identifier of CfgFormat to which this filter is dedicated.
 void setFormatDBID(int dbid)
          A unique identifier of CfgFormat to which this filter is dedicated.
 void setName(java.lang.String value)
          A pointer to filter name.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this filter is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this filter is allocated.
 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

CfgFilter

public CfgFilter(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

CfgFilter

public CfgFilter(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

CfgFilter

public CfgFilter(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()

getTenant

public final CfgTenant getTenant()
A unique identifier of the CfgTenant to which this filter is allocated. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the CfgTenant to which this filter is allocated. Mandatory. Once specified, cannot be changed.

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

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the CfgTenant to which this filter is allocated. Mandatory. Once specified, cannot be changed.

Parameters:
dbid - DBID identifier of referred object
See Also:
getTenant()

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property.

Returns:
DBID identifier of referred object or null

getName

public final java.lang.String getName()
A pointer to filter name. Must be unique within tenant environment.Mandatory.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to filter name. Must be unique within tenant environment.Mandatory.

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

getDescription

public final java.lang.String getDescription()
A pointer to filter description.

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
A pointer to filter description.

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

getFormat

public final CfgFormat getFormat()
A unique identifier of CfgFormat to which this filter is dedicated. Once specified cannot be changed. Mandatory.

Returns:
instance of referred object or null

setFormat

public final void setFormat(CfgFormat value)
A unique identifier of CfgFormat to which this filter is dedicated. Once specified cannot be changed. Mandatory.

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

setFormatDBID

public final void setFormatDBID(int dbid)
A unique identifier of CfgFormat to which this filter is dedicated. Once specified cannot be changed. Mandatory.

Parameters:
dbid - DBID identifier of referred object
See Also:
getFormat()

getFormatDBID

public final java.lang.Integer getFormatDBID()
Retrieves the dbid of the object that is being linked to by the Format property.

Returns:
DBID identifier of referred object or null

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. Among other properties must include kv-pair that specifies the filter sequence which application can use to read information from data table having specified format.

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. Among other properties must include kv-pair that specifies the filter sequence which application can use to read information from data table having specified format.

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.