com.bmc.cmdb.api
Class CMDBUIComponentResult

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

All Implemented Interfaces:

java.lang.Comparable

public class CMDBUIComponentResult
extends java.lang.Object
implements java.lang.Comparable

The CMDBUIComponentResult class allows you to work with an object that contains the user interface components associated with a class. After you create the object, you can run queries against it and perform comparisons against it, based on the qualifications you specify.

Constructor Summary

CMDBUIComponentResult()
Creates an empty CMDBUIComponentResult object.

CMDBUIComponentResult(java.lang.String aInstanceId, CMDBUIComponentInfo aCompInfo, java.lang.String aDataString, AttachmentValue aAttachVal)
Creates a CMDBUIComponentResult object for the specified instance using the component information, data string, and attachment.

Method Summary

int	compareTo(java.lang.Object o) Compares this object with the given CMDBUIComponentResult object.
AttachmentValue	getAttachVal() Gets the attachment for the CMDBUIComponentResult object.
CMDBUIComponentInfo	getCompInfo() Gets the UI component information for the CMDBUIComponentResult object.
java.lang.String	getDataString() Gets the data string value for the CMDBUIComponentResult object.
java.lang.String	getInstanceId() Gets the instance ID of the CMDBUIComponentResult object.
boolean	runQualificationForInstance(ARServerUser context, CMDBInstanceBase instanceBase) Validates the qualification for the CMDBUIComponentINfo object for the specified instance.
void	setAttachVal(AttachmentValue aAttachVal) Sets the attachment for the CMDBUIComponentResult object.
void	setCompInfo(CMDBUIComponentInfo aCompInfo) Sets the UI component information for the CMDBUIComponentResult object.
void	setDataString(java.lang.String aDataString) Sets the data string for the CMDBUIComponentResult object.
void	setInstanceId(java.lang.String aInstanceId) Sets the instance ID for the CMDBUIComponentResult object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CMDBUIComponentResult

public CMDBUIComponentResult()

Creates an empty CMDBUIComponentResult object.

CMDBUIComponentResult

public CMDBUIComponentResult(java.lang.String aInstanceId,
                             CMDBUIComponentInfo aCompInfo,
                             java.lang.String aDataString,
                             AttachmentValue aAttachVal)

Creates a CMDBUIComponentResult object for the specified instance using the component information, data string, and attachment.

Parameters:

aInstanceId - instance ID of the CMDBUIComponentResult object

aCompInfo - information about the UI component

aDataString - data string for the UI component

aAttachVal - attachment for the UI component

Method Detail

getInstanceId

public java.lang.String getInstanceId()

Gets the instance ID of the CMDBUIComponentResult object.

Returns:

instanceId instance ID of the CMDBUIComponentResult object

getCompInfo

public CMDBUIComponentInfo getCompInfo()

Gets the UI component information for the CMDBUIComponentResult object.

Returns:

compInfo UI component information for the CMDBUIComponentResult object

getDataString

public java.lang.String getDataString()

Gets the data string value for the CMDBUIComponentResult object.

Returns:

dataString data string value for the CMDBUIComponentResult object

getAttachVal

public AttachmentValue getAttachVal()

Gets the attachment for the CMDBUIComponentResult object.

Returns:

attachVal attachment for the CMDBUIComponentResult object

setInstanceId

public void setInstanceId(java.lang.String aInstanceId)

Sets the instance ID for the CMDBUIComponentResult object.

Parameters:

aInstanceId - instance ID for the CMDBUIComponentResult object

setCompInfo

public void setCompInfo(CMDBUIComponentInfo aCompInfo)

Sets the UI component information for the CMDBUIComponentResult object.

Parameters:

aCompInfo - UI component information for the CMDBUIComponentResult object

setDataString

public void setDataString(java.lang.String aDataString)

Sets the data string for the CMDBUIComponentResult object.

Parameters:

aDataString - data string for the CMDBUIComponentResult object

setAttachVal

public void setAttachVal(AttachmentValue aAttachVal)

Sets the attachment for the CMDBUIComponentResult object.

Parameters:

aAttachVal - attachment for the CMDBUIComponentResult object

runQualificationForInstance

public boolean runQualificationForInstance(ARServerUser context,
                                           CMDBInstanceBase instanceBase)

Validates the qualification for the CMDBUIComponentINfo object for the specified instance.

Returns:

true if this object is for the given instance, false otherwise

compareTo

public int compareTo(java.lang.Object o)

Compares this object with the given CMDBUIComponentResult object. The first comparison is based on the component type. If the types are the same, then the actual comparison is completed. For example, if both objects are Tooltips, they are compared based on precedence value.

Specified by:

compareTo in interface java.lang.Comparable

See Also:

Comparable.compareTo(java.lang.Object)