AbstractPromptObjectTransform

Obtains the dimension attribute given the WebDisplayUnit instance provided.

Indicates default value for match case checkbox.
Intended for prompt styles where searches on attributes or objects are supported, such as cart prompts. Default value is determined by a project preference available in Web application. any prompts that have a search field with a 'match case' check box will default to this property value.

Indicates block count, an incremental fetch value for displaying list of objects.
This value is used to determine the number of objects displayed per page or block.
Note: incremental fetch isn't supported by all prompt types and styles. Available only in object prompts with Cart styles and most Hierarchical prompts.

Returns an arraylist containing DisplayWebUnits.
This list can be processed by a layout file using a "list" structure. For example: This snippet shows how the "list" structure gets its elements using the getPromptsList function. The "render" method receives an item from the list as an argument to give back some output.

Indicates property value for whether or not displaying required message.

Indicates Bean type of prompt object being used by the transform.

Provides factory class for creating HTML tags.
This TagsFactory instance is a factory class which will allow the creation of Tag objects in order to create HTML tags.

Initializes the css information to be used by this transform.

Initializes the images to be used by this transform.

Checks whether a prompt has a default answer, and if it has, if the default answer is complex. Complex answers are those that cannot be displayed by the prompt answer input interface, so they need to be rendered in a separate window

Indicates whether or not 'Back to Top' anchor is enabled for current prompt.

Indicates whether or not DHTML mode is enabled.

Determines whether or not given prompt was defined as Dimty prompt.
Prompt is considered dimensional prompt if level flag allows to display default answer and prompt's answer is considered as complex and prompt's type is Dimty.

Indicates property value for whether or not selected item in cart's 'From' list should be removed.

Determines whether given WebDisplayUnit unit is locked up.
Tests if the lock type is DssXmlLockCustom or DssXmlLockLimit, in which case returns True

Determines whether given WebDisplayUnit unit is locked up for search only.
Tests if the lock type is DssXmlLockCustom in which case returns True.

Indicates whether or not given prompt is initialized.

Shortcut method to check whether the prompt is required.

Indicates whether to display prompt summary or not.

Renders hidden values for prompt's max/min limits.
Append prompt restrictions as hidden values to be used in DHTML mode for validating dates vs the minimum/maximum values if there are any.

Renders prompt's meaning information.
For the current answer, it renders it's meaning. Used when rendering the prompt summary, or when the prompt has a complex answer.

Renders HTML anchor to allow end users to go back to Top of Prompts page.
This anchor won't be rendered if given prompt happens to be first one in collection when displaying all prompts in one page.

Renders the body of the prompt content.
Each concrete class must override this method.

Renders HTML area with default answer definition.
This answer is displayed below prompt question and it's only informative.

Renders a localized generic error message to end-users.
Error is displayed mostly when a validation fails either in backend or SDK. It is enabled in all prompt types and styles.

Renders the hidden inputs of this prompt.
The inputs are retrieved from the answer event.

Renders the content of the prompt in case of an IFrame request.
This method should be processed by the child transform if needed. Likely, when Hierarchical Prompt tree style is being processed.

Renders the meaning of the prompt.
Meaning information is available in Prompt's definition. It is rendered under the title.

Displays error message indicating that available list doesn't have any selection available.
Available mostly with embedded promtps, where second prompt doesn't have selections. Error must be displayed to inform end-users.

Renders a localized message for indicating given prompt is not answered.
It creates an HTML SPAN tag whose inner text is consisted of localized message associated to descriptor id 1068 ('Prompt not answered').

Renders each of the prompt fields in corresponding order.
Level is checked before rendering each prompt field. The rendering order is as follows: title, error message (if any), meaning, restrictions, content or no selections available (if applies), and finally default answer.
Each of these fields has its own render method, for example, title gets rendered by function renderPromptTitle.

Renders prompt's restrictions.
Restrictions are available in current prompt's definition.

Renders prompt's Summary section when Page is in 'Summary' mode.
It displays summary title and immediately it displayes summary answer.

Renders the prompt's answer in a formatted string in 'Summary' mode.

Renders Prompt's title in 'Summary' mode.

Renders the title of the prompt.

Specifies incremental fetch value for the size of block of attribute's elements to be displayed.

Specifies whether or not to display 'Back to Top' anchor.
Property being set by Prompts container transform.

Specifies flag value for enabling or disabling item removal in Cart prompt transforms.

Specifies level of visibility for all fields in prompt question are displayed.
Prompt question is broken down in four visible fields: title, meaning, restriction and content. Multiple fields can be displayed at the same time. Which fields to be displayed is indicated by a bit-wise flag.
Allowed Values:

Title = LEVEL_SHOW_TITLE
• Meaning = LEVEL_SHOW_MEANING
• Restriction = LEVEL_SHOW_RESTRICTION
• Content = LEVEL_SHOW_CONTENT
• Show all = LEVEL_SHOW_ALL

Specifies default value for match case checkbox.
Intended for prompt styles where searches on attributes or objects are supported, such as cart prompts. Default value is determined by a project preference available in Web application. any prompts that have a search field with a 'match case' check box

Specifies incremental fetch value for the size of block of objects to be displayed.

Specifies whether or not to enable prompt summary.
Used when prompt summary has to be displayed. Instead of rendering all prompt quiestion fields, a brief prompt summary of current will be displayed.

Specifies property for whether or not displaying required message.

Transforms the PromptObject and append the output to the MarkupOutput.
Here, all output transformation take place. PromptObject is processed in order to generate corresponding output through MarkupOutput instance.
Which type of output, either Prompt summary or prompt question, is determined here. Images and prompt content get initialized prior to rendering prompt fields.

Indicates whether or not prompts are loaded the firt time.
It looks for any 'prompt' hidden value in request indicating there was a prompt request to be processed. This means, user has started editing any prompt in report.

Indicates if the level parameter value contains given flag.
Level flag is used for determining which sections in prompt will be displayed.

Returns instance of prompt answer event.

Returns an argument name for the given id.
Argument will be read from prompt's Answer event arguments collection. Since the argument name depends on the PromptPosition, this method automatically returns the argument corresponding to the current Prompt.

Specifies a WebDisplayUnits collection of the available units of this prompt.
This collection is used for rendering prompt question.

Returns a localized instance of Calendar component.
This object is used for creating an calendar HTML object used for entering date values.

Retrieves the connected Container Services object.
If anything fails along the way, returns null.

Returns a descriptor (localized message) associated to this key.

Provides an instance of Web display helper object.
This inteface is used to generate display XML containing both the contents of an object (e.g. the current state of a filter) and a list of available objects which the user can choose from to add to the object.

Returns a localized error message.
Error message is associated to promptError code returned by SDK. It's associated to a generic error message to be displayed.

Returns the int value of a FormalParamter.
The FormalParamter needs to be of type Integer.

Returns instance of current Locale.
Locale is used for localizing all messages displayed to end user.

Indicates instance of PromptObject PromptObject being transformed.
This interface represents information about a single prompt. It manages its position property and a WebPrompt object.

Determines prompt's AppContext.
It creates an AppContext from Prompt's Bean context.

Indicates current instance of PromptsBean to be transformed.

Returns the string value of the Formal Parameter.

Indicates whether prompt instance has an answer in its definition.
It could be either a default or previous answer.

Initializes infrastructure needed for rendering prompt.
Part of initialization process requires to process or initialize at least three main areas: Incremental fetch, available items and set extra arguments. Incremental fetch process will initialize all corresponding objects needed for displaying it, if available. Available Items process, will require few calls to SDK in order to retrieve information from backend. Setting extra arguments will add at the end of the prompt's HTML form, all request parameters for persistance needed to be passed on every request.
Most likely, each prompt transform extending this interface will overwrite any of these functions. Each prompt type and style might have different ways of initializing their data.

Initializes prompt object to default values.
Here, properties for determining whether or not prompts are sorted by required and level flag are specified.

Indicates whether or not Frame is active in Web application.

Indicates if a single subexpression is considered as Complex.
An expression is complex if it cannot be created using the Web interface.
This is used by ExpressionPrompts transforms to determine if the Answer is Complex.

Indicates if given FormalParamter is a Boolean True instance.

Indicates whether or not this a prompted XDA Report.

Indicates whether or not this a prompted CustomSQL Report.

Indicates whether or not this a prompted MDX Report.

Retrieves a new instance of a Hidden Input Builder from the connected Container Services object.
If anything fails along the way, returns null.

Retrieves a new instance of a Namespace Encoder from the connected Container Services object.
If anything fails along the way, returns null.

Initializes display settings for retrieving available items defined in prompt.
This function will be responsible of initializing the settings for default highlighting and default selection prior to getting a formatted DisplayXML, which is used for rendering prompt question. These settings will be used for getting the available display units collection, which is used to display all available objects to end user. It will turn on default selection should be enabled. It will turn on default highlighting should be enabled. It will turn off whether default highlighting preventing it from being detailed.
These settings will be applied to a WebDisplayHelper object, property part of current PromptObject. It is used to generate display XML containing both the contents of an object (e.g. the current state of a filter) and a list of available objects which the user can choose from to add to the object.

Initializes incremental fetching settings.
This function has to be overwritten for prompts different to element and object. It gets instance of WebPrompt by calling PromptObject.getWebPrompt() function; WebPrompt is an interface that represents a prompt object. It defines functionality common to all prompt types.
Depending upon what prompt type is, either element or object, properties for incremental fetch are set. For element prompts, WebPrompt instance is cast to WebElementsPrompt class and function setBlockCount is called.
In the case of an object prompt, we cast WebPrompt instance to a WebObjectsPrompt class. Here, search object (WebSearch instance) gets modified. Name pattern and block count are set.

Renders transform using layout infrastructure.
It process prompt transform through Layouts and if this approach fails a localized error message (descript 'An error has ocurred on this page' denoted by descriptor id 116) is displayed.

Specifies a new argument value denoted by an unique Id.
This new argument will set to prompt's Answer event arguments collection.

Sets extra arguments for this prompt.
These arguments will be render later as hidden inputs.

Sets active locale in Web application.
Locale is used for localizing all messages displayed to end user.