Package com.appiancorp.suiteapi.process.analytics2

Class DrillPath

java.lang.Object
com.appiancorp.suiteapi.process.analytics2.DrillPath
All Implemented Interfaces:
DeepCloneable, Serializable, Cloneable
public class DrillPath extends Object implements Serializable, DeepCloneable

The DrillPath bean describes how data in a report Column links to more information.

The type of the link is given in the linkType field. The type can be any one of the LINK_TYPE_XXX constants found in this class.

Based on the linkType, the expression field specifies a value which defines the specific object to link to. For example, if the linkType is LINK_TYPE_TASK, then the expression field will determine the Id of the Task to link to. There are two exceptions to this rule. If the type is LINK_TYPE_REPORT, then the otherReportId field is used to link to another report, the otherReportColumnLocalId specifies a Column which can be used to filter the destination report based on a filter value, which is stored in the expression field. If the type is LINK_TYPE_DASHBOARD_PAGE, then the dashboardId field is used and the expression is ignored.

See Also:

  • Field Details

    • LOG

      protected static final org.apache.log4j.Logger LOG

    • LINK_TYPE_DASHBOARD_PAGE

      public static final int LINK_TYPE_DASHBOARD_PAGE
      A constant indicating that this DrillPath links to a Dashboard.
      See Also:

    • LINK_TYPE_CONTENT

      public static final int LINK_TYPE_CONTENT
      A constant indicating that this DrillPath links to Content.
      See Also:

    • LINK_TYPE_PORTAL_PAGE

      public static final int LINK_TYPE_PORTAL_PAGE
      A constant indicating that this DrillPath links to a PortalPage.
      See Also:

  • Constructor Details

    • DrillPath

      public DrillPath()

  • Method Details

    • equals

      public boolean equals(Object obj_)
      Is this DrillPath equal to the given object?
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Object clone()
      Clone this object. Note that this will make a deep copy of the value.
      Specified by:
      clone in interface DeepCloneable
      Overrides:
      clone in class Object
      Returns:

    • getDashboardId

      public Long getDashboardId()
      Gets the ID of the dashboard to which this DrillPath links. This only applies for DrillPaths of type LINK_TYPE_DASHBOARD_PAGE.
      Returns:
      The ID of the dashboard to which this DrillPath links.
      See Also:

    • setDashboardId

      public void setDashboardId(Long dashboardId_)
      Sets the ID of the dashboard to which this DrillPath links.
      Parameters:
      dashboardId_ - The ID of the dashboard to which this DrillPath will link.
      See Also:

    • getEnabled

      public boolean getEnabled()
      Gets whether or not this DrillPath is enabled. Enabled DrillPaths are applied when rendering a column for a report; disabled ones are not.
      Returns:
      A value of true if the DrillPath is enabled.
      See Also:

    • setEnabled

      public void setEnabled(boolean enabled_)
      Sets whether or not this DrillPath is enabled.
      Parameters:
      enabled_ - A value of true will enable this DrillPath
      See Also:

    • getLinkType

      public Integer getLinkType()
      Gets the type of link that this DrillPath represents.
      Returns:
      A constant representing the link type. It will be one of the LINK_TYPE_XXX constants found in this class.
      See Also:

    • setLinkType

      public void setLinkType(Integer linkType_)
      Sets the type of link that this DrillPath represents.
      Parameters:
      linkType_ - The link type to be set, which must be one of the LINK_TYPE_XXX constants found in this class.
      See Also:

    • getOtherReportId

      public Long getOtherReportId()
      Gets the ID of the report to which this DrillPath links. It is not the ID of the report to which this DrillPath belongs. This field only applies to DrillPaths of type LINK_TYPE_REPORT.
      Returns:
      The ID of the report to which this DrillPath links.
      See Also:

    • setOtherReportId

      public void setOtherReportId(Long otherReportId_)
      Sets the ID of the report to which this DrillPath will link.
      Parameters:
      otherReportId_ - The ID of the report to which this DrillPath will link.
      See Also:

    • getExpression

      public String getExpression()
      Gets the expression which defines the value of the DrillPath. For example, if this DrillPath links to a Task Details page the expression defines the Task ID.
      Returns:
      The expression defining the value of the DrillPath
      See Also:

    • setExpression

      public void setExpression(String expression_)
      Sets the expression which defines the value of the DrillPath.
      Parameters:
      expression_ - The expression defining the value of the DrillPath to set.
      See Also:

    • getOtherReportColumnLocalId

      public Long getOtherReportColumnLocalId()

      Gets the localId of the Column by which the destination report will be filtered. The filter value will be stored in the DrillPath's expression field.

      This field only applies to DrillPaths of type LINK_TYPE_REPORT.

      Returns:
      The localId of the Column by which the destination report will be filtered.
      See Also:

    • setOtherReportColumnLocalId

      public void setOtherReportColumnLocalId(Long otherReportColumnLocalId_)
      Sets the localId of the Column by which the destination report will be filtered.
      Parameters:
      otherReportColumnLocalId_ - The localId of the Column by which the destination report will be filtered.
      See Also: