com.remedy.cmdb.api
Class CMDBInstanceDataItem

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

public class CMDBInstanceDataItem

extends CMDBItemBase

The CMDBInstanceDataItem class defines instance import/export items.

Field Summary

static int	OPTION_DEFAULT Default option value for processing an instace 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.

CMDBInstanceDataItem(CMDBClassNameKey classNameId, int option)
Constructor.

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

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 qualification string.

Methods inherited from class com.remedy.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 instace 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 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 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 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.

Parameters:

classNameId - class name and namespace key

qualifier - qualification string that is used to search for instances to export

CMDBInstanceDataItem

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

Constructor.

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.

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 qualification string.