com.bmc.cmdb.api
Class CMDBGraphAdjacency

java.lang.Object
  com.bmc.cmdb.api.CMDBGraphAdjacency

public class CMDBGraphAdjacency
extends java.lang.Object

The CMDBGraphAdjacency class allows you to define an adjacent object (node).

Field Summary

static int	CMDB_GET_ATTR_ALL Specifies that all attributes are retrieved.
static int	CMDB_GET_ATTR_NOHIDDEN Specifies that hidden attributes are not retrieved.
static int	CMDB_GET_ATTR_NONE Specifies that no attributes are retrieved.
static int	CMDB_GRAPH_QUAL_TYPE_NONE Specifies that the qualifier type is none.
static int	CMDB_GRAPH_QUAL_TYPE_STRING Specifies that the qualifier type is string.
static int	CMDB_GRAPH_QUAL_TYPE_STRUCT Specifies that the qualifier type is object.

Constructor Summary

CMDBGraphAdjacency()
Default constructor that creates an empty CMDBGraphAdjacency object.

CMDBGraphAdjacency(CMDBClassNameKey relationClassName, CMDBClassNameKey objectClassName)
Constructor that creates a CMDBGraphAdjacency object with the specified class name and namespace of the relationship class and the adjacent CI object (node).

Method Summary

java.lang.String	getExtensionId() Gets the extension ID for the CMDBGraphAdjacency object.
java.lang.String[]	getObjectAttributeNames() Gets the list of attributes for the CMDBGraphAdjacency object.
int	getObjectAttributeType() Gets the attribute type of the CMDBGraphAdjacency object.
CMDBClassNameKey	getObjectClassName() Gets the class name and namespace of the CMDBGraphAdjacency object.
java.lang.Object	getObjectQuery() Gets the query for the CMDBGraphAdjacency object instance.
int	getObjectQueryType() Gets the qualifier type for the CMDBGraphAdjacency object.
java.lang.String[]	getRelationAttributeNames() Gets the list of related attributes.
int	getRelationAttributeType() Gets the attribute type of the relationship.
CMDBClassNameKey	getRelationClassName() Gets the class name and namespace of the class that makes up the relationship.
java.lang.Object	getRelationQuery() Gets the query used to qualify the relationship.
int	getRelationQueryType() Gets the qualifier type used to qualify the relationship.
void	setExtensionId(java.lang.String extensionId) Sets the extension ID of the CMDBGraphAdjacency object.
void	setObjectAttribute(int type) Sets the types of the attributes to retrieve.
void	setObjectAttribute(java.lang.String[] attributeNames) Sets the names of the attributes to retrieve.
void	setObjectQuery(java.lang.Object objectQuery) Sets the query for the CMDBGraphAdjacency object.
void	setRelationAttribute(int type) Sets the type of the relation attributes to be retrieved.
void	setRelationAttribute(java.lang.String[] attributeNames) Sets the names of the relation attributes to be retrieved.
void	setRelationQuery(java.lang.Object relationQuery) Sets the query for the CMDBGraphAdjacency object.

Methods inherited from class java.lang.Object

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

Field Detail

CMDB_GET_ATTR_NONE

public static final int CMDB_GET_ATTR_NONE

Specifies that no attributes are retrieved.

See Also:

Constant Field Values

CMDB_GET_ATTR_NOHIDDEN

public static final int CMDB_GET_ATTR_NOHIDDEN

Specifies that hidden attributes are not retrieved.

See Also:

Constant Field Values

CMDB_GET_ATTR_ALL

public static final int CMDB_GET_ATTR_ALL

Specifies that all attributes are retrieved.

See Also:

Constant Field Values

CMDB_GRAPH_QUAL_TYPE_NONE

public static final int CMDB_GRAPH_QUAL_TYPE_NONE

Specifies that the qualifier type is none.

See Also:

Constant Field Values

CMDB_GRAPH_QUAL_TYPE_STRING

public static final int CMDB_GRAPH_QUAL_TYPE_STRING

Specifies that the qualifier type is string.

See Also:

Constant Field Values

CMDB_GRAPH_QUAL_TYPE_STRUCT

public static final int CMDB_GRAPH_QUAL_TYPE_STRUCT

Specifies that the qualifier type is object. The qualifier object stores the information.

See Also:

Constant Field Values

Constructor Detail

CMDBGraphAdjacency

public CMDBGraphAdjacency()

Default constructor that creates an empty CMDBGraphAdjacency object.

CMDBGraphAdjacency

public CMDBGraphAdjacency(CMDBClassNameKey relationClassName,
                          CMDBClassNameKey objectClassName)

