com.appiancorp.suiteapi.process.analytics2

Class DrillPath

java.lang.Object

com.appiancorp.suiteapi.process.analytics2.DrillPath

All Implemented Interfaces:

DeepCloneable, java.io.Serializable, java.lang.Cloneable

public class DrillPath
extends java.lang.Object
implements java.io.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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	LINK_TYPE_COMMUNITY A constant indicating that this DrillPath links to a Community.
static int	LINK_TYPE_CONTENT A constant indicating that this DrillPath links to Content.
static int	LINK_TYPE_DASHBOARD_PAGE A constant indicating that this DrillPath links to a Dashboard.
static int	LINK_TYPE_DISCUSSION_THREAD A constant indicating that this DrillPath links to a DiscussionThread.
static int	LINK_TYPE_DOCUMENT A constant indicating that this DrillPath links to a Document.
static int	LINK_TYPE_FOLDER A constant indicating that this DrillPath links to a Folder.
static int	LINK_TYPE_FORUM A constant indicating that this DrillPath links to a Forum.
static int	LINK_TYPE_GROUP A constant indicating that this DrillPath links to a Group.
static int	LINK_TYPE_KNOWLEDGE_CENTER A constant indicating that this DrillPath links to a KnowledgeCenter.
static int	LINK_TYPE_MESSAGE A constant indicating that this DrillPath links to a Message.
static int	LINK_TYPE_PEOPLE A constant indicating that this DrillPath links to TypedVariableUtils.People.
static int	LINK_TYPE_PORTAL_PAGE A constant indicating that this DrillPath links to a PortalPage.
static int	LINK_TYPE_PROCESS_DASHBOARD A constant indicating that this DrillPath links to a Process Dashboard.
static int	LINK_TYPE_PROCESS_DETAILS A constant indicating that this DrillPath links to Process Details.
static int	LINK_TYPE_PROCESS_MODEL_DASHBOARD A constant indicating that this DrillPath links to a Process Model Dashboard.
static int	LINK_TYPE_PROCESS_MODEL_DETAILS A constant indicating that this DrillPath links to ProcessModel Details.
static int	LINK_TYPE_REPORT A constant indicating that this DrillPath links to a Report.
static int	LINK_TYPE_TASK A constant indicating that this DrillPathlinks to a Task.
static int	LINK_TYPE_URL A constant indicating that this DrillPath links to an external URL.
static int	LINK_TYPE_USER A constant indicating that this DrillPath links to a User.
protected static Logger	LOG

Constructor Summary

Constructors

Constructor and Description
DrillPath()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone this object.
boolean	equals(java.lang.Object obj_) Is this DrillPath equal to the given object?
java.lang.Long	getDashboardId() Gets the ID of the dashboard to which this DrillPath links.
boolean	getEnabled() Gets whether or not this DrillPath is enabled.
java.lang.String	getExpression() Gets the expression which defines the value of the DrillPath.
java.lang.Integer	getLinkType() Gets the type of link that this DrillPath represents.
java.lang.Long	getOtherReportColumnLocalId() Gets the localId of the Column by which the destination report will be filtered.
java.lang.Long	getOtherReportId() Gets the ID of the report to which this DrillPath links.
int	hashCode()
void	setDashboardId(java.lang.Long dashboardId_) Sets the ID of the dashboard to which this DrillPath links.
void	setEnabled(boolean enabled_) Sets whether or not this DrillPath is enabled.
void	setExpression(java.lang.String expression_) Sets the expression which defines the value of the DrillPath.
void	setLinkType(java.lang.Integer linkType_) Sets the type of link that this DrillPath represents.
void	setOtherReportColumnLocalId(java.lang.Long otherReportColumnLocalId_) Sets the localId of the Column by which the destination report will be filtered.
void	setOtherReportId(java.lang.Long otherReportId_) Sets the ID of the report to which this DrillPath will link.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final Logger LOG

LINK_TYPE_PROCESS_MODEL_DETAILS

public static final int LINK_TYPE_PROCESS_MODEL_DETAILS

A constant indicating that this DrillPath links to ProcessModel Details.

See Also:

Constant Field Values

LINK_TYPE_PROCESS_DETAILS

public static final int LINK_TYPE_PROCESS_DETAILS

A constant indicating that this DrillPath links to Process Details.

See Also:

Constant Field Values

LINK_TYPE_TASK

