com.remedy.cmdb.api
Class CMDBGraphAdjacency

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

public class CMDBGraphAdjacency

extends java.lang.Object

The CMDBGraphAdjacency class defines an adjacency in a graph adjacent list.

Field Summary

static int	CMDB_GET_ATTR_ALL Get all attributes.
static int	CMDB_GET_ATTR_NOHIDDEN Get all attributes that are not hidden.
static int	CMDB_GET_ATTR_NONE Do not get any attributes.
static int	CMDB_GRAPH_QUAL_TYPE_NONE Do not have query specified
static int	CMDB_GRAPH_QUAL_TYPE_STRING The query is a string
static int	CMDB_GRAPH_QUAL_TYPE_STRUCT The query is a QualifierInfo object

Constructor Summary

CMDBGraphAdjacency()
Default constructor.

CMDBGraphAdjacency(CMDBClassNameKey relationClassName, CMDBClassNameKey objectClassName)
Constructor.

Method Summary

java.lang.String	getExtensionId() Gets the extension ID of the class in the adjacency
java.lang.String[]	getObjectAttributeNames() Gets the attribute name for the CMDBGraphAdjacency.
int	getObjectAttributeType() Gets the attribute type of the CMDBGraphAdjacency.
CMDBClassNameKey	getObjectClassName() Gets the name of the class involved in the adjacency.
java.lang.Object	getObjectQuery() Gets the query for the CMDBGraphAdjacency object instance.
int	getObjectQueryType() Gets the type of CMDBGraphAdjacency object qualification
java.lang.String[]	getRelationAttributeNames() Gets the attribute name of the adjacency.
int	getRelationAttributeType() Gets the attribute type of the adjacency.
CMDBClassNameKey	getRelationClassName() Gets the name of the relationship involved in the adjacency.
java.lang.Object	getRelationQuery() Gets the query for the CMDBGraphAdjacency relation instance.
int	getRelationQueryType() Gets the type of CMDBGraphAdjacency relation qualification
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 retrieve.
void	setObjectQuery(java.lang.Object objectQuery) Sets the query for the CMDBGraphAdjacency object instance
void	setRelationAttribute(int type) Sets the type of the attributes to be retrieved.
void	setRelationAttribute(java.lang.String[] attributeNames) Sets the names of the attributes to be retrieved.
void	setRelationQuery(java.lang.Object relationQuery) Sets the query for the CMDBGraphAdjacency relation instance

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

Do not get any attributes.

See Also:

Constant Field Values

CMDB_GET_ATTR_NOHIDDEN

public static final int CMDB_GET_ATTR_NOHIDDEN

Get all attributes that are not hidden.

See Also:

Constant Field Values

CMDB_GET_ATTR_ALL

public static final int CMDB_GET_ATTR_ALL

Get all attributes.

See Also:

Constant Field Values

CMDB_GRAPH_QUAL_TYPE_NONE

public static final int CMDB_GRAPH_QUAL_TYPE_NONE

Do not have query specified

See Also:

Constant Field Values

CMDB_GRAPH_QUAL_TYPE_STRING

public static final int CMDB_GRAPH_QUAL_TYPE_STRING

The query is a string

See Also:

Constant Field Values

CMDB_GRAPH_QUAL_TYPE_STRUCT

public static final int CMDB_GRAPH_QUAL_TYPE_STRUCT

The query is a QualifierInfo object

See Also:

Constant Field Values

Constructor Detail

CMDBGraphAdjacency

public CMDBGraphAdjacency()

Default constructor.

CMDBGraphAdjacency

public CMDBGraphAdjacency(CMDBClassNameKey relationClassName,
                          CMDBClassNameKey objectClassName)

Constructor.

Parameters:

relationClassName - the name of the relationship involved in the adjacency

objectClassName - the name of the class involved in the adjacency

Method Detail

getRelationClassName

public CMDBClassNameKey getRelationClassName()

Gets the name of the relationship involved in the adjacency.

Returns:

the name of the class

getRelationQuery

public java.lang.Object getRelationQuery()

Gets the query for the CMDBGraphAdjacency relation instance.

Returns:

the query that qualifies relation instance returned. The query object can be either a string or a QualifierInfo object. Please call getRelationQueryType() to retrieve the type.

getRelationQueryType

public int getRelationQueryType()

Gets the type of CMDBGraphAdjacency relation qualification

Returns:

the qualification type of relation instance in the adjacency. 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 adjacency.

Returns:

the attribute type

getRelationAttributeNames

public java.lang.String[] getRelationAttributeNames()

Gets the attribute name of the adjacency.

Returns:

the attribute name array

getObjectClassName

public CMDBClassNameKey getObjectClassName()

Gets the name of the class involved in the adjacency.

Returns:

the class name

getObjectQuery

public java.lang.Object getObjectQuery()

Gets the query for the CMDBGraphAdjacency object instance.

Returns:

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

getObjectQueryType

public int getObjectQueryType()

Gets the type of CMDBGraphAdjacency object qualification

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.

Returns:

the attribute type

getObjectAttributeNames

public java.lang.String[] getObjectAttributeNames()

Gets the attribute name for the CMDBGraphAdjacency.

Returns:

the attribute name

getExtensionId

public java.lang.String getExtensionId()

Gets the extension ID of the class in the adjacency

Returns:

the extension ID

setRelationQuery

public void setRelationQuery(java.lang.Object relationQuery)

Sets the query for the CMDBGraphAdjacency relation instance

Parameters:

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

setRelationAttribute

public void setRelationAttribute(int type)

Sets the type of the 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 is not one of the above types

setRelationAttribute

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

Sets the names of the 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 instance

Parameters:

objectQuery - a query to qualify object instance returned. The query can be either a string or a QualifierInfo object. 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 is not one of the above types

setObjectAttribute

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

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

Parameters:

attributeNames - the names of 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