PropertiesCarrier (api-interfaces 11.0.3 API)

Type Parameters:

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

All Known Subinterfaces:

DirectLink, ExecutableQuery, HistoryTypedDataLayout, 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Collection<String>`	`excludedProperties()` Returns the collection of properties to exclude.
`E`	`excludeProperties(String... names)` Adds the properties to the list of exclusions.
`E`	`excludeProperty(String name)` Adds the property name to the list of exclusions.
`PropertiesToQuery`	`getDefaultPropertiesToQuery()` Returns an object that represents the properties for query for all sub types.
`Map<String,? extends PropertiesToQuery>`	`getPropertiesToQueryPerType()` Returns the properties to query for each type.
`boolean`	`isPropertiesCarrierEmpty()` Returns true if the request is empty (no property is to be brought).
`PropertiesCarrierBehavior`	`propertiesCarrierBehavior()` Returns the behavior that will effect this properties carrier.
`PropertiesToQuery`	`propertiesToQuery(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(String... names)` Adds the properties with the specifed names to the list of properties to query.
`E`	`queryPropertiesWithQualifier(String qualifierName)` Adds the properties that have the specified qualifier to the list of properties to query.
`E`	`queryProperty(String name)` Adds the specified property to the list of properties to query.
`E`	`withPropertiesCarrierBehavior(PropertiesCarrierBehavior newBehavior)` Sets the behavior for this properties carrier.

- Method Detail
  - propertiesCarrierBehavior
```
PropertiesCarrierBehavior propertiesCarrierBehavior()
```
    Returns the behavior that will effect this properties carrier. See PropertiesCarrierBehavior for possible behaviors.
    
    Returns:
    
    the behavior that will effect this properties carrier.
  - withPropertiesCarrierBehavior
```
E withPropertiesCarrierBehavior(PropertiesCarrierBehavior newBehavior)
```
    Sets the behavior for this properties carrier. See PropertiesCarrierBehavior for possible behaviors.
    
    Parameters:
    
    newBehavior - the new behavior.
    
    Returns:
    
    this object for method chaining.
  - queryProperty
```
E queryProperty(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(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(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(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
```
Map<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.
  - excludeProperty
```
E 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
```
E 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.
  - isPropertiesCarrierEmpty
```
boolean isPropertiesCarrierEmpty()
```
    Returns true if the request is empty (no property is to be brought). Note that a false negative may occur due to exclusions.
    
    Returns:
    
    true if there are no properties to query, false otherwise.

Interface PropertiesCarrier<E>

Method Summary

Method Detail

propertiesCarrierBehavior

withPropertiesCarrierBehavior

queryProperty

queryProperties

queryKeyProperties

queryPropertiesWithQualifier

propertiesToQuery

getDefaultPropertiesToQuery

getPropertiesToQueryPerType

excludeProperty

excludeProperties

excludedProperties

isPropertiesCarrierEmpty