Change propagation

Signature: OwnProperties asset.props

Returns an accessor to the properties of the current asset. From here, use a property code name (or a quoted identifier). Please note that you must declare required own properties as dependencies. Otherwise, a compile error will occur.

Returns: The own properties of the asset, limited to the ones specified in the rule.

Example:

asset.props.firstName

Signature: OwnReferences asset.links

Returns an accessor to the links of the current asset. From there, you can constrain the set of links by using asset.links.in or asset.links.out to only the incoming or only the outgoing references, respectively.

Returns: The own references of the asset, limited to the ones specified in the rule. This includes both incoming and outgoing references; they can be filtered afterwards (see example).

Example:

// restricts to the outgoing "runsOn" links
asset.links.out.runsOn
// restricts to the incoming "hosts" links
asset.links.in.hosts

Signature: IncomingReferences asset.links.in

Returns an accessor to the incoming links of an asset. From there, you can specify a link name, and optionally restrict to a Type.

Returns: An accessor to the incoming links of an asset.

Example:

// restricts to the "runsOn" link incoming from "VirtualMachine"
asset.links.in.runsOn.VirtualMachine
// restricts to the incoming "runs on" link, regardless of opposite Type
asset.links.in.runsOn

Signature: OutgoingReferences asset.links.out

Returns an accessor to the outgoing links of an asset. From there, you can restrict by Type, or specify a link name.

Returns: An accessor to the outgoing links of an asset.

Example:

// restricts to the "runsOn" links which lead to an instance of "VirtualMachine"
asset.links.out.runsOn.VirtualMachine
// restricts to the "runsOn" links, regardless of the opposite Type
asset.links.out.runsOn

Signature: NeighborProperties links.props

Returns an accessor to the properties of the current asset collection. Note that this collection will be multiplicity-many, even if the property is multiplicity-one, if the preceding link is multiplicity-many.

Returns: An accessor to the properties of the asset collection.

Example:

// accesses the collection of "status" properties on all entities which are reachable via the outgoing "runsOn" link
asset.links.out.runsOn.props.status
// accesses the collection of "cost" properties on all entities of type Service which are reachable via the incoming "depends on" link
asset.links.in.dependsOn.Service.props.cost

Signature: LinkProperties links.linkProps

Returns an accessor to the Link Properties of the current Link collection. Note that this collection will be multiplicity-many, even if the Property is multiplicity-one, if the preceding Link is multiplicity-many.

Returns: An accessor to the properties of the asset collection.

Example:

// accesses the collection of "port" Properties on all assets which are reachable via the outgoing "runsOn" link
asset.links.out.runsOn.linkProps.port
// accesses the collection of "protocol" Properties on all assets of type Service which are reachable via the incoming "depends on" link
asset.links.in.communicatesWith.Service.linkProps.protocol

Signature: LinkCollection linkCollection.havingAsset(closure: Closure<Asset>)

Filters the links in the collection by applying the given condition to the asset at the other end of the link. Please note that the result will still be another link collection, therefore chaining multiple having and havingAsset calls together is valid. Inside the closure, use it to refer to the asset at the other end of the current link.

Parameters:

• closure — The filter condition to apply to the asset at the other end of the link

Returns: A new collection of links, filtered by the given predicate on the other-end asset.

Signature: void linkCollection.forEachLink(closure: Closure<Link>)

Executes the given closure operation for each link in the collection.

Parameters:

• closure — The operation to apply for each link.

Returns: The forEachLink method itself returns nothing (void). However, you may modify script variables within the closure, as shown in the example.

Example:

def usedProtocols = new HashSet<String>()
// iterate over all outgoing "runsOn" links
entity.links.out.runsOn.forEachLink({
    // look at the protocol of the current link (it)
    def protocol = it.protocol.value(null)
    // if a protocol is assigned...
    if(protocol != null){
      // ... add it to the set of protocols.
      usedProtocols.add(protocol)
    }
})
return protocols

The following methods are available on all multiplicity-one properties (regardless of the Property Type).

Signature: boolean propertyValue.is(other: Object)

Checks if the stored value is equal to the given one. Will return false if the given property is not set (unassigned).

Please always prefer using is over using the equality (==) operator, because it may perform implicit conversions (specific to Txture) which are not present in the general-purpose Groovy equality operator.

Parameters:

• other — The other object to compare with.

Returns:true if the property value is equal to other, otherwise false.

Example:

// checks if the asset we run on has its status set to "online"
def isServerOnline = asset.links.out.runsOn.props.status.is("online")
// checks if the number of cores of the asset we run on is exactly 4
def has4Cores = asset.links.out.runsOn.props.cores.is(4)

