Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.remedy.cmdb.api
Class CMDBInstanceBase

java.lang.Object
  extended bycom.remedy.cmdb.api.CMDBInstanceBase
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CMDBRelationBase
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

public class CMDBInstanceBase
extends java.lang.Object
implements java.io.Serializable

The CMDBInstanceBase class describes an CMDBInstanceBase object.

See Also:
Serialized Form

Field Summary
static int CMDB_ATTACHMENT_LOCATION_BUFFER
          Deprecated. The attachment is store in a data buffer
static int CMDB_ATTACHMENT_LOCATION_FILE
          Deprecated. The attachment is stored in a file
static int CMDB_ATTACHMENT_LOCATION_NONE
          Deprecated. No attachment is stored
static int CMDB_DATASET_ACCESSIBILITY_READ_ONLY
          Deprecated. A dataset that is read only
static int CMDB_DATASET_ACCESSIBILITY_WRITABLE
          Deprecated. A dataset that is writable
static int CMDB_DATASET_ACCESSIBLITY_WRITABLE_BY_CLIENT_TYPE
          Deprecated. A dataset that is writable certain client types
static int CMDB_DATASET_TYPE_OVERLAY
          Deprecated. Overlay dataset type
static int CMDB_DATASET_TYPE_REGULAR
          Deprecated. Regular dataset type
static int CMDB_GET_DATASET_MODE_CURRENT
          Deprecated. Find in the curerent Dataset only
static int CMDB_GET_MASK_NONE
          Deprecated. Take no action
static int CMDB_NO_MAX_LIST_RETRIEVE
          Deprecated. No maximum limit for the number of entries retrieved in the list.
static int CMDB_START_WITH_FIRST_INSTANCE
          Deprecated. Retrieves from result set starting with the first instance.
 