public static final int LINK_TYPE_TASK

A constant indicating that this DrillPathlinks to a Task.

See Also:

Constant Field Values

LINK_TYPE_REPORT

public static final int LINK_TYPE_REPORT

A constant indicating that this DrillPath links to a Report.

See Also:

Constant Field Values

LINK_TYPE_DASHBOARD_PAGE

public static final int LINK_TYPE_DASHBOARD_PAGE

A constant indicating that this DrillPath links to a Dashboard.

See Also:

Constant Field Values

LINK_TYPE_URL

public static final int LINK_TYPE_URL

A constant indicating that this DrillPath links to an external URL.

See Also:

Constant Field Values

LINK_TYPE_PROCESS_MODEL_DASHBOARD

public static final int LINK_TYPE_PROCESS_MODEL_DASHBOARD

A constant indicating that this DrillPath links to a Process Model Dashboard.

See Also:

Constant Field Values

LINK_TYPE_PROCESS_DASHBOARD

public static final int LINK_TYPE_PROCESS_DASHBOARD

A constant indicating that this DrillPath links to a Process Dashboard.

See Also:

Constant Field Values

LINK_TYPE_USER

public static final int LINK_TYPE_USER

A constant indicating that this DrillPath links to a User.

See Also:

Constant Field Values

LINK_TYPE_GROUP

public static final int LINK_TYPE_GROUP

A constant indicating that this DrillPath links to a Group.

See Also:

Constant Field Values

LINK_TYPE_FORUM

public static final int LINK_TYPE_FORUM

A constant indicating that this DrillPath links to a Forum.

See Also:

Constant Field Values

LINK_TYPE_DISCUSSION_THREAD

public static final int LINK_TYPE_DISCUSSION_THREAD

A constant indicating that this DrillPath links to a DiscussionThread.

See Also:

Constant Field Values

LINK_TYPE_MESSAGE

public static final int LINK_TYPE_MESSAGE

A constant indicating that this DrillPath links to a Message.

See Also:

Constant Field Values

LINK_TYPE_DOCUMENT

public static final int LINK_TYPE_DOCUMENT

A constant indicating that this DrillPath links to a Document.

See Also:

Constant Field Values

LINK_TYPE_COMMUNITY

public static final int LINK_TYPE_COMMUNITY

A constant indicating that this DrillPath links to a Community.

See Also:

Constant Field Values

LINK_TYPE_KNOWLEDGE_CENTER

public static final int LINK_TYPE_KNOWLEDGE_CENTER

A constant indicating that this DrillPath links to a KnowledgeCenter.

See Also:

Constant Field Values

LINK_TYPE_FOLDER

public static final int LINK_TYPE_FOLDER

A constant indicating that this DrillPath links to a Folder.

See Also:

Constant Field Values

LINK_TYPE_CONTENT

public static final int LINK_TYPE_CONTENT

A constant indicating that this DrillPath links to Content.

See Also:

Constant Field Values

LINK_TYPE_PEOPLE

public static final int LINK_TYPE_PEOPLE

A constant indicating that this DrillPath links to TypedVariableUtils.People.

See Also:

Constant Field Values

LINK_TYPE_PORTAL_PAGE

public static final int LINK_TYPE_PORTAL_PAGE

A constant indicating that this DrillPath links to a PortalPage.

See Also:

Constant Field Values

Constructor Detail

DrillPath

public DrillPath()

Method Detail

equals

public boolean equals(java.lang.Object obj_)

Is this DrillPath equal to the given object?

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.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 java.lang.Object

Returns:

getDashboardId

public java.lang.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(java.lang.Long)

setDashboardId

public void setDashboardId(java.lang.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:

getDashboardId(), getDashboardId()

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(boolean)

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:

getEnabled()

getLinkType

public java.lang.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(java.lang.Integer)

setLinkType

public void setLinkType(java.lang.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:

getLinkType()

getOtherReportId

public java.lang.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(java.lang.Long)

setOtherReportId

public void setOtherReportId(java.lang.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:

getOtherReportId(), getOtherReportId()

getExpression

public java.lang.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(java.lang.String)

setExpression

public void setExpression(java.lang.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:

getExpression(), getExpression()

getOtherReportColumnLocalId

public java.lang.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(java.lang.Long)

setOtherReportColumnLocalId

public void setOtherReportColumnLocalId(java.lang.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:

getOtherReportColumnLocalId()