Signature: boolean propertyValue.isPresent()

Checks if any value for the property is set (i.e. checks if the property is assigned or not). Returns true if a value is assigned to the property, otherwise returns false.

Important: If isPresent() is used on a Property after following a Link, then isPresent() will also return false if that Link had no target.

Returns:true if a property value is present, otherwise false.

Example:

// checks if our asset has a business contact assigned
def hasBusinessContact = asset.props.businessContact.isPresent()
// checks if the asset we run on has a responsible person assigned
def hasResponsiblePerson = asset.links.out.runsOn.props.responsible.isPresent()

Signature: boolean propertyValue.isManuallyMaintained()

Returns true if the last modification to the property value has been performed manually by a Txture user.

When used on a property returned by linkProps, then this method will be available if and only if the link in question is uniquely named and single-valued. For multi-valued links, containsManuallyMaintained() and allManuallyMaintained() are offered as an alternative.

Returns:true if the last modification to the property value has been performed manually by a Txture user, otherwise false.

Example:

// checks if the business contact has been assigned manually
def isBusinessContactManuallyMaintained = asset.props.businessContact.isManullyMaintained()
// checks if the "port" property on the "runsOn" link has been manually maintained.
// this works only if "runsOn" is single-valued.
def isRunsOnPortManuallyMaintained = asset.links.out.runsOn.linkProps.port.isManuallyMaintained()

Signature: boolean propertyValue.containsManuallyMaintained()

Returns true if the last modification to any of the property values has been performed manually by a Txture user.

This method is only available on properties returned by linkProps when:

• the link in question is multi-valued
• OR the link is not uniquely named and there has been no type restriction on the link target.

Returns:true if the last modification to any of the property values has been performed manually by a Txture user, otherwise false.

Example:

// checks if any of the "port" properties on the "runsOn" links have been manually maintained.
// this works only if "runsOn" is multi-valued, or there are multiple links named "runsOn"
// (e.g. runsOn VM, runsOn PhysicalServer).
def isAnyRunsOnPortManuallyMaintained = asset.links.out.runsOn.linkProps.port.containsManuallyMaintained()

Signature: boolean propertyValue.allManuallyMaintained()

Returns true if the last modification to all of the property values has been performed manually by a Txture user.

This method is only available on properties returned by linkProps when:

• the link in question is multi-valued
• OR the link is not uniquely named and there has been no type restriction on the link target.

Returns:true if the last modification to all of the property values has been performed manually by a Txture user, otherwise false.

Example:

// checks if all of the "port" properties on the "runsOn" links have been manually maintained.
// this works only if "runsOn" is multi-valued, or there are multiple links named "runsOn"
// (e.g. runsOn VM, runsOn PhysicalServer).
def areAllRunsOnPortManuallyMaintained = asset.links.out.runsOn.linkProps.port.allManuallyMaintained()

Signature: boolean propertyValue.isImported()

Returns true if the last modification to the property value has been performed manually by an Importer.

When used on a property returned by linkProps, then this method will be available if and only if the link in question is uniquely named and single-valued. For multi-valued links, containsImported() and allImported() are offered as an alternative.

Returns:true if the last modification to the property value has been performed by an Importer, otherwise false.

Example:

// checks if the business contact has been assigned by an importer
def isBusinessContactImported = asset.props.businessContact.isImported()
// checks if the "port" property on the "runsOn" link has been imported.
// this works only if "runsOn" is single-valued.
def isRunsOnPortImported = asset.links.out.runsOn.linkProps.port.isImported()

Signature: boolean propertyValue.containsImported()

Returns true if the last modification to any of the property values has been performed by an Importer.

This method is only available on properties returned by linkProps when:

• the link in question is multi-valued
• OR the link is not uniquely named and there has been no type restriction on the link target.

Returns:true if the last modification to any of the property values has been performed by an Importer, otherwise false.

Example:

// checks if any of the "port" properties on the "runsOn" links have been imported.
// this works only if "runsOn" is multi-valued, or there are multiple links named "runsOn"
// (e.g. runsOn VM, runsOn PhysicalServer).
def isAnyRunsOnPortImported = asset.links.out.runsOn.linkProps.port.containsImported()

Signature: boolean propertyValue.allImported()

Returns true if the last modification to all of the property values has been performed by an Importer.

This method is only available on properties returned by linkProps when:

• the link in question is multi-valued
• OR the link is not uniquely named and there has been no type restriction on the link target.

