javax.cim
Interface CIMQualifiedElementInterface

All Known Implementing Classes:

CIMClass, CIMClassProperty, CIMMethod, CIMParameter

public interface CIMQualifiedElementInterface

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

Since:

JSR48 1.0.0

Method Summary

CIMQualifier	getQualifier(int pIndex) Get a qualifier by index.
CIMQualifier	getQualifier(java.lang.String name) 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 element
java.lang.Object	getQualifierValue(java.lang.String name) 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 name, java.lang.Object value) Checks whether the specified qualifier is one of the qualifiers defined for this property with the specified value.

Method Detail

getQualifier

public CIMQualifier getQualifier(int pIndex)

Get a qualifier by index.

Parameters:

pIndex - The index of the qualifier

Returns:

The Qualifier at index pIndex

getQualifier

public CIMQualifier getQualifier(java.lang.String name)

Gets a qualifier by name.

Parameters:

name - The name of the qualifier to get.

Returns:

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

getQualifierCount

public int getQualifierCount()

Get the number of qualifiers defined for this CIM Element.

Returns:

int The number of qualifiers.

getQualifiers

public CIMQualifier[] getQualifiers()

Returns the list of qualifiers for this element

Returns:

CIMQualifier[] qualifiers for this element

getQualifierValue

public java.lang.Object getQualifierValue(java.lang.String name)

Gets a qualifier value by name.

Parameters:

name - 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

public 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

public boolean hasQualifierValue(java.lang.String name,
                                 java.lang.Object value)

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:

name - the name of the qualifier

value - the value to be tested

Returns:

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