public interface

WebHyperLinkAnswer

com.microstrategy.web.objects.WebHyperLinkAnswer

Class Overview

The WebHyperLinkAnswer interface represents a target prompt's answer This interface is only applicable for executable Hyperlink.

Summary

Public Methods
abstract int getAnswerMode()
Returns answer mode
abstract List getDynamicUnits()
Calculates a list of template and group by units, whose values are needed to answer the target prompt.
abstract List getDynamicUnits(WebReportGrid grid, boolean includeAllValidUnitsForDynamic)
Calculates a list of template and group by units, whose values are needed to answer the target prompt.
abstract List getDynamicUnits(WebReportGrid grid)
Calculates a list of template and group by units, whose values are needed to answer the target prompt.
abstract String getFormID()
It's only for a constant prompt, it will return a form id; for other prompt types, return null; Typically, a form id and an attribute id are grouped to uniquely determine a form.
abstract String getPromptId()
Returns target prompt ID
abstract String getPromptOriginId()
Returns target prompt origin ID.
abstract int getPromptOriginType()
Returns target prompt origin type.
abstract int getPromptType()
Returns target prompt type.
abstract Object getStaticAnswer()
Returns the static answer if the AnswerMode == STATIC.
abstract void setAnswerMode(int am)
Set the answer mode
abstract void setFormID(String formID)
Set form id for a dynamically answered constant prompt.
abstract void setPrompt(String id, int pt)
Set the target prompt for this answer.
abstract void setPromptOrigin(String id, int type)
Set target prompt origin.

Public Methods

public abstract int getAnswerMode ()

Returns answer mode

Returns

public abstract List getDynamicUnits ()

Calculates a list of template and group by units, whose values are needed to answer the target prompt. This list is calculated based on the current user selections and the current template unit position within the grid template.

Returns
  • a List representing the Dynamic Units for the answer.
Throws
WebObjectsException

public abstract List getDynamicUnits (WebReportGrid grid, boolean includeAllValidUnitsForDynamic)

Calculates a list of template and group by units, whose values are needed to answer the target prompt. This list is calculated based on the current user selections and the current template unit position within the grid template.

Parameters
grid The WebReportGrid object where the grid elements will be obtained.
Returns
  • a List representing the Dynamic Units for the answer.
Throws
WebObjectsException

public abstract List getDynamicUnits (WebReportGrid grid)

Calculates a list of template and group by units, whose values are needed to answer the target prompt. This list is calculated based on the current user selections and the current template unit position within the grid template.

Parameters
grid The WebReportGrid object where the grid elements will be obtained.
Returns
  • a List representing the Dynamic Units for the answer.
Throws
WebObjectsException

public abstract String getFormID ()

It's only for a constant prompt, it will return a form id; for other prompt types, return null; Typically, a form id and an attribute id are grouped to uniquely determine a form. Use getPromptOriginId() to get the attribute id.

Returns
  • form id of the constant prompt

public abstract String getPromptId ()

Returns target prompt ID

Returns
  • A String representing the ID of the target prompt.

public abstract String getPromptOriginId ()

Returns target prompt origin ID. The Origin ID is the ID of the source attribute for the target prompt of this answer.

Returns

public abstract int getPromptOriginType ()

Returns target prompt origin type. The Origin type is the type of the source attribute for the target prompt of this answer. This will be a value from EnumDSSXMLObjectTypes.

Returns

public abstract int getPromptType ()

Returns target prompt type.

Returns

public abstract Object getStaticAnswer ()

Returns the static answer if the AnswerMode == STATIC. Otherwise it returns null. The returned object type depends on the prompt type. For example, for element prompts it will be a WebElements object.

Returns
  • a Object representing the static answer

public abstract void setAnswerMode (int am)

Set the answer mode

Parameters
am An int from EnumLinkAnswerMode representing the answer mode.

public abstract void setFormID (String formID)

Set form id for a dynamically answered constant prompt.

public abstract void setPrompt (String id, int pt)

Set the target prompt for this answer.

Parameters
id A String representing the ID of the target prompt.
pt A int representing the type of the target prompt, the type refers to EnumDSSXMLPromptType

public abstract void setPromptOrigin (String id, int type)

Set target prompt origin. The origin is the source attribute for the target prompt of this answer

Parameters
id The ID of the source attribute for the target prompt of this answer.
type The type of the source attribute for the target prompt of this answer. This will be a value from EnumDSSXMLObjectTypes.