Interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

All Known Implementing Classes:
PersistedCollectionMemberGraphImpl.PersistedCollectionMemberNodeImpl
Enclosing interface:
PersistedCollectionMemberGraph

public static interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode
Graph node representing a single member of a persisted collection.

Supported API: true

Extendable: false
  • Method Details

    • getMemberRef

      ObjectReference getMemberRef()
      Get the member reference of this node.

      Supported API: true
      Returns:
      ObjectReference to PersistedCollectable member.
    • isFilteredOut

      boolean isFilteredOut()
      Return filtered out status.

      Supported API: true
      Returns:
      True if member is filtered out.
    • getFilteredMessage

      String getFilteredMessage()
      Get the filtered message. This is the message displayed in the "Filtered" column of a customized package contents table view.

      Supported API: true
      Returns:
      Filtered message, or null if no message.
    • getMaxLevel

      int getMaxLevel()
      Get the maximum depth level of this node in the graph (seeds are level 1). If member is collected from multiple parents then this value is maximum depth level from all parents.

      Supported API: true
      Returns:
      Maximum depth level (always >= 1).
    • getParentNodes

      Get parents of this member node.

      Supported API: true
      Returns:
      Map of parent nodes to their relationship roles (null if no parent nodes).
    • getChildNodes

      Get children of this member node.

      Supported API: true
      Returns:
      Map of child nodes to their relationship roles (null if no child nodes).
    • isVisited

      boolean isVisited()
      Get the visited state of this member node.

      Supported API: true
      Returns:
      True if the visited state of this node is set.
    • setVisited

      void setVisited()
      Set the visited state of this member node.

      Supported API: true
    • clearVisited

      void clearVisited()
      Clear the visited state of this member node.

      Supported API: true
    • keepInflated

      void keepInflated()
      Prevent iterator methods from deflating the member reference of this node.

      Supported API: true
    • getCustomObject

      Object getCustomObject()
      Get custom object for this member node. Used to associated application specific data with the node.

      Supported API: true
      Returns:
      Custom object (null if none set prior to call).
    • setCustomObject

      Object setCustomObject(Object customObject)
      Set custom object for this member node. Used to associated application specific data with the node.

      Supported API: true
      Parameters:
      customObject - Custom object to set on this node (may be null).
      Returns:
      Old custom object being replaced (null if none set prior to call).