Class DrillPath
- All Implemented Interfaces:
DeepCloneable
,Serializable
,Cloneable
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 Summary
Modifier and TypeFieldDescriptionstatic final int
A constant indicating that thisDrillPath
links to aCommunity
.static final int
A constant indicating that thisDrillPath
links to Content.static final int
A constant indicating that thisDrillPath
links to a Dashboard.static final int
A constant indicating that thisDrillPath
links to aDiscussionThread
.static final int
A constant indicating that thisDrillPath
links to aDocument
.static final int
A constant indicating that thisDrillPath
links to aFolder
.static final int
A constant indicating that thisDrillPath
links to aForum
.static final int
A constant indicating that thisDrillPath
links to aGroup
.static final int
A constant indicating that thisDrillPath
links to aKnowledgeCenter
.static final int
A constant indicating that thisDrillPath
links to aMessage
.static final int
A constant indicating that thisDrillPath
links toTypedVariableUtils.People
.static final int
A constant indicating that thisDrillPath
links to aPortalPage
.static final int
A constant indicating that thisDrillPath
links to a Process Dashboard.static final int
A constant indicating that thisDrillPath
links to Process Details.static final int
A constant indicating that thisDrillPath
links to a Process Model Dashboard.static final int
A constant indicating that thisDrillPath
links toProcessModel
Details.static final int
A constant indicating that thisDrillPath
links to a Report.static final int
A constant indicating that thisDrillPath
links to a Task.static final int
A constant indicating that thisDrillPath
links to an external URL.static final int
A constant indicating that thisDrillPath
links to aUser
.protected static final org.apache.log4j.Logger
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone this object.boolean
Is this DrillPath equal to the given object?Gets the ID of the dashboard to which thisDrillPath
links.boolean
Gets whether or not thisDrillPath
is enabled.Gets the expression which defines the value of theDrillPath
.Gets the type of link that thisDrillPath
represents.Gets thelocalId
of theColumn
by which the destination report will be filtered.Gets the ID of the report to which thisDrillPath
links.int
hashCode()
void
setDashboardId
(Long dashboardId_) Sets the ID of the dashboard to which thisDrillPath
links.void
setEnabled
(boolean enabled_) Sets whether or not thisDrillPath
is enabled.void
setExpression
(String expression_) Sets the expression which defines the value of theDrillPath
.void
setLinkType
(Integer linkType_) Sets the type of link that thisDrillPath
represents.void
setOtherReportColumnLocalId
(Long otherReportColumnLocalId_) Sets thelocalId
of theColumn
by which the destination report will be filtered.void
setOtherReportId
(Long otherReportId_) Sets the ID of the report to which thisDrillPath
will link.
-
Field Details
-
LOG
protected static final org.apache.log4j.Logger LOG -
LINK_TYPE_PROCESS_MODEL_DETAILS
public static final int LINK_TYPE_PROCESS_MODEL_DETAILSA constant indicating that thisDrillPath
links toProcessModel
Details.- See Also:
-
LINK_TYPE_PROCESS_DETAILS
public static final int LINK_TYPE_PROCESS_DETAILSA constant indicating that thisDrillPath
links to Process Details.- See Also:
-
LINK_TYPE_TASK
public static final int LINK_TYPE_TASKA constant indicating that thisDrillPath
links to a Task.- See Also:
-
LINK_TYPE_REPORT
public static final int LINK_TYPE_REPORTA constant indicating that thisDrillPath
links to a Report.- See Also:
-
LINK_TYPE_DASHBOARD_PAGE
public static final int LINK_TYPE_DASHBOARD_PAGEA constant indicating that thisDrillPath
links to a Dashboard.- See Also:
-
LINK_TYPE_URL
public static final int LINK_TYPE_URLA constant indicating that thisDrillPath
links to an external URL.- See Also:
-
LINK_TYPE_PROCESS_MODEL_DASHBOARD
public static final int LINK_TYPE_PROCESS_MODEL_DASHBOARDA constant indicating that thisDrillPath
links to a Process Model Dashboard.- See Also:
-
LINK_TYPE_PROCESS_DASHBOARD
public static final int LINK_TYPE_PROCESS_DASHBOARDA constant indicating that thisDrillPath
links to a Process Dashboard.- See Also:
-
LINK_TYPE_USER
public static final int LINK_TYPE_USERA constant indicating that thisDrillPath
links to aUser
.- See Also:
-
LINK_TYPE_GROUP
public static final int LINK_TYPE_GROUPA constant indicating that thisDrillPath
links to aGroup
.- See Also:
-
LINK_TYPE_FORUM
public static final int LINK_TYPE_FORUMA constant indicating that thisDrillPath
links to aForum
.- See Also:
-
LINK_TYPE_DISCUSSION_THREAD
public static final int LINK_TYPE_DISCUSSION_THREADA constant indicating that thisDrillPath
links to aDiscussionThread
.- See Also:
-
LINK_TYPE_MESSAGE
public static final int LINK_TYPE_MESSAGEA constant indicating that thisDrillPath
links to aMessage
.- See Also:
-
LINK_TYPE_DOCUMENT
public static final int LINK_TYPE_DOCUMENTA constant indicating that thisDrillPath
links to aDocument
.- See Also:
-
LINK_TYPE_COMMUNITY
public static final int LINK_TYPE_COMMUNITYA constant indicating that thisDrillPath
links to aCommunity
.- See Also:
-
LINK_TYPE_KNOWLEDGE_CENTER
public static final int LINK_TYPE_KNOWLEDGE_CENTERA constant indicating that thisDrillPath
links to aKnowledgeCenter
.- See Also:
-
LINK_TYPE_FOLDER
public static final int LINK_TYPE_FOLDERA constant indicating that thisDrillPath
links to aFolder
.- See Also:
-
LINK_TYPE_CONTENT
public static final int LINK_TYPE_CONTENTA constant indicating that thisDrillPath
links to Content.- See Also:
-
LINK_TYPE_PEOPLE
public static final int LINK_TYPE_PEOPLEA constant indicating that thisDrillPath
links toTypedVariableUtils.People
.- See Also:
-
LINK_TYPE_PORTAL_PAGE
public static final int LINK_TYPE_PORTAL_PAGEA constant indicating that thisDrillPath
links to aPortalPage
.- See Also:
-
-
Constructor Details
-
DrillPath
public DrillPath()
-
-
Method Details
-
equals
Is this DrillPath equal to the given object? -
hashCode
public int hashCode() -
clone
Clone this object. Note that this will make a deep copy of the value.- Specified by:
clone
in interfaceDeepCloneable
- Overrides:
clone
in classObject
- Returns:
-
getDashboardId
Gets the ID of the dashboard to which thisDrillPath
links. This only applies for DrillPaths of typeLINK_TYPE_DASHBOARD_PAGE
.- Returns:
- The ID of the dashboard to which this
DrillPath
links. - See Also:
-
setDashboardId
Sets the ID of the dashboard to which thisDrillPath
links.- Parameters:
dashboardId_
- The ID of the dashboard to which thisDrillPath
will link.- See Also:
-
getEnabled
public boolean getEnabled()Gets whether or not thisDrillPath
is enabled. EnabledDrillPath
s are applied when rendering a column for a report; disabled ones are not.- Returns:
- A value of
true
if theDrillPath
is enabled. - See Also:
-
setEnabled
public void setEnabled(boolean enabled_) Sets whether or not thisDrillPath
is enabled.- Parameters:
enabled_
- A value oftrue
will enable thisDrillPath
- See Also:
-
getLinkType
Gets the type of link that thisDrillPath
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
Sets the type of link that thisDrillPath
represents.- Parameters:
linkType_
- The link type to be set, which must be one of theLINK_TYPE_XXX
constants found in this class.- See Also:
-
getOtherReportId
Gets the ID of the report to which thisDrillPath
links. It is not the ID of the report to which thisDrillPath
belongs. This field only applies toDrillPath
s of typeLINK_TYPE_REPORT
.- Returns:
- The ID of the report to which this
DrillPath
links. - See Also:
-
setOtherReportId
Sets the ID of the report to which thisDrillPath
will link.- Parameters:
otherReportId_
- The ID of the report to which thisDrillPath
will link.- See Also:
-
getExpression
Gets the expression which defines the value of theDrillPath
. For example, if thisDrillPath
links to a Task Details page the expression defines the Task ID.- Returns:
- The expression defining the value of the
DrillPath
- See Also:
-
setExpression
Sets the expression which defines the value of theDrillPath
.- Parameters:
expression_
- The expression defining the value of theDrillPath
to set.- See Also:
-
getOtherReportColumnLocalId
Gets the
localId
of theColumn
by which the destination report will be filtered. The filter value will be stored in theDrillPath
'sexpression
field.This field only applies to DrillPaths of type LINK_TYPE_REPORT.
- Returns:
- The
localId
of theColumn
by which the destination report will be filtered. - See Also:
-
setOtherReportColumnLocalId
Sets thelocalId
of theColumn
by which the destination report will be filtered.- Parameters:
otherReportColumnLocalId_
- ThelocalId
of theColumn
by which the destination report will be filtered.- See Also:
-