javax.cim

Class CIMParameter

public class CIMParameter extends CIMTypedElement implements CIMQualifiedElementInterface, Serializable

The CIMParameter class wraps a CIM paramter that is used to define an input, output or input/output parameter to a CIM method. A CIMParameter object consists of a name, data type and a list of qualifiers. NOTE: Parameters do not have values - so you can not set a default value. CIM Parameters are defined in the CIM Infrastructure Specification. The specification is available from the DMTF (Distributed Management Task Force) at http://dmtf.org/.

See Also: CIMMethod

Constructor Summary
CIMParameter(String pName, CIMDataType pType, CIMQualifier[] pQualifiers)
Constructs a CIMParameter object using the specified name, data type and qualifiers.
Method Summary
booleanequals(Object pObj)
CIMParameterfilter(boolean pIncludeQualifiers, boolean pLocalOnly)
Returns a CIMParameter filtered as specified.
CIMQualifiergetQualifier(int pIndex)
CIMQualifiergetQualifier(String pName)
intgetQualifierCount()
CIMQualifier[]getQualifiers()
ObjectgetQualifierValue(String pName)
booleanhasQualifier(String pName)
booleanhasQualifierValue(String pName, Object pValue)
StringtoString()
Returns a String representation of the CIMParameter.

Constructor Detail

CIMParameter

public CIMParameter(String pName, CIMDataType pType, CIMQualifier[] pQualifiers)
Constructs a CIMParameter object using the specified name, data type and qualifiers. Takes a string for the name of an existing CIM parameter and creates a new instance of a CIM parameter, using the name and identifier of the existing CIM parameter.

Parameters: pName - name of this parameter pType - data type of this parameter pQualifiers - qualifiers for this parameter

Method Detail

equals

public boolean equals(Object pObj)

See Also: CIMTypedElement

filter

public CIMParameter filter(boolean pIncludeQualifiers, boolean pLocalOnly)
Returns a CIMParameter filtered as specified.

Parameters: pIncludeQualifiers If true all qualifiers are returned; otherwise no qualifiers. pLocalOnly If true only the qualifiers that were not propagated will be included.

Returns: A filtered CIMParameter.

getQualifier

public CIMQualifier getQualifier(int pIndex)

See Also: CIMQualifiedElementInterface

getQualifier

public CIMQualifier getQualifier(String pName)

See Also: CIMQualifiedElementInterface

getQualifierCount

public int getQualifierCount()

See Also: getQualifierCount

getQualifiers

public CIMQualifier[] getQualifiers()

See Also: getQualifiers

getQualifierValue

public Object getQualifierValue(String pName)

See Also: CIMQualifiedElementInterface

hasQualifier

public boolean hasQualifier(String pName)

See Also: CIMQualifiedElementInterface

hasQualifierValue

public boolean hasQualifierValue(String pName, Object pValue)

See Also: CIMQualifiedElementInterface

toString

public String toString()
Returns a String representation of the CIMParameter. This method is intended to be used only for debugging purposes, and the format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Returns: string representation of this parameter

Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.