Class UtilityNamedTraceConfiguration

    • Method Detail

      • getCreator

        public String getCreator()
        Gets the creator of the named trace configuration.

        The creator will be the active portal user when the named trace configuration was created.

        Returns:
        the creator of the named trace configuration
        Since:
        100.11.0
      • getDescription

        public String getDescription()
        Gets the description of the named trace configuration.
        Returns:
        the description of the named trace configuration
        Since:
        100.11.0
      • getGlobalId

        public UUID getGlobalId()
        Gets the global ID of the named trace configuration.
        Returns:
        the global ID of the named trace configuration
        Since:
        100.11.0
      • getMinimumStartingLocations

        public UtilityMinimumStartingLocations getMinimumStartingLocations()
        Gets the minimum number of starting locations required for this trace type (e.g. shortest path trace requires 2).
        Returns:
        the minimum number of starting locations required for this trace type (e.g. shortest path trace requires 2).
        Since:
        100.11.0
        See Also:
        UtilityMinimumStartingLocations
      • getName

        public String getName()
        Gets the name of the named trace configuration.
        Returns:
        the name of the named trace configuration
        Since:
        100.11.0
      • getResultTypes

        public List<UtilityTraceResult.Type> getResultTypes()
        Gets the result types returned by this named trace configuration.
        Returns:
        an immutable list of result types returned by this named trace configuration
        Since:
        100.11.0
        See Also:
        UtilityTraceResult.Type
      • getTags

        public List<String> getTags()
        Gets the user tags of the named trace configuration.
        Returns:
        an immutable list of user tags of the named trace configuration
        Since:
        100.11.0
      • getTraceConfiguration

        @Deprecated
        public UtilityTraceConfiguration getTraceConfiguration()
        Deprecated.
        100.12.0. Use getDefaultTraceConfiguration() method instead to return a copy of the UtilityTraceConfiguration defined for this UtilityNamedTraceConfiguration.
        Gets the UtilityTraceConfiguration of the UtilityNamedTraceConfiguration.

        This UtilityTraceConfiguration defines the UtilityNamedTraceConfiguration and cannot be modified. Any change on this object will be discarded.

        Returns:
        the UtilityTraceConfiguration of the UtilityNamedTraceConfiguration
        Since:
        100.11.0
      • getDefaultTraceConfiguration

        public UtilityTraceConfiguration getDefaultTraceConfiguration()
        Gets a copy of the UtilityTraceConfiguration for this UtilityNamedTraceConfiguration, if one is defined.
        Returns:
        a copy of the UtilityTraceConfiguration defined for this UtilityNamedTraceConfiguration
        Since:
        100.12.0