com.hp.ucmdb.api.topology

Interface PropertiesToQuery

public interface PropertiesToQuery

Defines a set of properties to retrieve as part of the query results.

Method Summary

Modifier and Type	Method and Description
PropertiesToQuery	addKeyProperties() Sets to retrieve the key properties of CIs and relations.
PropertiesToQuery	addProperties(String... names) Adds the specified properties to the list of properties to query.
PropertiesToQuery	addPropertiesWithQualifier(String qualifierName) Sets to retrieve all properties having the specified qualifier.
PropertiesToQuery	addProperty(String name) Adds the named property to the list of properties to query.
Collection<String>	excludedProperties() Returns the collection of properties to exclude.
PropertiesToQuery	excludeProperties(String... names) Adds the properties to the list of exclusions.
PropertiesToQuery	excludeProperty(String name) Adds the property name to the list of exclusions.
boolean	isEmpty() Returns true if the request is empty (no property is to be brought).
Collection<String>	namedProperties() Returns the list of properties names added to the properties request.
PropertiesCarrierBehavior	propertiesCarrierBehavior() Returns the behavior that will effect this "level".
Collection<String>	qualifierMarkedProperties() Returns the list of qualifiers added to the properties request.
boolean	shouldQueryConcreteProperties() Return true if concrete properties were added to result.
boolean	shouldQueryConcretePropertiesAggregated() Return true if concrete aggregated properties were added to result.
PropertiesToQuery	withPropertiesCarrierBehavior(PropertiesCarrierBehavior newBehavior) Sets the behavior for this level.

Method Detail

addProperty

PropertiesToQuery addProperty(String name)

Adds the named 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.

addProperties

PropertiesToQuery addProperties(String... names)

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

Parameters:

names - the names of the properties to add.

Returns:

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

addKeyProperties

PropertiesToQuery addKeyProperties()

Sets to retrieve the key properties of CIs and relations.

Returns:

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

addPropertiesWithQualifier

PropertiesToQuery addPropertiesWithQualifier(String qualifierName)

Sets to retrieve all properties having the specified qualifier.

Parameters:

qualifierName -

Returns:

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

qualifierMarkedProperties

Collection<String> qualifierMarkedProperties()

Returns the list of qualifiers added to the properties request.

Returns:

a list of qualifier names,

namedProperties

Collection<String> namedProperties()

Returns the list of properties names added to the properties request.

Returns:

a list of properties names,

isEmpty

boolean isEmpty()

Returns true if the request is empty (no property is to be brought).

Returns:

true if there are no properties to query, false otherwise.

propertiesCarrierBehavior

PropertiesCarrierBehavior propertiesCarrierBehavior()

Returns the behavior that will effect this "level". See PropertiesCarrierBehavior for possible behaviors.

Returns:

the behavior that will effect this "level".

withPropertiesCarrierBehavior

PropertiesToQuery withPropertiesCarrierBehavior(PropertiesCarrierBehavior newBehavior)

Sets the behavior for this level. See PropertiesCarrierBehavior for possible behaviors.

Parameters:

newBehavior - the new behavior.

Returns:

this object for method chaining.

excludeProperty

PropertiesToQuery excludeProperty(String name)

Adds the property name to the list of exclusions. This property will not be brought in the result.

Note: if a property appears in both include and exclude lists (or is included indirectly by other methods, such as qualifiers), the exclusion is considered the more dominant and the property will not be brought to the result.

Parameters:

name - the property to exclude.

Returns:

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

excludeProperties

PropertiesToQuery excludeProperties(String... names)

Adds the properties to the list of exclusions. These properties will not be brought in the result.

Note: if a property appears in both include and exclude lists (or is included indirectly by other methods, such as qualifiers), the exclusion is considered the more dominant and the property will not be brought to the result.

Parameters:

names - the properties to exclude.

Returns:

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

excludedProperties

Collection<String> excludedProperties()

Returns the collection of properties to exclude. Note: if a property appears in both include and exclude lists (or is included indirectly by other methods, such as qualifiers), the exclusion is considered the more dominant and the property will not be brought to the result.

Returns:

the collection of excluded properties.

shouldQueryConcreteProperties

boolean shouldQueryConcreteProperties()

Return true if concrete properties were added to result.

Returns:

True if concrete properties were added to result. False otherwise.

See Also:

QueryNode.queryConcreteProperties()

shouldQueryConcretePropertiesAggregated

boolean shouldQueryConcretePropertiesAggregated()

Return true if concrete aggregated properties were added to result.

Returns:

True if concrete derived properties were added to result. False otherwise.

See Also:

()