Package step.repository.alm.otaclient

Interface IGraph

  • All Superinterfaces:
    com4j.Com4jObject
    public interface IGraph
extends com4j.Com4jObject
    Represents a graph built through a method.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int colCount()
      The number of columns.
      String colName​(int col)
      Gets the name of the specified column.
      int colTotal​(int col)
      The sum of the values in the specified graph data column.
      short colType​(int col)
      For HP use.
      IList crossDrillDown​(Object areas)
      Cross project graph data drill-down.
      int data​(int col, int row)
      The data in the specified cell.
      IList drillDown​(Object pAreas, Object mAreas)
      Drills down to graph data.
      int graphTotal()
      The total number of items represented in the graph.
      int maxValue()
      The maximum value in the graph.
      IList multiDrillDown​(Object areas)
      Gets detailed information about a graph area consisting of four sets of coordinates.
      int rowCount()
      The number of rows.
      String rowName​(int row)
      Gets the row name of the specified row.
      int rowTotal​(int row)
      The sum of the values in the specified graph data row.
      Date startDate()
      The start date for the graph.
      IList warnings()
      Returns a list of warnings returned for this graph by the server.
      Object warnings​(int index)  

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • colName

        String colName​(int col)

        Gets the name of the specified column. Column numbers are zero-based.

        Getter method for the COM property "ColName"

        Parameters:
        col - Mandatory int parameter.
        Returns:
        Returns a value of type java.lang.String

      • rowName

        String rowName​(int row)

        Gets the row name of the specified row. Row numbers are zero-based.

        Getter method for the COM property "RowName"

        Parameters:
        row - Mandatory int parameter.
        Returns:
        Returns a value of type java.lang.String

      • colType

        short colType​(int col)

        For HP use. The column type.

        Getter method for the COM property "ColType"

        Parameters:
        col - Mandatory int parameter.
        Returns:
        Returns a value of type short

      • data

        int data​(int col,
         int row)

        The data in the specified cell. Column and Row numbers are zero-based.

        Getter method for the COM property "Data"

        Parameters:
        col - Mandatory int parameter.
        row - Mandatory int parameter.
        Returns:
        Returns a value of type int

      • colCount

        int colCount()

        The number of columns.

        Getter method for the COM property "ColCount"

        Returns:
        Returns a value of type int

      • rowCount

        int rowCount()

        The number of rows.

        Getter method for the COM property "RowCount"

        Returns:
        Returns a value of type int

      • drillDown

        IList drillDown​(Object pAreas,
                Object mAreas)

        Drills down to graph data.

        Parameters:
        pAreas - Mandatory java.lang.Object parameter.
        mAreas - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type otaclient.IList

      • maxValue

        int maxValue()

        The maximum value in the graph.

        Getter method for the COM property "MaxValue"

        Returns:
        Returns a value of type int

      • graphTotal

        int graphTotal()

        The total number of items represented in the graph.

        Getter method for the COM property "GraphTotal"

        Returns:
        Returns a value of type int

      • rowTotal

        int rowTotal​(int row)

        The sum of the values in the specified graph data row. The row number is zero-based.

        Getter method for the COM property "RowTotal"

        Parameters:
        row - Mandatory int parameter.
        Returns:
        Returns a value of type int

      • colTotal

        int colTotal​(int col)

        The sum of the values in the specified graph data column. The column number is zero-based.

        Getter method for the COM property "ColTotal"

        Parameters:
        col - Mandatory int parameter.
        Returns:
        Returns a value of type int

      • multiDrillDown

        IList multiDrillDown​(Object areas)

        Gets detailed information about a graph area consisting of four sets of coordinates.

        Parameters:
        areas - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type otaclient.IList

      • startDate

        Date startDate()

        The start date for the graph.

        Getter method for the COM property "StartDate"

        Returns:
        Returns a value of type java.util.Date

      • warnings

        IList warnings()

        Returns a list of warnings returned for this graph by the server.

        Getter method for the COM property "Warnings"

        Returns:
        Returns a value of type otaclient.IList

      • warnings

        Object warnings​(int index)

      • crossDrillDown

        IList crossDrillDown​(Object areas)

        Cross project graph data drill-down. Returns a list of lists, each containing the ID of the source project and the IDs of the entities relevant to the drill-down area.

        Parameters:
        areas - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type otaclient.IList