Returns:true if the last modification to all of the property values has been performed by an Importer, otherwise false.

Example:

// checks if all of the "port" properties on the "runsOn" links have been imported.
// this works only if "runsOn" is multi-valued, or there are multiple links named "runsOn"
// (e.g. runsOn VM, runsOn PhysicalServer).
def areAllRunsOnPortsImported = asset.links.out.runsOn.linkProps.port.allImported()

Signature: boolean propertyValue.isInferred()

Returns true if the last modification to the property value has been performed by an inference mechanism (e.g. Change).

When used on a property returned by linkProps, then this method will be available if and only if the link in question is uniquely named and single-valued. For multi-valued links, containsImported() and allImported() are offered as an alternative.

Returns:true if the last modification to the property value has been performed by an inference mechanism (e.g. Change Propagation), otherwise false.

Example:

// checks if the business contact has been assigned by by an inference mechanism
def isBusinessContactInferred = asset.props.businessContact.isInferred()
// checks if the "port" property on the "runsOn" link has been inferred.
// this works only if "runsOn" is single-valued.
def isRunsOnPortInferred = asset.links.out.runsOn.linkProps.port.isInferred()

Signature: boolean propertyValue.containsInferred()

Returns true if the last modification to any of the property values has been performed by an inference mechanism (e.g. Change Propagation).

This method is only available on properties returned by linkProps when:

• the link in question is multi-valued
• OR the link is not uniquely named and there has been no type restriction on the link target.

Returns:true if the last modification to any of the property values has been performed by an inference mechanism (e.g. Change Propagation), otherwise false.

Example:

// checks if any of the "port" properties on the "runsOn" links have been inferred.
// this works only if "runsOn" is multi-valued, or there are multiple links named "runsOn"
// (e.g. runsOn VM, runsOn PhysicalServer).
def isAnyRunsOnPortInferred = asset.links.out.runsOn.linkProps.port.containsInferred()

Signature: boolean propertyValue.allInferred()

Returns true if the last modification to all of the property values has been performed by an inference mechanism (e.g. Change Propagation).

This method is only available on properties returned by linkProps when:

• the link in question is multi-valued
• OR the link is not uniquely named and there has been no type restriction on the link target.

Returns:true if the last modification to all of the property values has been performed by an inference mechanism (e.g. Change Propagation), otherwise false.

Example:

// checks if all of the "port" properties on the "runsOn" links have been inferred.
// this works only if "runsOn" is multi-valued, or there are multiple links named "runsOn"
// (e.g. runsOn VM, runsOn PhysicalServer).
def areAllRunsOnPortsInferred = asset.links.out.runsOn.linkProps.port.allInferred()

Signature: Date / List<Date> propertyValue.lastModifiedDate

Returns the last modification date(s) of the property value.

This method will return:

• a single Date (or null if unassigned) for properties returned by asset.props, or for properties returned by linkProps if the link is single-valued and uniquely named.
• a list of Dates (potentially empty) for properties on many-valued or non-uniquely named links or their target assets.

WARNING: The value returned by lastModifiedDate will be referring to the previous modification, not the current modification which triggered the Change Propagation! The use of this property in Propagation Rules is generally discouraged.

Returns: The last modification date(s) of the property.

Example:

// get the last modification date of the asset name.
def nameLastModified = asset.props.name.lastModifiedDate

// get the last modification date of the emails property
// (multi-valued properties still only have a single last-modified date)
def emailLastModified = asset.props.emailAddresses.lastModifiedDate

// gets the last modification date of the "runsOn" link property "port".
// (note: this works only if "runsOn" is a single-valued, uniquely named link)
def portLastModified = asset.links.out.runsOn.linkProps.port.lastModifiedDate

// here, "usesStorage" is a many-valued (or non-uniquely named) link. Note that
// we can use the "max()" operator in the end to get the latest modification date
// among all the modification dates of the "capacity" properties on the connected storages.
def storageCapacityLastModified = asset.links.out.usesStorage.props.capacity.lastModifiedDate.max()

Signature: Date / List<Date> propertyValue.creationDate

Returns the creation date(s) of the property value.

This method will return:

• a single Date (or null if unassigned) for properties returned by asset.props, or for properties returned by linkProps if the link is single-valued and uniquely named.
• a list of Dates (potentially empty) for linkProps on many-valued or non-uniquely named links.

Returns: The last modification date(s) of the property.

Example:

// get the creation date of the asset name.
def nameCreationDate = asset.props.name.creationDate

