com.hp.ucmdb.api.topology
Interface PropertiesCarrier<E>

Type Parameters:

E - the extending element type, used for method chaining.

All Known Subinterfaces:

DirectLink, ExecutableQuery, ModelUpdateFilterElement, PropertiesCarrierWrapper, QueryNode

public interface PropertiesCarrier<E>

Indicates that the extending element can be defined to bring properties to the result topology.

Since:

UCMDB 9.0

Method Summary

PropertiesToQuery	getDefaultPropertiesToQuery() Returns an object that represents the properties for query for all sub types.
java.util.Map<java.lang.String,? extends PropertiesToQuery>	getPropertiesToQueryPerType() Returns the properties to query for each type.
PropertiesToQuery	propertiesToQuery(java.lang.String subType) Returns an object that represents the properties to query for elements of the specified subtype.
E	queryKeyProperties() Adds the key properties to the list of properties to query.
E	queryProperties(java.lang.String... names) Adds the properties with the specifed names to the list of properties to query.
E	queryPropertiesWithQualifier(java.lang.String qualifierName) Adds the properties that have the specified qualifier to the list of properties to query.
E	queryProperty(java.lang.String name) Adds the specified property to the list of properties to query.

Method Detail

queryProperty

E queryProperty(java.lang.String name)

Adds the specified property to the list of properties to query.

Parameters:

name - name of a property

Returns:

this object. The returned object can be used for method chaining.

See Also:

PropertiesCarrier

queryProperties

E queryProperties(java.lang.String... names)

Adds the properties with the specifed names to the list of properties to query.

Parameters:

names - names of properties

Returns:

this object. The returned object can be used for method chaining.

See Also:

PropertiesCarrier

queryKeyProperties

E queryKeyProperties()

Adds the key properties to the list of properties to query.

Returns:

this object. The returned object can be used for method chaining.

See Also:

PropertiesCarrier

queryPropertiesWithQualifier

E queryPropertiesWithQualifier(java.lang.String qualifierName)

Adds the properties that have the specified qualifier to the list of properties to query.

Returns:

this object. The returned object can be used for method chaining.

See Also:

PropertiesCarrier

propertiesToQuery

PropertiesToQuery propertiesToQuery(java.lang.String subType)

Returns an object that represents the properties to query for elements of the specified subtype. Modification of this object changes those properties. Note that the actual properties for a result element are determined by merging the the properties requests for subtypes "upwards" in the hierarchy chain, from the element actual type to the top-most element subtype that has a properties request defined for it. For example, requesting property "serial_number" from "node_element" and property "cpu_type" for "cpu" (cpu inherits from node_element) will yield the following:

• For a cpu CI, both "serial_number" and "cpu_type".
• For a cpu2 CI, if cpu2 inherits from cpu, both "serial_number" and "cpu_type".
• For an interface CI (interface inherits from node_element, but not from cpu), only "serial_number".
• For a node CI (node does not inherit from node_element at all), no properties (unless a getDefaultPropertiesToQuery() default properties set was defined).

Returns:

properties to query for elements of the specified subtype

See Also:

PropertiesCarrier

getDefaultPropertiesToQuery

PropertiesToQuery getDefaultPropertiesToQuery()

Returns an object that represents the properties for query for all sub types. Modification of this object changes those properties.

Returns:

properties to query for all elements.

See Also:

PropertiesCarrier

getPropertiesToQueryPerType

java.util.Map<java.lang.String,? extends PropertiesToQuery> getPropertiesToQueryPerType()

Returns the properties to query for each type. If no subtype-specific properties to query are defined, the resulting map is empty.

Returns:

a map of the names of the subtypes to the properties to query for each type

See Also:

PropertiesCarrier, for description about several inheriting subtypes.