com.bmc.cmdb.api
Class CMDBInstanceDataItem

java.lang.Object
  com.bmc.cmdb.api.CMDBItemBase
      com.bmc.cmdb.api.CMDBInstanceDataItem

public class CMDBInstanceDataItem
extends CMDBItemBase

The CMDBInstanceDataItem class allows you to define the instance data for exporting or importing. Once you create a CMDBInstanceDataItem object, you can run queries against it.

Field Summary

static int	OPTION_DEFAULT Default option value for processing an instance data item.
static int	OPTION_DUP_ERROR Generates an error if the Entry ID field and the ID specified already exist in the target form.
static int	OPTION_DUP_MERGE Updates the fields specified in the existing entry if the Entry ID field and the ID specified already exist in the target form.
static int	OPTION_DUP_NEW_ID Creates a new entry with a new ID if the Entry ID field and the ID specified already exist in the target form.
static int	OPTION_DUP_OVERWRITE Deletes the existing entry and creates a new one in its place if the Entry ID field and the ID specified already exist in the target form.
static int	OPTION_GEN_NEW_ID Creates an entry with a new ID.

Constructor Summary

CMDBInstanceDataItem(CMDBClassNameKey classNameId)
Constructor that creates a CMDBInstanceDataItem object with the specified class name and namespace.

CMDBInstanceDataItem(CMDBClassNameKey classNameId, int option)
Constructor that creates a CMDBInstanceDataItem object with the specified class name, namespace, and import option.

CMDBInstanceDataItem(CMDBClassNameKey classNameId, java.lang.String qualifier)
Constructor that creates a CMDBInstanceDataItem object with the specified class name, namespace, and qualifier string.

Method Summary

java.lang.String	getQualifier() Gets the qualifier.
void	setOption(int option) Sets the import option.
void	setQualifier(java.lang.String qualifier) Sets the export qualifier string.

Methods inherited from class com.bmc.cmdb.api.CMDBItemBase

getClassNameId, getOption, setClassNameId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPTION_DEFAULT

public static int OPTION_DEFAULT

Default option value for processing an instance data item. It is the same as OPTION_DUP_NEW_ID.

OPTION_DUP_ERROR

public static int OPTION_DUP_ERROR

Generates an error if the Entry ID field and the ID specified already exist in the target form. During an import operation, this option value dictates how the import of instances is handled if any duplicates are found on the target server during the import. During an export operation, this option is not currently used. These option values are mutually exclusive, so only one option value can be specified. These constants are the same, for example, as the AR_MERGE_ENTRY_DUP_NEW_ID value defined in the Constant class in the AR System Java API.

OPTION_DUP_NEW_ID

public static int OPTION_DUP_NEW_ID

Creates a new entry with a new ID if the Entry ID field and the ID specified already exist in the target form.

OPTION_DUP_OVERWRITE

public static int OPTION_DUP_OVERWRITE

Deletes the existing entry and creates a new one in its place if the Entry ID field and the ID specified already exist in the target form.

OPTION_DUP_MERGE

public static int OPTION_DUP_MERGE

Updates the fields specified in the existing entry if the Entry ID field and the ID specified already exist in the target form.

OPTION_GEN_NEW_ID

public static int OPTION_GEN_NEW_ID

Creates an entry with a new ID.

Constructor Detail

CMDBInstanceDataItem

public CMDBInstanceDataItem(CMDBClassNameKey classNameId,
                            java.lang.String qualifier)

Constructor that creates a CMDBInstanceDataItem object with the specified class name, namespace, and qualifier string.

Parameters:

classNameId - class name and namespace key

qualifier - query string used to qualify the instance for export

CMDBInstanceDataItem

public CMDBInstanceDataItem(CMDBClassNameKey classNameId,
                            int option)
                     throws java.lang.Exception

Constructor that creates a CMDBInstanceDataItem object with the specified class name, namespace, and import option.

Parameters:

classNameId - class name and namespace key

option - instance data import option

Throws:

java.lang.Exception - if the class name ID or an option is invalid

CMDBInstanceDataItem

public CMDBInstanceDataItem(CMDBClassNameKey classNameId)
                     throws java.lang.Exception

Constructor that creates a CMDBInstanceDataItem object with the specified class name and namespace.

Parameters:

classNameId - class name and namespace key

Throws:

java.lang.Exception - if the class name are invalid

Method Detail

setOption

public void setOption(int option)
               throws java.lang.Exception

Sets the import option.

Throws:

java.lang.Exception - if the option is invalid

getQualifier

public java.lang.String getQualifier()

Gets the qualifier.

setQualifier

public void setQualifier(java.lang.String qualifier)

Sets the export qualifier string.