Constructor Summary
CMDBInstanceBase(CMDBClassNameKey aClassKey)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
CMDBInstanceBase(CMDBClassNameKey aClassKey, java.util.Map anAttrValuesMap)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 
Method Summary
 void create(ARServerUser context)
          Deprecated. Creates the current CMDBClass instance in AR System.
 void create(ARServerUser context, java.lang.String aDatasetId)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static void delete(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String instanceId, int deleteOption)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static void delete(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, java.lang.String instanceId, int deleteOption)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static java.lang.String[] find(ARServerUser context, CMDBClassNameKey aClassKey, QualifierInfo query, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static java.lang.String[] find(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String query, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static java.lang.String[] find(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, int aGetMask, QualifierInfo query, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static java.lang.String[] find(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, int aGetMask, java.lang.String query, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static void findBlobByKey(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, int aGetMask, java.lang.String instanceId, java.lang.String attributeName, AttachmentInfo attachment)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static void findBlobByKey(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String instanceId, java.lang.String attributeName, AttachmentInfo attachment)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase findByKey(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, int aGetMask, java.lang.String instanceId, java.lang.String[] attributeNames)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase findByKey(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String instanceId, java.lang.String[] attributeNames)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase[] findObjects(ARServerUser context, CMDBClassNameKey aClassKey, QualifierInfo query, java.lang.String[] attributeGetList, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase[] findObjects(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String[] instanceIds, java.lang.String[] attributeGetList)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase[] findObjects(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, int aGetMask, QualifierInfo query, java.lang.String[] attributeGetList, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase[] findObjects(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, int aGetMask, java.lang.String[] instanceIds, java.lang.String[] attributeGetList)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase[] findObjects(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String aDatasetId, int aGetMask, java.lang.String query, java.lang.String[] attributeGetList, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
static CMDBInstanceBase[] findObjects(ARServerUser context, CMDBClassNameKey aClassKey, java.lang.String query, java.lang.String[] attributeGetList, CMDBSort[] sortArray, int firstRetrieve, int maxRetrieve, java.lang.Integer numMatches)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 CMDBAttributeValue getAttributeValueByName(java.lang.String name)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 java.util.Map getAttributeValues()
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 CMDBClassNameKey getClassKey()
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 int getGetMask()
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 java.lang.String getId()
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 void setAttributeValues(java.util.Map newAttrValueMap)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 void update(ARServerUser context)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 void update(ARServerUser context, java.lang.String aDatasetId)
          Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CMDB_START_WITH_FIRST_INSTANCE

public static final int CMDB_START_WITH_FIRST_INSTANCE
Deprecated. 
Retrieves from result set starting with the first instance.

See Also:
Constant Field Values

CMDB_NO_MAX_LIST_RETRIEVE

public static final int CMDB_NO_MAX_LIST_RETRIEVE
Deprecated. 
No maximum limit for the number of entries retrieved in the list.

See Also:
Constant Field Values

CMDB_ATTACHMENT_LOCATION_NONE

public static final int CMDB_ATTACHMENT_LOCATION_NONE
Deprecated. 
No attachment is stored

See Also:
Constant Field Values

CMDB_ATTACHMENT_LOCATION_FILE

public static final int CMDB_ATTACHMENT_LOCATION_FILE
Deprecated. 
The attachment is stored in a file

See Also:
Constant Field Values

CMDB_ATTACHMENT_LOCATION_BUFFER

public static final int CMDB_ATTACHMENT_LOCATION_BUFFER
Deprecated. 
The attachment is store in a data buffer

See Also:
Constant Field Values

CMDB_GET_MASK_NONE

public static final int CMDB_GET_MASK_NONE
Deprecated. 
Take no action

See Also:
Constant Field Values

CMDB_GET_DATASET_MODE_CURRENT

public static final int CMDB_GET_DATASET_MODE_CURRENT
Deprecated. 
Find in the curerent Dataset only

See Also:
Constant Field Values

CMDB_DATASET_ACCESSIBILITY_WRITABLE

public static final int CMDB_DATASET_ACCESSIBILITY_WRITABLE
Deprecated. 
A dataset that is writable

See Also:
Constant Field Values

CMDB_DATASET_ACCESSIBILITY_READ_ONLY

public static final int CMDB_DATASET_ACCESSIBILITY_READ_ONLY
Deprecated. 
A dataset that is read only

See Also:
Constant Field Values

CMDB_DATASET_ACCESSIBLITY_WRITABLE_BY_CLIENT_TYPE

public static final int CMDB_DATASET_ACCESSIBLITY_WRITABLE_BY_CLIENT_TYPE
Deprecated. 
A dataset that is writable certain client types

See Also:
Constant Field Values

CMDB_DATASET_TYPE_REGULAR

public static final int CMDB_DATASET_TYPE_REGULAR
Deprecated. 
Regular dataset type

See Also:
Constant Field Values

CMDB_DATASET_TYPE_OVERLAY

public static final int CMDB_DATASET_TYPE_OVERLAY
Deprecated. 
Overlay dataset type

See Also:
Constant Field Values
Constructor Detail

CMDBInstanceBase

public CMDBInstanceBase(CMDBClassNameKey aClassKey)
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Creates an CMDBInstanceBase object with minimum information.

Parameters:
aClassKey - the class key of the CMDBClass that the instance belongs to

CMDBInstanceBase

public CMDBInstanceBase(CMDBClassNameKey aClassKey,
                        java.util.Map anAttrValuesMap)
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Constructor that creates an CMDBInstanceBase object with the information provided.

Parameters:
aClassKey - the name key of the class that the instance is associated with
anAttrValuesMap - the attribute values are organized into a map that uses the attribute name as its map key, and CMDBAttributeValue as its mapped value
Throws:
java.lang.IllegalArgumentException - if map value is not CMDBAttributeValue
Method Detail

getClassKey

public CMDBClassNameKey getClassKey()
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Gets the key of the class that the instance belongs to.

Returns:
an CMDBClass key

getId

public java.lang.String getId()
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Gets the instance ID

Returns:
the ID of the instance

getGetMask

public int getGetMask()
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Gets the instance datasetSetMode

Returns:
the Dataset Mode of the instance

getAttributeValues

public java.util.Map getAttributeValues()
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Gets the attribute values. The values are organized into a map that uses attribute name as its map key. The type of mapped values is CMDBAttributeValue.

Returns:
the attribute values that are collected into a map.

getAttributeValueByName

public CMDBAttributeValue getAttributeValueByName(java.lang.String name)
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Use the attribute name as a map key to find the attribute value.

Parameters:
name - the name of the attribute
Returns:
the attribute value.

setAttributeValues

public void setAttributeValues(java.util.Map newAttrValueMap)
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Replaces the attribute values of the instance. The new values are organized into a map that uses the attribute name as its map key. The type of mapped values is CMDBAttributeValue.

Parameters:
newAttrValueMap - the new attribute values to be set
Throws:
java.lang.IllegalArgumentException - if map value is not CMDBAttributeValue

create

public void create(ARServerUser context)
            throws ARException
Deprecated. 
Creates the current CMDBClass instance in AR System.

Parameters:
context - ARSystemUser structure that contains user and host information
Throws:
ARException - if the instance cannot be created in AR System

create

public void create(ARServerUser context,
                   java.lang.String aDatasetId)
            throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Creates the current CMDBClass instance in AR System.

Parameters:
context - ARSystemUser structure that contains user and host information
aDatasetId - the DatasetId of the instance
Throws:
ARException - if the instance cannot be created in AR System

update

public void update(ARServerUser context)
            throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Saves the change made to the current CMDBClass instance in AR System.

Parameters:
context - ARSystemUser structure that contains user and host information
Throws:
ARException - if the instance cannot be updated in AR System

update

public void update(ARServerUser context,
                   java.lang.String aDatasetId)
            throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Saves the change made to the current CMDBClass instance in AR System.

Parameters:
context - ARSystemUser structure that contains user and host information
aDatasetId - the DatasetId of the instance
Throws:
ARException - if the instance cannot be updated in AR System

delete

public static void delete(ARServerUser context,
                          CMDBClassNameKey aClassKey,
                          java.lang.String instanceId,
                          int deleteOption)
                   throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Deletes the current CMDBClass instance from AR System.

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the name key of the class that the instance belongs to
instanceId - the id of the instance to be deleted
deleteOption - Delete option. Possible values are:
  • 0: For a derived class, delete only if an instance is found.
  • 1: Delete unconditionally.
Throws:
ARException - if the instance cannot be deleted

delete

public static void delete(ARServerUser context,
                          CMDBClassNameKey aClassKey,
                          java.lang.String aDatasetId,
                          java.lang.String instanceId,
                          int deleteOption)
                   throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Deletes the current CMDBClass instance from AR System.

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the name key of the class that the instance belongs to
instanceId - the id of the instance to be deleted
deleteOption - Delete option. Possible values are:
  • 0: For a derived class, delete only if an instance is found.
  • 1: Delete unconditionally.
Throws:
ARException - if the instance cannot be deleted

findByKey

public static CMDBInstanceBase findByKey(ARServerUser context,
                                         CMDBClassNameKey aClassKey,
                                         java.lang.String instanceId,
                                         java.lang.String[] attributeNames)
                                  throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds the specified CMDBClass instance in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
instanceId - the ID of the instance to look for
attributeNames - the list of attributes to retrieve.
Returns:
the CMDBinstance instance with the specified attribute value. If attributeNames is null, then all attributeValue in the instance will be retrieved.
Throws:
ARException - if the specified instance can't be located

findByKey

public static CMDBInstanceBase findByKey(ARServerUser context,
                                         CMDBClassNameKey aClassKey,
                                         java.lang.String aDatasetId,
                                         int aGetMask,
                                         java.lang.String instanceId,
                                         java.lang.String[] attributeNames)
                                  throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds the specified CMDBClass instance in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
instanceId - the ID of the instance to look for
aDatasetId - the DatasetId of the instance
aGetMask - the get mask (current or overlay)
attributeNames - the list of attributes to retrieve.
Returns:
the CMDBinstance instance with the specified attribute value. If attributeNames is null, then all attributeValue in the instance will be retrieved.
Throws:
ARException - if the specified instance can't be located

findBlobByKey

public static void findBlobByKey(ARServerUser context,
                                 CMDBClassNameKey aClassKey,
                                 java.lang.String instanceId,
                                 java.lang.String attributeName,
                                 AttachmentInfo attachment)
                          throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds the specified attachment attribute from AR System. The attachment can be placed in a buffer or a file. The system returns information based on the access privileges of the user you specify for the ARServerUser parameter. User permissions are verified for the specified attribute. If the user cannot access the attribute, the system returns an error message.

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
instanceId - the ID of the instance to look for
attributeName - name of the attribute that has the attachment
attachment - the location of the returned attachment. The attachment can be stored in a file CMDB_ATTACHMENT_LOCATION_FILE or in a buffer CMDB_ATTACHMENT_LOCATION_BUFFER. If it is stored in a file, then file name should be specified in this argument. The returned attachment object is also saved in this object.
Throws:
ARException - if the specified attachment can't be located.

findBlobByKey

public static void findBlobByKey(ARServerUser context,
                                 CMDBClassNameKey aClassKey,
                                 java.lang.String aDatasetId,
                                 int aGetMask,
                                 java.lang.String instanceId,
                                 java.lang.String attributeName,
                                 AttachmentInfo attachment)
                          throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds the specified attachment attribute from AR System. The attachment can be placed in a buffer or a file. The system returns information based on the access privileges of the user you specify for the ARServerUser parameter. User permissions are verified for the specified attribute. If the user cannot access the attribute, the system returns an error message.

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
aDatasetId - datasetid
aGetMask - the get mask (current, overlay, etc)
instanceId - the ID of the instance to look for
attributeName - name of the attribute that has the attachment
attachment - the location of the returned attachment. The attachment can be stored in a file CMDB_ATTACHMENT_LOCATION_FILE or in a buffer CMDB_ATTACHMENT_LOCATION_BUFFER. If it is stored in a file, then file name should be specified in this argument. The returned attachment object is also saved in this object.
Throws:
ARException - if the specified attachment can't be located.

find

public static java.lang.String[] find(ARServerUser context,
                                      CMDBClassNameKey aClassKey,
                                      java.lang.String query,
                                      CMDBSort[] sortArray,
                                      int firstRetrieve,
                                      int maxRetrieve,
                                      java.lang.Integer numMatches)
                               throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds the IDs of all CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
query - a string where you specify a qualification for retrieving instances For example, to locate instances of class BMC:AssetBase, where Cost Center is "BMC" and Order ID is 5, the qualification will be: 'Cost Center' = "BMC" AND 'Order ID' = 5 So, the name of the attribute you are querying for is always surrounded in single quotes. For each attribute, if the datatype is string, then enclose the string you are looking for in double quotes (as in the above example, "BMC"). For integers, you do not need to put any quotes around it.
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
the IDs of all matching instances
Throws:
ARException - if failed to return all matched instances

find

public static java.lang.String[] find(ARServerUser context,
                                      CMDBClassNameKey aClassKey,
                                      java.lang.String aDatasetId,
                                      int aGetMask,
                                      java.lang.String query,
                                      CMDBSort[] sortArray,
                                      int firstRetrieve,
                                      int maxRetrieve,
                                      java.lang.Integer numMatches)
                               throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds the IDs of all CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
aDatasetId - DatasetId of which you want to retrieve instances
aGetMask - the get mask (current, overlay, etc)
query - a string where you specify a qualification for retrieving instances For example, to locate instances of class BMC:AssetBase, where Cost Center is "BMC" and Order ID is 5, the qualification will be: 'Cost Center' = "BMC" AND 'Order ID' = 5 So, the name of the attribute you are querying for is always surrounded in single quotes. For each attribute, if the datatype is string, then enclose the string you are looking for in double quotes (as in the above example, "BMC"). For integers, you do not need to put any quotes around it.
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
the IDs of all matching instances
Throws:
ARException - if failed to return all matched instances

find

public static java.lang.String[] find(ARServerUser context,
                                      CMDBClassNameKey aClassKey,
                                      QualifierInfo query,
                                      CMDBSort[] sortArray,
                                      int firstRetrieve,
                                      int maxRetrieve,
                                      java.lang.Integer numMatches)
                               throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all qualified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
query - an query object where you specify a qualification for retrieving instances
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
the IDs of all matching instances
Throws:
ARException - if failed to return all matched instances

find

public static java.lang.String[] find(ARServerUser context,
                                      CMDBClassNameKey aClassKey,
                                      java.lang.String aDatasetId,
                                      int aGetMask,
                                      QualifierInfo query,
                                      CMDBSort[] sortArray,
                                      int firstRetrieve,
                                      int maxRetrieve,
                                      java.lang.Integer numMatches)
                               throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all qualified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
aDatasetId - DatasetId of which you want to retrieve instances
aGetMask - the get mask (current, overlay, etc)
query - an query object where you specify a qualification for retrieving instances
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
the IDs of all matching instances
Throws:
ARException - if failed to return all matched instances

findObjects

public static CMDBInstanceBase[] findObjects(ARServerUser context,
                                             CMDBClassNameKey aClassKey,
                                             java.lang.String query,
                                             java.lang.String[] attributeGetList,
                                             CMDBSort[] sortArray,
                                             int firstRetrieve,
                                             int maxRetrieve,
                                             java.lang.Integer numMatches)
                                      throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all qualified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
query - a string where you specify a qualification for retrieving instances For example, to locate instances of class BMC:AssetBase, where Cost Center is "BMC" and Order ID is 5, the qualification will be: 'Cost Center' = "BMC" AND = 'Order ID' = 5 So, the name of the attribute you are querying for is always surrounded in single quotes. For each attribute, if the datatype is string, then enclose the string you are looking for in double quotes (as in the above example, "BMC"). For integers, you do not need to put any quotes around it.
attributeGetList - the attribute to be retrieved. If attributeGetList is NULL, then all attribute values of the instance will be returned.
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
all matching instances. If attributeGetList is null, then all attributeValue in each instance will be retrieved.
Throws:
ARException - if failed to return all matched instances

findObjects

public static CMDBInstanceBase[] findObjects(ARServerUser context,
                                             CMDBClassNameKey aClassKey,
                                             java.lang.String aDatasetId,
                                             int aGetMask,
                                             java.lang.String query,
                                             java.lang.String[] attributeGetList,
                                             CMDBSort[] sortArray,
                                             int firstRetrieve,
                                             int maxRetrieve,
                                             java.lang.Integer numMatches)
                                      throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all qualified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
aDatasetId - DatasetId of which you want to retrieve instances
aGetMask - the get mask (current, overlay, etc)
query - a string where you specify a qualification for retrieving instances For example, to locate instances of class BMC:AssetBase, where Cost Center is "BMC" and Order ID is 5, the qualification will be: 'Cost Center' = "BMC" AND = 'Order ID' = 5 So, the name of the attribute you are querying for is always surrounded in single quotes. For each attribute, if the datatype is string, then enclose the string you are looking for in double quotes (as in the above example, "BMC"). For integers, you do not need to put any quotes around it.
attributeGetList - the attribute to be retrieved. If attributeGetList is NULL, then all attribute values of the instance will be returned.
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
all matching instances. If attributeGetList is null, then all attributeValue in each instance will be retrieved.
Throws:
ARException - if failed to return all matched instances

findObjects

public static CMDBInstanceBase[] findObjects(ARServerUser context,
                                             CMDBClassNameKey aClassKey,
                                             QualifierInfo query,
                                             java.lang.String[] attributeGetList,
                                             CMDBSort[] sortArray,
                                             int firstRetrieve,
                                             int maxRetrieve,
                                             java.lang.Integer numMatches)
                                      throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all qualified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
query - an query object where you specify a qualification for retrieving instances
attributeGetList - the attribute to be retrieved. If attributeGetList is NULL, then all attribute values of the instance will be returned.
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
all matching instances. If attributeGetList is null, then all attributeValue in each instance will be retrieved.
Throws:
ARException - if failed to return all matched instances

findObjects

public static CMDBInstanceBase[] findObjects(ARServerUser context,
                                             CMDBClassNameKey aClassKey,
                                             java.lang.String aDatasetId,
                                             int aGetMask,
                                             QualifierInfo query,
                                             java.lang.String[] attributeGetList,
                                             CMDBSort[] sortArray,
                                             int firstRetrieve,
                                             int maxRetrieve,
                                             java.lang.Integer numMatches)
                                      throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all qualified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
aDatasetId - DatasetId of which you want to retrieve instances
aGetMask - the get mask (current, overlay, etc)
query - an query object where you specify a qualification for retrieving instances
attributeGetList - the attribute to be retrieved. If attributeGetList is NULL, then all attribute values of the instance will be returned.
firstRetrieve - First instance retrieved for the query chunk. CMDB_START_WITH_FIRST_INSTANCE means retrieve the first instance from AR System.
maxRetrieve - Maximum instances to retrieve for the query. CMDB_NO_MAX_LIST_RETRIEVE means unlimited instances are retrieved.
numMatches - Will return the total number of (accessible) instances that match the qualification criteria. Specify null for this parameter if you do not want to retrieve this count.
Returns:
all matching instances. If attributeGetList is null, then all attributeValue in each instance will be retrieved.
Throws:
ARException - if failed to return all matched instances

findObjects

public static CMDBInstanceBase[] findObjects(ARServerUser context,
                                             CMDBClassNameKey aClassKey,
                                             java.lang.String[] instanceIds,
                                             java.lang.String[] attributeGetList)
                                      throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all specified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
instanceIds - an array of instance ids
attributeGetList - the attribute to be retrieved. If attributeGetList is NULL, then all attribute values of the instance will be returned.
Returns:
all specified instances. If attributeGetList is null, then all attributeValue in each instance will be retrieved.
Throws:
ARException - if failed to return all matched instances

findObjects

public static CMDBInstanceBase[] findObjects(ARServerUser context,
                                             CMDBClassNameKey aClassKey,
                                             java.lang.String aDatasetId,
                                             int aGetMask,
                                             java.lang.String[] instanceIds,
                                             java.lang.String[] attributeGetList)
                                      throws ARException
Deprecated. as of CMDB 2.0 and replaced by CMDBInstance.

Finds all specified CMDBClass instances in AR System

Parameters:
context - ARSystemUser structure that contains user and host information
aClassKey - the key of the class that the instance belongs to
aDatasetId - DatasetId of which you want to retrieve instances
aGetMask - the get mask (current, overlay, etc)
instanceIds - an array of instance ids
attributeGetList - the attribute to be retrieved. If attributeGetList is NULL, then all attribute values of the instance will be returned.
Returns:
all specified instances. If attributeGetList is null, then all attributeValue in each instance will be retrieved.
Throws:
ARException - if failed to return all matched instances
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD