Package com.microstrategy.web.objects
Interface WebHyperLinkAnswer
-
public interface WebHyperLinkAnswer
The WebHyperLinkAnswer interface represents a target prompt's answer This interface is only applicable for executable Hyperlink.- Since:
- MicroStrategy Web 8.1.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getAnswerMode()
Returns answer modeRWGroupByElements
getDynamicSelectorValue(java.lang.String originalID)
Calculates a list of selector values and group by units, whose values are needed to answer the target prompt.java.util.List
getDynamicUnits()
Calculates a list of template and group by units, whose values are needed to answer the target prompt.java.util.List
getDynamicUnits(WebReportGrid grid)
Calculates a list of template and group by units, whose values are needed to answer the target prompt.java.util.List
getDynamicUnits(WebReportGrid grid, boolean includeAllValidUnitsForDynamic)
Calculates a list of template and group by units, whose values are needed to answer the target prompt.java.lang.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.java.lang.String
getPromptId()
Returns target prompt IDjava.lang.String
getPromptOriginId()
Returns target prompt origin ID.int
getPromptOriginType()
Returns target prompt origin type.int
getPromptType()
Returns target prompt type.java.lang.Object
getStaticAnswer()
Returns the static answer if the AnswerMode == STATIC.void
setAnswerMode(int am)
Set the answer modevoid
setFormID(java.lang.String formID)
Set form id for a dynamically answered constant prompt.void
setPrompt(java.lang.String id, int pt)
Set the target prompt for this answer.void
setPromptOrigin(java.lang.String id, int type)
Set target prompt origin.
-
-
-
Method Detail
-
getPromptType
int getPromptType()
Returns target prompt type.- Returns:
- an int specify the target prompt type, the type refers to
EnumDSSXMLPromptType
-
getPromptId
java.lang.String getPromptId()
Returns target prompt ID- Returns:
- A String representing the ID of the target prompt.
-
setPrompt
void setPrompt(java.lang.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 toEnumDSSXMLPromptType
- Since:
- MicroStrategy Web 9.0.0
-
getPromptOriginId
java.lang.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:
- A String representing the ID of the source
WebAttribute
for the targetWebPrompt
of this answer.
-
getPromptOriginType
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 fromEnumDSSXMLObjectTypes
.- Returns:
- a int representing the type of of the source
WebAttribute
for the targetWebPrompt
of this answer.
-
setPromptOrigin
void setPromptOrigin(java.lang.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 fromEnumDSSXMLObjectTypes
.- Since:
- MicroStrategy Web 9.0.0
-
getAnswerMode
int getAnswerMode()
Returns answer mode- Returns:
- a int from
EnumLinkAnswerMode
representing the mode of this answer.
-
setAnswerMode
void setAnswerMode(int am)
Set the answer mode- Parameters:
am
- An int fromEnumLinkAnswerMode
representing the answer mode.- Since:
- MicroStrategy Web 9.0.0
-
getStaticAnswer
java.lang.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 aWebElements
object.- Returns:
- a
Object
representing the static answer
-
getDynamicUnits
java.util.List getDynamicUnits() throws WebObjectsException
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
-
getDynamicUnits
java.util.List getDynamicUnits(WebReportGrid grid) throws WebObjectsException
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
-
getDynamicUnits
java.util.List getDynamicUnits(WebReportGrid grid, boolean includeAllValidUnitsForDynamic) throws WebObjectsException
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.include
- all the valid units for dynamic- Returns:
- a
List
representing the Dynamic Units for the answer. - Throws:
WebObjectsException
-
getFormID
java.lang.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. UsegetPromptOriginId()
to get the attribute id.- Returns:
- form id of the constant prompt
-
setFormID
void setFormID(java.lang.String formID)
Set form id for a dynamically answered constant prompt.- Parameters:
formID
-
-
getDynamicSelectorValue
RWGroupByElements getDynamicSelectorValue(java.lang.String originalID)
Calculates a list of selector values and group by units, whose values are needed to answer the target prompt. This list is calculated based on the selectors which targets to the grid, and values in the page by field.- Parameters:
originalID
- The ID of the prompt target element.- Returns:
- a
RWGroupByElements
representing the Dynamic Units for the answer.
-
-