com.bmc.cmdb.api
Class CMDBUIComponentInfo

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

public class CMDBUIComponentInfo
extends java.lang.Object

The CMDBUIComponentInfo class allows you to work with a CMDBUIComponentInfo object that stores the user interface components that are associated with a class. The user interface components are displayed with the class in a graphical display, such as the CI Viewer. After you create the association, you can perform queries against it.

Field Summary

static int	CMDB_COMPONENT_TYPE_ICON Specifies that the user interface component type is Icon.
static int	CMDB_COMPONENT_TYPE_LINE Specifies that the user interface component type is Line.
static int	CMDB_COMPONENT_TYPE_LOCALIZED_LABEL Specifies that the user interface component type is Label.
static int	CMDB_COMPONENT_TYPE_NONE Specifies that the user interface component type is none.
static int	CMDB_COMPONENT_TYPE_TOOLTIP Specifies that the user interface component type is Tooltip.

Constructor Summary

CMDBUIComponentInfo()
Creates an empty CMDBUIComponentInfo object.

CMDBUIComponentInfo(java.lang.String aClassId, java.lang.String aLocale, int aComponentType, java.lang.String aTag1, java.lang.String aTag2, java.lang.String aTag3, java.lang.String aTag4, java.lang.String aTag5, java.lang.String aEncodedQual)
Creates a CMDBGUIComponentInfo object using the specified class ID, locale, information tag, and encoded qualifier.

Method Summary

java.lang.String	getClassId() Gets the class ID for the UI component.
int	getComponentType() Gets the component type for the UI component.
java.lang.String	getEncodedQual() Gets the encoded qualifier string for the UI component.
java.lang.String	getLocale() Gets the locale for the UI component.
java.lang.String	getTag1() Gets the Tag1 for the UI component, which is the name of the application that owns the UI component.
java.lang.String	getTag2() Gets the Tag2 for the UI component, which is an integer from 1 to 5 to indicate the size of the UI component, with a smaller number meaning a smaller size.
java.lang.String	getTag3() Gets the Tag3 for the UI component, which is an integer to specify the format of the file attachment in ComponentAttachment.
java.lang.String	getTag4() Gets the Tag4 for the UI component, which is an integer to specify the precedence value of the UI component.
java.lang.String	getTag5() Gets the Tag5 for the UI component.
void	setClassId(java.lang.String aClassId) Sets the class ID for the UI component.
void	setComponentType(int aComponentType) Sets the component type for the UI component.
void	setEncodedQual(java.lang.String aEncodedQual) Sets the encoded qualfier string for the UI component.
void	setLocale(java.lang.String aLocale) Sets the locale for the UI component.
void	setTag1(java.lang.String aTag1) Sets the Tag1 string for the UI component.
void	setTag2(java.lang.String aTag2) Sets the Tag2 string for the UI component.
void	setTag3(java.lang.String aTag3) Sets the Tag3 string for the UI component.
void	setTag4(java.lang.String aTag4) Sets the Tag4 string for the UI component.
void	setTag5(java.lang.String aTag5) Sets the Tag5 string for the UI component.

Methods inherited from class java.lang.Object

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

Field Detail

CMDB_COMPONENT_TYPE_NONE

public static final int CMDB_COMPONENT_TYPE_NONE

Specifies that the user interface component type is none.

See Also:

Constant Field Values

CMDB_COMPONENT_TYPE_ICON

public static final int CMDB_COMPONENT_TYPE_ICON

Specifies that the user interface component type is Icon.

See Also:

Constant Field Values

CMDB_COMPONENT_TYPE_LOCALIZED_LABEL

public static final int CMDB_COMPONENT_TYPE_LOCALIZED_LABEL

Specifies that the user interface component type is Label.

See Also:

Constant Field Values

CMDB_COMPONENT_TYPE_TOOLTIP

public static final int CMDB_COMPONENT_TYPE_TOOLTIP

Specifies that the user interface component type is Tooltip.

See Also:

Constant Field Values

CMDB_COMPONENT_TYPE_LINE

public static final int CMDB_COMPONENT_TYPE_LINE

Specifies that the user interface component type is Line.

See Also:

Constant Field Values

Constructor Detail

CMDBUIComponentInfo

public CMDBUIComponentInfo()

Creates an empty CMDBUIComponentInfo object.

CMDBUIComponentInfo

public CMDBUIComponentInfo(java.lang.String aClassId,
                           java.lang.String aLocale,
                           int aComponentType,
                           java.lang.String aTag1,
                           java.lang.String aTag2,
                           java.lang.String aTag3,
                           java.lang.String aTag4,
                           java.lang.String aTag5,
                           java.lang.String aEncodedQual)

Creates a CMDBGUIComponentInfo object using the specified class ID, locale, information tag, and encoded qualifier.

Parameters:

aClassId - the class id for the UI component

aLocale - the name of the locale specific to the component. If no locale is specified, the default locale is used.

aTag1 - name of the application that owns the UI component. It should be a name other than BMC_CMDB, which is used for UI components supplied by BMC Atrium CMDB.

aTag2 - an integer from 1 to 5 to indicate the size of an icon, with a smaller number meaning a smaller size. For a standard 32-by-32-pixel icon, specify 3. This is the default for the icons shipped with the BMC Atrium CMDB. In this release, Tag2 is stored but not used.

aTag3 - an integer to specify the format of the file attachment in ComponentAttachment. Options are: 1 (JPEG), 2 (BMP), 3 (GIF), 4 (TIFF), or 5 (PNG). In this release, Tag3 is stored but not used.

