Package javax.cim

Interface CIMQualifiedElementInterface

All Known Implementing Classes:

CIMClass, CIMClassProperty, CIMMethod, CIMParameter, CIMQualifiedElementInterfaceImpl

public interface CIMQualifiedElementInterface

The CIMQualifiedElementInterface is used by CIM Elements that have qualifiers. For example, CIM Classes, CIM Properties, CIM Methods and CIM Parameters are all CIM Elements that have qualifiers.

Method Summary

Modifier and Type	Method	Description
CIMQualifier<?>	getQualifier(int pIndex)	Get a qualifier by index.
CIMQualifier<?>	getQualifier(java.lang.String pName)	Gets a qualifier by name.
int	getQualifierCount()	Get the number of qualifiers defined for this CIM Element.
CIMQualifier<?>[]	getQualifiers()	Returns the list of qualifiers for this class.
java.lang.Object	getQualifierValue(java.lang.String pName)	Gets a qualifier value by name.
boolean	hasQualifier(java.lang.String pName)	Checks whether the specified qualifier is one of the qualifiers in this CIM element.
boolean	hasQualifierValue(java.lang.String pName, java.lang.Object pValue)	Checks whether the specified qualifier is one of the qualifiers defined for this property with the specified value.

Method Detail

getQualifier

CIMQualifier<?> getQualifier(int pIndex)

Get a qualifier by index.

Parameters:

pIndex - The index of the qualifier.

Returns:

The Qualifier at index pIndex.

getQualifier

CIMQualifier<?> getQualifier(java.lang.String pName)

Gets a qualifier by name.

Parameters:

pName - The name of the qualifier to get.

Returns:

null if the qualifier does not exist, otherwise returns the reference to the qualifier.

getQualifierCount

int getQualifierCount()

Get the number of qualifiers defined for this CIM Element.

Returns:

The number of qualifiers.

getQualifiers

CIMQualifier<?>[] getQualifiers()

Returns the list of qualifiers for this class.

Returns:

Qualifiers for this class.

getQualifierValue

java.lang.Object getQualifierValue(java.lang.String pName)

Gets a qualifier value by name.

Parameters:

pName - The name of the qualifier to get.

Returns:

null if the qualifier does not exist or value is null, otherwise returns the reference to the qualifier.

hasQualifier

boolean hasQualifier(java.lang.String pName)

Checks whether the specified qualifier is one of the qualifiers in this CIM element.

Parameters:

pName - The name of the qualifier.

Returns:

true if the qualifier exists in this CIM element, otherwise false.

hasQualifierValue

boolean hasQualifierValue(java.lang.String pName,
                          java.lang.Object pValue)

Checks whether the specified qualifier is one of the qualifiers defined for this property with the specified value. This method will return false if the qualifier is not applied or if the value does not match.

Parameters:

pName - The name of the qualifier.

pValue - The value to be tested.

Returns:

true if the qualifier exists and has the value, otherwise false.