// get the creation date of the emails property
// (multi-valued properties still only have a single creation modified date)
def emailLastModified = asset.props.emailAddresses.creationDate

// gets the creation date of the "runsOn" link property "port".
// (note: this works only if "runsOn" is a single-valued, uniquely named link)
def portLastModified = asset.links.out.runsOn.linkProps.port.creationDate

// here, "usesStorage" is a many-valued (or non-uniquely named) link. Note that
// we can use the "min()" operator in the end to get the earliest creation date
// among all the creation dates of the "capacity" properties on the connected storages.
def storageCapacityLastModified = asset.links.out.usesStorage.props.capacity.creationDate.min()

Signature: String StringProperty.value(default: String)

Returns the raw primitive value of this Property, or the given default if it is unassigned.

Please note that it is usually not necessary to ever use .value(), as the majority of operations (e.g. string concatenation) can be performed on the property itself.

This method is only available on single-valued properties.

Parameters:

• default — The default value to return if the property is unassigned.

Returns: The raw property value, or the given default if unassigned.

Example:

// gets the name of the contact person of our asset, or "John Doe" if none is set
def contactPersonName = asset.props.contactPerson.value("John Doe");

Signature: Double NumericProperty.value(Double default)

Returns the raw primitive value of this Property. If the Property is not present, the given default value will be returned instead.

Parameters:

• The default number to return if the property is unassigned.

Returns: The raw value of this property as a Double, or the given default if unassigned.

Example:

// gets the cost associated with this asset, or 100.0 if no cost is assigned.
def cost = asset.props.cost.value(100.0);

Signature: Boolean BooleanProperty.value(default: Boolean)

Returns the raw primitive value of this Property. If the Property is not present, the given default value will be returned instead.

Parameters:

• default — The default value to return if the property is unassigned.

Returns: The raw boolean value assigned to this property, or the given default if unassigned.

Example:

// returns the active state of this asset, or false if no active state is assigned.
def isActive = asset.props.active.value(false)

Signature: Double RangeProperty.lower()

Returns the lower bound of the range as a multiplicity-one Number Property. If this Property is unassigned, the returned Number Property will also be unassigned.

Returns: The lower bound of the property value range.

Example:

// checks if the value 0 is the lower bound of the maintenanceTime range
def maintenanceStartsAtMidnight = asset.props.maintenanceTime.lower().is(0)

Signature: Boolean Property.is(List values)

Checks if the values at hand are equal to the given list of values. Returns false if the Property is unassigned.

Parameters:

• values — The list of values to compare against.

Returns:true if the property values are equal to the given values, otherwise false. Always false for unassigned properties.

Example:

// checks if the maintainers are "John" and "Jack"
def maintainedByJohnAndJack = asset.props.maintainers.name.is(Lists.newArrayList("John", "Jack"))

Signature: List Property.value()

Returns the raw value of this Property as a List. If the Property is unassigned, an empty list will be returned. The type of elements in this list depend on the Property Type.

Returns: The property value as a raw list.

Example:

// checks if the maintainers are "John" and "Jack"
def maintainers = asset.props.maintainers.name.value()

Signature: Integer Property.size()

Returns the size (number of elements) of the list at hand. Will be zero if the Property is unassigned.

Returns: The number of elements in the property value list, or zero if unassigned.

Basic Example:

// counts the names of assets on which we run
def numberOfClusterMembers = asset.links.out.runsOn.props.name.size()

Link Collections Example:

// counts the assets on which we run
def numberOfClusterMembers = asset.links.out.runsOn.size()

Signature: Property Property.first()

Returns the first entry from the list of present values. The returned Property has the same type as this Property, but is multiplicity-one. Note that the returned Property may be unassigned if this Property is unassigned.

Returns: The first element of the property values, wrapped in a property.

Example:

// checks if the first maintainer in the list is "Jack"
def firstMaintainerIsJack = asset.props.maintainers.first().is("Jack")

Signature: Property Property.last()

Returns the last entry from the list of present values as a Property. The returned Property has the same type as this Property, but is multiplicity-one. Note that the returned Property may be unassigned if this Property is unassigned.

Returns: The last element of the property values, wrapped in a property.

Example:

// checks if the last maintainer in the list is "Jack"
def lastMaintainerIsJack = asset.props.maintainers.last().is("Jack")

Signature: Property Property.filter(Predicate predicate)

