com.bmc.cmdb.api
Class CMDBRelationBase

java.lang.Object
  extended by com.bmc.cmdb.api.CMDBInstanceBase
      extended by com.bmc.cmdb.api.CMDBRelationBase
All Implemented Interfaces:
java.io.Serializable

Deprecated. as of CMDB 2.0

public class CMDBRelationBase
extends CMDBInstanceBase
implements java.io.Serializable

The CMDBRelationBase class describes an CMDBRelation instance. It is a subclass of CMDBInstanceBase.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.bmc.cmdb.api.CMDBInstanceBase
CMDB_ATTACHMENT_LOCATION_BUFFER, CMDB_ATTACHMENT_LOCATION_FILE, CMDB_ATTACHMENT_LOCATION_NONE, CMDB_DATASET_ACCESSIBILITY_READ_ONLY, CMDB_DATASET_ACCESSIBILITY_WRITABLE, CMDB_DATASET_ACCESSIBLITY_WRITABLE_BY_CLIENT_TYPE, CMDB_DATASET_TYPE_OVERLAY, CMDB_DATASET_TYPE_REGULAR, CMDB_GET_DATASET_MODE_CURRENT, CMDB_GET_MASK_NONE, CMDB_NO_MAX_LIST_RETRIEVE, CMDB_START_WITH_FIRST_INSTANCE
 
Constructor Summary
CMDBRelationBase(CMDBClassNameKey aClassKey, java.lang.String role1Name, java.lang.String instance1Id, java.lang.String class1Id, java.lang.String role2Name, java.lang.String instance2Id, java.lang.String class2Id)
          Deprecated. as of CMDB 2.0
CMDBRelationBase(CMDBClassNameKey aClassKey, java.lang.String role1Name, java.lang.String instance1Id, java.lang.String class1Id, java.lang.String role2Name, java.lang.String instance2Id, java.lang.String class2Id, java.util.Map anAttrValuesMap)
          Deprecated. as of CMDB 2.0
 
Method Summary
 java.lang.String[] getInstanceRoles()
          Deprecated. as of CMDB 2.0
 CMDBClassNameKey getRole1ClassName()
          Deprecated. as of CMDB 2.0
 CMDBClassNameKey getRole2ClassName()
          Deprecated. as of CMDB 2.0
 java.lang.String getRoleClassId(java.lang.String roleName)
          Deprecated. as of CMDB 2.0
 java.lang.String getRoleInstanceId(java.lang.String roleName)
          Deprecated. as of CMDB 2.0
 
Methods inherited from class com.bmc.cmdb.api.CMDBInstanceBase
create, create, delete, delete, find, find, find, find, findBlobByKey, findBlobByKey, findByKey, findByKey, findObjects, findObjects, findObjects, findObjects, findObjects, findObjects, getAttributeValueByName, getAttributeValues, getClassKey, getGetMask, getId, setAttributeValues, update, update
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMDBRelationBase

public CMDBRelationBase(CMDBClassNameKey aClassKey,
                        java.lang.String role1Name,
                        java.lang.String instance1Id,
                        java.lang.String class1Id,
                        java.lang.String role2Name,
                        java.lang.String instance2Id,
                        java.lang.String class2Id)
Deprecated. as of CMDB 2.0

Creates an CMDBRelationBase object with minimum information.

Parameters:
aClassKey - the key of the CMDBRelationship that the instance belongs to
role1Name - the name of role1
instance1Id - the ID of role1 instance
class1Id - the ID of role1 class
role2Name - the name of role2
instance2Id - the ID of role2 instance
class2Id - the ID of role2 class
Throws:
java.lang.IllegalArgumentException - if the length of any relationship ID is longer than Constants.AR_MAX_NAME_SIZE

CMDBRelationBase

public CMDBRelationBase(CMDBClassNameKey aClassKey,
                        java.lang.String role1Name,
                        java.lang.String instance1Id,
                        java.lang.String class1Id,
                        java.lang.String role2Name,
                        java.lang.String instance2Id,
                        java.lang.String class2Id,
                        java.util.Map anAttrValuesMap)
Deprecated. as of CMDB 2.0

Creates a relation base instance with the provided information.

Parameters:
aClassKey - class key of the releationship class
role1Name - the name of role1
instance1Id - the ID of role1 instance
class1Id - the ID of role1 class
role2Name - the name of role2
instance2Id - the ID of role2 instance
class2Id - the ID of role2 class
anAttrValuesMap - attribute values for the instance. 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 the length of any relationship ID is longer than Constants.AR_MAX_NAME_SIZE
Method Detail

getRoleInstanceId

public java.lang.String getRoleInstanceId(java.lang.String roleName)
Deprecated. as of CMDB 2.0

Gets the instance ID of the requested role

Parameters:
roleName - the name of the role
Returns:
the instance ID of the requested role

getRoleClassId

public java.lang.String getRoleClassId(java.lang.String roleName)
Deprecated. as of CMDB 2.0

Gets the class ID of the requested role.

Parameters:
roleName - the name of the role
Returns:
the class ID of the requested role

getRole1ClassName

public CMDBClassNameKey getRole1ClassName()
Deprecated. as of CMDB 2.0

Gets the role1 class name. This information is retrievable only after performing a graph query.

Returns:
the role1 class name

getRole2ClassName

public CMDBClassNameKey getRole2ClassName()
Deprecated. as of CMDB 2.0

Get the role2 class name. This information is retrievable only after performing a graph query.

Returns:
the role2 class name

getInstanceRoles

public java.lang.String[] getInstanceRoles()
Deprecated. as of CMDB 2.0

Gets the names of the roles that are involved in this relationship instance.

Returns:
an array of relation instance role names


(c) Copyright 2004-2007 BMC Software, Inc.