com.sun.n1.sps.model.host
Interface HostSearchCriteria

public interface HostSearchCriteria

A host search criteria specifies dynamic selection criteria for matching hosts. Available criteria includes

• whether the host is physical or virtual,
• the type of app instance contained on the host,
• values of static host attributes like name and description,
• values of machine info attributes like OS name,
• values of dynamic host variables as declared by the hosts associated host type.

  Method Summary

  AppTypeCriteria	getAppTypeCriteria() Returns the app type criteria.
  AttributeCriteriaList	getAttributeCriteriaList() Returns the attribute criteria list.
  PhysicalCriteria	getPhysicalCriteria() Returns the physical criteria.
  boolean	isEmptyCriteria() Returns true if the current state of this criteria cannot match any hosts.
  boolean	matches(HostID hostID) Returns true if this criteria matches the host referenced by the passed ID, false otherwise.

  Method Detail

  matches

  boolean matches(HostID hostID)

  Returns true if this criteria matches the host referenced by the passed ID, false otherwise. If the passed ID is null, or no such host exists for the passed ID, false is returned.

  This method requires host read permission.

  Returns:

  true if-and-only-if this criteria matches the host.

  getAttributeCriteriaList

  AttributeCriteriaList getAttributeCriteriaList()

  Returns the attribute criteria list. The result lists the attribute criteria that are logically AND'd together to specify hosts matching this criteria. By default the empty list is returned.

  Returns:

  The attribute criteria list.

  getPhysicalCriteria

  PhysicalCriteria getPhysicalCriteria()

  Returns the physical criteria. This criteria is used to specify searches on hosts that are either physical or virtual. By default, this criteria is empty.

  Returns:

  The physical criteria.

  getAppTypeCriteria

  AppTypeCriteria getAppTypeCriteria()

  Returns the app type criteria. This criteria is used to specify the types of applications expected to be contained on the hosts matching this criteria. By default, remote agent applications are expected to be contained on the hosts matching this criteria.

  Returns:

  The app type criteria.

  isEmptyCriteria

  boolean isEmptyCriteria()

  Returns true if the current state of this criteria cannot match any hosts. This is the case if the attribute criteria list is empty, no physical criteria options are specified, and no app type options are specified in the app type criteria.

  Returns:

  true if this criteria cannot match any hosts.

  See Also:

  AppTypeCriteria.isEmptyCriteria(), PhysicalCriteria.isEmptyCriteria()