Returns a multiplicity-many Property which has the same values as the Property at hand, except that they are filtered by the given predicate. Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if filter(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc.

Parameters:

• predicate — The predicate to filter by. Input values for which the predicate returns true will appear in the output list (i.e. will be kept), input values for which the predicate returns false will not appear in the output list (i.e. will be filtered out).

Returns: A multi-valued property containing the filtered values.

Example:

// filters the list of maintainers for all names starting with "John" and counts the result list
def maintainersNamedJohn = asset.props.maintainers.filter({ it.startsWith("John") }).size()

Signature: Boolean Property.any(T object)

Checks if any element in the list is equal to the given object, i.e. checks if the list contains the given element. Note that the passed object must match with the Type of the Property at hand. For instance, when calling any(...) on a Text Property, the passed value must be of type String. This method will always return false if the Property is unassigned. If the list is empty, this method also returns false.

The method contains(object: T): boolean is an alias for any(object: T): boolean and has exactly the same semantics.

Parameters:

• object — The object to look for in the property values list.

Returns:true if the property values contains the given object, otherwise false. Always false if unassigned.

Example:

// checks if any of the names in the maintainers property is "John Doe"
def johnDoeIsMaintainer = asset.props.maintainers.any("John Doe")

Signature: Boolean Property.anyHaving(Predicate predicate)

Evaluates the given predicate on every entry of the list at hand, and returns true if the predicate evaluated to true for at least one of the entries, or false otherwise. Please note that this method will always return false if the Property is unassigned. Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if anyHaving(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc. This method will always return false if the Property is unassigned. If the list is empty, this method also returns false.

Parameters:

• predicate — The predicate to filter by. If any input value causes the predicate to return true, then anyHaving will also return true.

Returns:true if any value within the property values matches the given predicate, otherwise false. Always false if unassigned.

Example:

// checks if any of the names in the maintainers property starts with "John"
def johnIsMaintainer = asset.props.maintainers.anyHaving({ it.startsWith("John") })

Signature: Boolean Property.all(T object)

Checks if all elements in the list at hand are equal to the given one, i.e. checks if the list contains only the given element (possibly multiple times). Note that the passed object must match with the Type of the Property at hand. For instance, when calling all(...) on a Text Property, the passed value must be of type String. This method will always return true if the Property is unassigned. If the list is empty, this method also returns true.

Parameters:

• object — The object to look for in the property values list.

Returns:true if all property values are equal to the given object, otherwise false. Always true if unassigned.

Example:

// checks if all Server assets on which we run have their status set to "online"
def allServersOnline = asset.links.out.runsOn.Server.props.status.all("online")

Signature: Boolean Property.allHaving(Predicate predicate)

Evaluates the given predicate on all entries of the list at hand, and returns true if the predicate evaluated to true for all entries, or false otherwise. Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if allHaving(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc. This method will always return true if the Property is unassigned. If the list is empty, this method also returns true.

Parameters:

• predicate — The predicate to filter by. If all input values causes the predicate to return true, then anyHaving will also return true.

Returns:true if all values within the property values matches the given predicate, otherwise false. Always true if unassigned.

Example:

// checks if all Server assets on which we run have their status set to something other than "offline"
def noServersOffline = asset.links.out.runsOn.Server.props.status.allHaving({ it.equals("offline") == false })

Signature: Boolean Property.allHaving(int amount, T object)

Checks if at least amount entries in the list at hand are equal to the given object and returns true if this is the case, otherwise returns false. In other words, this method checks if the list contains the given object at least amount times.  Note that the passed object must match with the Type of the Property at hand. For instance, when calling atLeast(...) on a Text Property, the passed value must be of type String. This method will return false if the Property is unassigned or empty (unless amount is in addition set to zero, in which case it will return true).

Parameters:

• amount — The number of elements in the property value which must be equal to the given object in order for the check to succeed.
• object — The element to look for in the property values list.

Returns:true if at least amount elements in the property value are equal to the given object, otherwise false.

Example:

// checks if at least 2 Server assets on which we run have their status set to "online"
def atLeast2ServersOnline = asset.links.out.runsOn.Server.props.status.atLeast(2, "online")

Signature: Boolean Property.allHaving(double percent, T object)

Checks if at least percent percent of all entries in the list are equal to the given object and returns true if this is the case, or false otherwise. The percentage is given as a floating point number in a range between 0 (0%) and 1 (100%).  Note that the passed object must match with the Type of the Property at hand. For instance, when calling atLeast(...) on a Text Property, the passed value must be of type String. This method will return false if the Property is unassigned or empty.

Parameters:

• percent — The fraction of elements in the property value which must be equal to the given object in order for the check to succeed.
• object — The element to look for in the property values list.

Returns:true if at least percent % of elements in the property value are equal to the given object, otherwise false.

Example:

// checks if at least 50% of all Server assets on which we run have their status set to "online"
def atLeastHalfTheServersAreOnline = asset.links.out.runsOn.Server.props.status.atLeast(0.5, "online")

Signature: Boolean Property.allHaving(int amount, Predicate predicate)

Evaluates the given predicate on all entries of the list at hand, and returns true if the predicate evaluated to true for at least amount entries, or false otherwise. Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if atLeastHaving(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc. This method will return false if the Property is unassigned or empty (unless amount is in addition set to zero, in which case it will return true).

Parameters:

• amount — The number of elements in the property value which must match the given predicate in order for the check to succeed.
• predicate — The predicate to apply.

Returns:true if at least amount elements in the property value match the given predicate, otherwise false.

Example:

// checks if at least 2 Server assets on which we run have their status set to something other than "offline"
def atLeast2ServersNotOffline = asset.links.out.runsOn.Server.props.status.atLeastHaving(2, { it.equals("offline") == false })

Signature: Boolean Property.allHaving(double percent, Predicate predicate)

Evaluates the given predicate on all entries of the list at hand, and returns true if the predicate evaluated to true for at least percent percent of all entities, or false otherwise. The percentage is given as a floating point number in a range between 0 (0%) and 1 (100%). Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if atLeastHaving(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc. This method will return false if the Property is unassigned or empty.

Parameters:

• percent — The fraction of elements in the property value which must match the given predicate in order for the check to succeed.
• predicate — The predicate to apply.

Returns:true if at least percent % of elements in the property value match the given predicate, otherwise false.

Example:

// checks if at least 50% of all Server assets on which we run have their status set to something other than "offline"
def atLeastHalfTheServersNotOffline = asset.links.out.runsOn.Server.props.status.atLeastHaving(0.5, { it.equals("offline") == false })

Signature: Boolean Property.allHaving(int amount, T object)

Checks if at most amount entries in the list at hand are equal to the given object and returns true if this is the case, otherwise returns false. In other words, this method checks if the list contains the given object at most amount times. Note that the passed object must match with the Type of the Property at hand. For instance, when calling atMost(...) on a Text Property, the passed value must be of type String. This method will return true if the Property is unassigned or empty (unless amount is in addition set to zero, in which case it will return false).

Parameters:

• amount — The number of elements in the property value which must be equal to the given object in order for the check to succeed.
• object — The object to look for in the property values list.

Returns:true if at most amount elements in the property value are equal to the given object, otherwise false.

Example:

// checks if at most 2 Server assets on which we run have their status set to "offline"
def atMost2ServersNotOnline = asset.links.out.runsOn.Server.props.status.atMost(2, "offline")

Signature: Boolean Property.allHaving(double percentage, T object)

Checks if at most percent percent of all entries in the list are equal to the given object and returns true if this is thie case, otherwise returns false. The percentage is given as a floating point number in a range between 0 (0%) and 1 (100%). Note that the passed object must match with the Type of the Property at hand. For instance, when calling atMost(...) on a Text Property, the passed value must be of type String. This method will return false if the Property is unassigned or empty.

Parameters:

• percentage — The fraction of elements in the property value which may be equal to the given object in order for the check to succeed.
• object — The object to look for in the property values list.

Returns:true if at most percentage % of elements in the property value are equal to the given object, otherwise false.

Example:

// checks if at most 50% of the Server assets on which we run have their status set to "offline"
def atMostHalfTheServersOffline = asset.links.out.runsOn.Server.props.status.atMost(0.5, "offline")

Signature: Boolean Property.allHaving(int amout, Predicate predicate)

Checks if at most percent percent of all entries in the list are equal to the given object and returns true if this is thie case, otherwise returns false. The percentage is given as a floating point number in a range between 0 (0%) and 1 (100%). Note that the passed object must match with the Type of the Property at hand. For instance, when calling atMost(...) on a Text Property, the passed value must be of type String. This method will return false if the Property is unassigned or empty.

Parameters:

• amount — The number of elements in the property value which may be equal to the given object in order for the check to succeed.
• predicate — The predicate to apply.

Returns:true if at most amount elements in the property value match the given predicate, otherwise false.

Example:

// checks if at most 2 Server assets on which we run have their status set to something other than "online"
def atMost2ServersNotOnline = asset.links.out.runsOn.Server.props.status.atMostHaving(2, { it.equals("online") == false })

Signature: Boolean Property.allHaving(double percentage, Predicate predicate)

Evaluates the given predicate on all entries of the list at hand, and returns true if the predicate evaluated to true for at most percent percent of all entries, or false otherwise. The percentage is given as a floating point number in a range between 0 (0%) and 1 (100%). Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if atMostHaving(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc.  This method will return false if the Property is unassigned or empty.

Parameters:

• percentage — The fraction of elements in the property value which may be equal to the given object in order for the check to succeed.
• predicate — The predicate to apply.

Returns:true if at most percentage % of elements in the property value match the given predicate, otherwise false.

Example:

// checks if at most 50% of the Server assets on which we run have their status set to something other than "online"
def atMostHalfTheServersNotOnline = asset.links.out.runsOn.Server.props.status.atMostHaving(0.5, { it.equals("online") == false })

Signature: Boolean Property.allHaving(int amount, T object)

Checks if exactly amount elements in the list at hand are equal to the given object. In other words, checks if the list at hand contains the given object exactly amount times. Note that the passed object must match with the Type of the Property at hand. For instance, when calling exactly(...) on a Text Property, the passed value must be of type String. This method returns false if the Property is unassigned or empty (unless amount is in addition set to zero, in which case it will return true).

Parameters:

• amount — The number of elements in the property value which must be equal to the given object in order for the check to succeed.
• object — The object to check if it is contained in the property values list.

Returns:true if exaclty amount elements in the property value are equal to the given object, otherwise false.

Example:

// checks if exactly 1 of the databases we depend on has its active flag set to true
def exactlyOneDatabaseActive = asset.links.out.database.props.active.exactly(1, true)

Signature: Boolean Property.allHaving(double percentage, T object)

Checks if exactly percent percent of all entries in the list are equal to the given object and returns true if this is thie case, otherwise returns false. The percentage is given as a floating point number in a range between 0 (0%) and 1 (100%). Note that the passed object must match with the Type of the Property at hand. For instance, when calling atMost(...) on a Text Property, the passed value must be of type String. This method will return false if the Property is unassigned or empty.

Parameters:

• percentage — The fraction of elements in the property value which must be equal to the given object in order for the check to succeed.
• object — The object to check if it is contained in the property values list.

Returns:true if exaclty amount elements in the property value are equal to the given object, otherwise false.

Example:

// checks if exactly 50% of the databases on which we depend have their status set to "online"
def exactlyHalfTheDatabasesAreOnline = asset.links.out.database.props.status.exactly(0.5, "online")

Signature: Boolean Property.allHaving(int amount, Predicate predicate)

Evaluates the given predicate on all entries of the list at hand, and returns true if the predicate evaluated to true for exactly amount entries, or false otherwise. Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if exactlyHaving(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc.  This method will return false if the Property is unassigned or empty (unless amount is in addition set to zero, in which case this method will return true).

Parameters:

• amount — The number of elements in the property value which must match the given predicate in order for the check to succeed.
• predicate — The object to check if it is contained in the property values list.

Returns:true if exaclty amount elements in the property value match the given predicate, otherwise false.

Example:

// checks if the names in the contacts Property have at least one entry containing the text "John"
def exactlyHaving = asset.props.contacts.exactlyHaving(1, { it.contains("John") })

Signature: Boolean Property.allHaving(double percentage, Predicate predicate)

Evaluates the given predicate on all entries of the list at hand, and returns true if the predicate evaluated to true for exactly percent percent of all entries, or false otherwise. The percentage is given as a floating point number in a range between 0 (0%) and 1 (100%). Predicates are formulated in Groovy by using curly braces { }. Inside the curly braces, use the keyword it to reference the current value. Please note that it will always be of the same type as the Property. For instance, if exactlyHaving(...) is called on a Text Property, it will be of type String. If the Property is of type Number, it will be of type double, etc.  This method will return false if the Property is unassigned or empty.

Parameters:

• percentage — The fraction of elements in the property value which must match the given predicate in order for the check to succeed.
• predicate — The object to check if it is contained in the property values list.

Returns:true if exaclty percentage % of elements in the property value match the given predicate, otherwise false.

Example:

// checks if exactly 50% of the databases we depend on are online
def exactlyHalfOfAllDatabasesAreOnline = asset.links.out.databases.props.status.exactlyHaving(0.5, { it.equals("online") })

Signature: NumberProperty NumberProperty.avg()

Returns the average of all values as a multiplicity-one Number Property. Any null values in the list are skipped for this calculation. Please note that the returned Property will be unassigned if this Property is unassigned or contains no non-null entries.

Returns: Returns the average of all numbers within this property value, as a numeric property.

Example:

// returns the average cost of all servers on which our asset runs (skipping null values), or zero if unspecified.
def averageCostOfServers = asset.links.out.runsOn.props.cost.avg().value(0)

Signature: NumberProperty NumberProperty.avg(double defaultForNull)

Returns the average of all values as a multiplicity-one Number Property. Any null values in the list will be replaced with defaultForNull for this calculation only. Please note that the returned Property will be unassigned if this Property is unassigned.

Parameters:

• defaultForNull — The default value to use in the average calculation instead of null values.

Returns: Returns the average of all numbers within this property value, as a numeric property.

Example:

// returns the average cost of all servers on which our asset runs (treating null values as zero), or 100 if unspecified.
def averageCostOfServers = asset.links.out.runsOn.props.cost.avg(0).value(100)

Signature: NumberProperty NumberProperty.sum()

Returns the sum of all values as a multiplicity-one Number Propertry. Any null values in this list are skipped for this calculation. Please note that the returned Property will be unassigned if this Property is unassigned or contains no non-null entries.

Returns: Returns the sum of all numbers within this property value, as a numeric property.

Example:

// returns the total cost of all servers on which our asset runs (skipping null values), or zero if unspecified.
def totalCostOfServers = asset.links.out.runsOn.props.cost.sum().value(0)

Signature: NumberProperty NumberProperty.sum(double defaultForNull)

Returns the sum of all values as a multiplicity-one Number Property. Any null values in the list will be replaced with defaultForNull for this calculation only. Please note that the returned Property will be unassigend if this Property is unassigned.

Parameters:

• defaultForNull — The default value to use during sum calculation instead of null values.

Returns: Returns the sum of all numbers within this property value, as a numeric property.

Example:

// returns the total cost of all servers on which our asset runs (treating null values as 1), or 100 if unspecified.
def totalCostOfServers = asset.links.out.runsOn.props.cost.sum(1).value(100)

Signature: NumberProperty NumberProperty.max()

Returns the maximum of all values in this list as a mulitplicity-one Number Property. Please note that the returned Property will be unassigned if this Property is unassigned or contains no non-null entries.

Returns: Returns the maximum of all numbers within this property value, as a numeric property.

Example:

// returns the maximum cost of all servers on which our asset runs, or 0 if unspecified.
def highestServerCost = asset.links.out.runsOn.props.cost.max().value(0)

Signature: NumberProperty NumberProperty.min()

Returns the minimum of all values in this list as a multiplicity-one Number Property. Please note that the returned Property will be unassigned if this Property is unassigned or contains no non-null entries.

Returns: Returns the minimum of all numbers within this property value, as a numeric property.

Example:

// returns the minimum cost of all servers on which our asset runs, or 0 if unspecified.
def lowestServerCost = asset.links.out.runsOn.props.cost.min().value(0)

Signature: Boolean BooleanProperty.or(boolean defaultValue)

Applies an or operation to all booleans in the list, returning the result. If the list is empty or unassigned, the given defaultValue will be used.

For instance, if the list at hand consists of [true, false, true], then the or operation resolves to ((true or false) or true) which is (true or true) which finally results in true.

Parameters:

• defaultValue — The default value to use instead of null values.

Returns:true if at least one property value is true, otherwise false.

Example:

// checks if any of the servers our asset runs on is active (returning false if the list is empty)
def anyServerActive = asset.links.out.runsOn.props.active.or(false)

Signature: Boolean BooleanProperty.and(boolean defaultValue)

Applies an and operation to all booleans in the list, returning the result. If the list is empty or unassigned, the given defaultValue will be used.

For instance, if the list at hand consists of [true, false, true], then the and operation resolves to ((true and false) and true) which is (false and true) which finally results in false.

Parameters:

• defaultValue — The default value to use instead of null values.

Returns:false if at least one property value is false, otherwise true.

Example:

// checks if all of our servers are active (returning false if the list is empty)
def allServersActive = asset.links.out.runsOn.props.active.and(false)

Signature: Boolean BooleanProperty.xor(boolean defaultValue)

Applies an xor operation to all booleans in the list, returning the result. If the list is empty or unassigned, the given defaultValue will be used.

For instance, if the list at hand consists  [true, false, true], then the xor operation resolves to ((true xor false) xor true) which is (true xor true) which finally results in false.

Parameters:

• defaultValue — The default value to use instead of null values.

Returns:true if the number of true property values is odd, otherwise false.

Example:

// checks if exactly one of our servers is active (returning false if the list is empty)
def exactlyOneServerActive = asset.links.out.runsOn.props.active.xor(false)