Constructor that creates a CMDBGraphAdjacency object with the specified class name and namespace of the relationship class and the adjacent CI object (node).

Parameters:

relationClassName - name of the class that makes up the relationship

objectClassName - class name of the adjacent CI object (node)

Method Detail

getRelationClassName

public CMDBClassNameKey getRelationClassName()

Gets the class name and namespace of the class that makes up the relationship.

Returns:

the name of the class

getRelationQuery

public java.lang.Object getRelationQuery()

Gets the query used to qualify the relationship.

Returns:

the query that qualifies the relationship. The query object can be either a string or a QualifierInfo object. Call getRelationQueryType() to retrieve the type.

getRelationQueryType

public int getRelationQueryType()

Gets the qualifier type used to qualify the relationship.

Returns:

the qualifier type The type can be CMDB_GRAPH_QUAL_TYPE_NONE or CMDB_GRAPH_QUAL_TYPE_STRING or CMDB_GRAPH_QUAL_TYPE_STRUCT

getRelationAttributeType

public int getRelationAttributeType()

Gets the attribute type of the relationship.

Returns:

the attribute type

getRelationAttributeNames

public java.lang.String[] getRelationAttributeNames()

Gets the list of related attributes.

Returns:

the attribute name array

getObjectClassName

public CMDBClassNameKey getObjectClassName()

Gets the class name and namespace of the CMDBGraphAdjacency object.

Returns:

the class name

getObjectQuery

public java.lang.Object getObjectQuery()

Gets the query for the CMDBGraphAdjacency object instance.

Returns:

the query that qualifies the object instance returned. The query object can be either a string or a QualifierInfo object. Call getObjectQueryType() to retrieve the type.

getObjectQueryType

public int getObjectQueryType()

Gets the qualifier type for the CMDBGraphAdjacency object.

Returns:

the qualification type of object in the adjacency. The type can be CMDB_GRAPH_QUAL_TYPE_NONE or CMDB_GRAPH_QUAL_TYPE_STRING or CMDB_GRAPH_QUAL_TYPE_STRUCT

getObjectAttributeType

public int getObjectAttributeType()

Gets the attribute type of the CMDBGraphAdjacency object.

Returns:

the attribute type

getObjectAttributeNames

public java.lang.String[] getObjectAttributeNames()

Gets the list of attributes for the CMDBGraphAdjacency object.

Returns:

the attribute name

getExtensionId

public java.lang.String getExtensionId()

Gets the extension ID for the CMDBGraphAdjacency object.

Returns:

the extension ID

setRelationQuery

public void setRelationQuery(java.lang.Object relationQuery)

Sets the query for the CMDBGraphAdjacency object.

Parameters:

relationQuery - a query object to qualify relation instance returned. The query object can be either a string or a QualifierInfo object. An exception will be thrown if neither of the above two types of qualification is provided.

setRelationAttribute

public void setRelationAttribute(int type)

Sets the type of the relation attributes to be retrieved.

Parameters:

type - attribute type. It can be one of the following: CMDB_GET_ATTR_NONE, or CMDB_GET_ATTR_NOHIDDEN, or CMDB_GET_ATTR_ALL

Throws:

java.lang.IllegalArgumentException - if the type provided is not one of the above types

setRelationAttribute

public void setRelationAttribute(java.lang.String[] attributeNames)

Sets the names of the relation attributes to be retrieved. The returned attributes must be one of the specified attributes.

Parameters:

attributeNames - the names of the attributes to retrieve

setObjectQuery

public void setObjectQuery(java.lang.Object objectQuery)

Sets the query for the CMDBGraphAdjacency object.

Parameters:

objectQuery - a query to qualify the object returned. The query can be either a string or a QualifierInfo object. An exception will be thrown if neither of the above two types of qualification is provided.

setObjectAttribute

public void setObjectAttribute(int type)

Sets the types of the attributes to retrieve.

Parameters:

type - attribute type. It can be one of the following: CMDB_GET_ATTR_NONE, or CMDB_GET_ATTR_NOHIDDEN, or CMDB_GET_ATTR_ALL

Throws:

java.lang.IllegalArgumentException - if the type provided is not one of the above types

setObjectAttribute

public void setObjectAttribute(java.lang.String[] attributeNames)

Sets the names of the attributes to retrieve. The returned attributes must be one of the specified attributes.

Parameters:

attributeNames - the names of the attributes to retrieve

setExtensionId

public void setExtensionId(java.lang.String extensionId)

Sets the extension ID of the CMDBGraphAdjacency object.

Parameters:

extensionId - a unique identifier for this graph node