aTag4 - an integer to specify the precedence value of the UI component. For example, when more than one icon?s ComponentLocale and ComponentQual match an instance to be represented in the CI Relationship Viewer, the icon with the highest precedence value is displayed. The icons shipped with the BMC Atrium CMDB all have a precedence value of 10.

aTag5 - the tag5 information tag for the UI component

aEncodedQual - qualification that specifies which instances of the class are represented by this component. If no qualification is specified, this component represents all instances of the class, subject to the values of Locale and Tag4. Qualifications use dollar signs to enclose attribute names. For example, the qualification $Name$ LIKE ?Computer%? matches instances where the value of the Name attribute begins with ?Computer?. If it is an enumeration, then you must enter the numeric value. For example, the qualification $ThermalState$=4 given for a computer system class matches instances where the Thermal State is ?Critical?.

Method Detail

getClassId

public java.lang.String getClassId()

Gets the class ID for the UI component.

Returns:

classId

getLocale

public java.lang.String getLocale()

Gets the locale for the UI component.

Returns:

locale

getComponentType

public int getComponentType()

Gets the component type for the UI component. Types are CMDB_COMPONENT_TYPE_NONE, CMDB_COMPONENT_TYPE_ICON, CMDB_COMPONENT_TYPE_LOCALIZED_LABEL, CMDB_COMPONENT_TYPE_TOOLTIP, and CMDB_COMPONENT_TYPE_LINE.

Returns:

component type for the UI component

getTag1

public java.lang.String getTag1()

Gets the Tag1 for the UI component, which is the name of the application that owns the UI component. It should be a name other than BMC_CMDB, which is used for UI components supplied by BMC Atrium CMDB.

Returns:

tag1 name of the application that owns the UI component

getTag2

public java.lang.String getTag2()

Gets the Tag2 for the UI component, which is an integer from 1 to 5 to indicate the size of the UI component, with a smaller number meaning a smaller size.

Returns:

tag2 an integer indicating the size of the UI component

getTag3

public java.lang.String getTag3()

Gets the Tag3 for the UI component, which is an integer to specify the format of the file attachment in ComponentAttachment. Options are: 1 (JPEG), 2 (BMP), 3 (GIF), 4 (TIFF), or 5 (PNG).

Returns:

tag3 an integer to specify the format of the file attachment

getTag4

public java.lang.String getTag4()

Gets the Tag4 for the UI component, which is an integer to specify the precedence value of the UI component. For example, When more than one icon?s ComponentLocale and ComponentQual match an instance to be represented in the CI Relationship Viewer, the icon with the highest precedence value is displayed. The icons shipped with the BMC Atrium CMDB all have a precedence value of 10.

Returns:

tag4 an integer to specify the precedence value of the UI component

getTag5

public java.lang.String getTag5()

Gets the Tag5 for the UI component.

Returns:

tag5 for the UI component

getEncodedQual

public java.lang.String getEncodedQual()

Gets the encoded qualifier string for the UI component.

Returns:

encodeQual qualification that specifies which instances of the class are represented by this UI component.

setClassId

public void setClassId(java.lang.String aClassId)

Sets the class ID for the UI component.

Parameters:

aClassId - class ID of the UI component

setLocale

public void setLocale(java.lang.String aLocale)

Sets the locale for the UI component.

Parameters:

aLocale - locale for the UI component

setComponentType

public void setComponentType(int aComponentType)

Sets the component type for the UI component. Types are CMDB_COMPONENT_TYPE_NONE, CMDB_COMPONENT_TYPE_ICON, CMDB_COMPONENT_TYPE_LOCALIZED_LABEL, CMDB_COMPONENT_TYPE_TOOLTIP, and CMDB_COMPONENT_TYPE_LINE.

Parameters:

aComponentType - component type for the UI component

setTag1

public void setTag1(java.lang.String aTag1)

Sets the Tag1 string for the UI component.

Parameters:

aTag1 - name of the application that owns the UI component. It should be a name other than BMC_CMDB, which is used for UI components supplied by BMC Atrium CMDB.

setTag2

public void setTag2(java.lang.String aTag2)

Sets the Tag2 string for the UI component.

Parameters:

aTag2 - an integer from 1 to 5 to indicate the size of the UI component, with a smaller number meaning a smaller size.

setTag3

public void setTag3(java.lang.String aTag3)

Sets the Tag3 string for the UI component.

Parameters:

aTag3 - an integer to specify the format of the file attachment in ComponentAttachment. Options are: 1 (JPEG), 2 (BMP), 3 (GIF), 4 (TIFF), or 5 (PNG).

setTag4

public void setTag4(java.lang.String aTag4)

Sets the Tag4 string for the UI component.

Parameters:

aTag4 - an integer to specify the precedence value of the UI component. For example, When more than one icon?s ComponentLocale and ComponentQual match an instance to be represented in the CI Relationship Viewer, the icon with the highest precedence value is displayed. The icons shipped with the BMC Atrium CMDB have a precedence value of 10.

setTag5

public void setTag5(java.lang.String aTag5)

Sets the Tag5 string for the UI component.

Parameters:

aTag5 -

setEncodedQual

public void setEncodedQual(java.lang.String aEncodedQual)

Sets the encoded qualfier string for the UI component.

Parameters:

aEncodedQual - qualification that specifies which instances of the class are represented by this component. If no qualification is specified, this component represents all instances of the class, subject to the values of Locale and Tag4. Qualifications use dollar signs to enclose attribute names. For example, the qualification $Name$ LIKE ?Computer%? matches instances where the value of the Name attribute begins with ?Computer?. If it is an enumeration, then you must enter the numeric value. For example, the qualification $ThermalState$=4 given for a computer system class matches instances where the Thermal State is ?Critical?.