This appendix provides detailed reference entries for the servlet beans that are included with ATG Adaptive Scenario Engine. It begins with a list of servlet beans grouped by functional area, and continues with the reference entries in alphabetical order.
Note that additional servlet beans are included with other ATG solutions. Your application can also use custom servlet beans written by programmers at your site.
There are several types of servlet beans included with ATG Adaptive Scenario Engine:
standard servlet beans, which you can use in any ATG application
database and repository access servlet beans, which you can use in ATG applications that store data in a database or a repository
XML servlet beans, which you can use with ATG applications that include XML documents
transaction servlet beans, which you can use to mark the bounds of a transaction within a JSP
personalization servlet beans, which you can use to supply content to users based on information in their profiles.
Standard Servlet Beans
The following table provides a list of the standard servlet beans, and summarizes what they do.
ClassName |
|
---|---|
Component |
|
Function | Sets any property value by dynamically specifying the property and value to update |
ClassName |
|
Component |
|
Function | Caches content that changes infrequently |
ClassName |
|
Component |
|
Function | Displays one of a set of possible outputs, depending on the relative value of its two input parameters |
ClassName |
|
Component |
|
Function | Displays a numeric value as a currency amount, and converts a value from one currency to another, formatting it based on the locale |
ClassName |
|
Component |
|
Function | Displays a numeric value as a currency amount, formatting it based on the locale |
ClassName |
|
Component |
|
Function | Displays error messages that occur during a form submission |
ClassName |
|
Component |
|
Function | Displays a single output the number of times specified |
ClassName |
|
Component |
|
Function | Displays each element of an array |
ClassName |
|
Component |
|
Function | Displays one or more text values, formatting them based on locale |
ClassName |
|
Component |
|
Function | Displays one of two possible outputs, depending on whether its input parameter is empty |
ClassName |
|
Component |
|
Function | Displays one of two possible outputs, depending on whether its input parameter is null |
ClassName |
|
Component |
|
Function | Enables switching between http and https protocols |
ClassName |
|
Component |
|
Function | Displays a subset of the elements of an array |
ClassName |
|
Component |
|
Function | Redirects the user to the specified page |
ClassName |
|
Component |
|
Function | Displays one of a set of possible outputs, depending on the value of its input parameter |
ClassName |
|
Component |
|
Function | Displays each element of an array, arranging the output in a two-dimensional format |
ClassName |
|
Component |
|
Function | Displays a subset of the elements of an array, arranging the output in a two-dimensional format |
Database and Repository Access Servlet Beans
The following table provides a list of the servlet beans for accessing data stored in a database or a repository.
ClassName |
|
---|---|
Component | |
Function | Takes a repository item as input and generates either a static or dynamic URL, depending on whether the page it is on is being viewed by a human visitor or a Web spider. |
ClassName |
|
Component |
|
Function | Looks up an item in one or more repositories, based on the item’s ID, and renders the item on the page |
ClassName |
|
Component | |
Function | Tracks each page that a user visits and makes it easy for that user to backtrack and return to pages he or she has already visited |
ClassName |
|
Component |
|
Function | Initiates a pipeline thread |
ClassName |
|
Component |
|
Function | Returns a list of repository items of the specified item type |
ClassName |
|
Component |
|
Function | Specifies a RelationalView and subview, executes a query, and then passes the results of that query to another servlet bean (such as |
ClassName |
|
Component |
|
Function | Constructs an RQL query and renders its |
ClassName |
|
Component |
|
Function | Constructs an RQL query of a SQL database and renders its |
ClassName |
|
Component |
|
Function | Constructs a query of a SQL database and renders its output parameter once for each row returned by the database query |
ClassName |
|
Component |
|
Function | Constructs a query of a SQL database and renders its |
XML Servlet Beans
The following table provides a list of the servlet beans for use with XML documents.
ClassName |
|
---|---|
Component |
|
Function | Given a DOM node, selects all nodes that match a specified pattern and iterates over each selected node |
ClassName |
|
Component |
|
Function | Given a DOM node, selects the next node that matches a specified pattern |
ClassName |
|
Component |
|
Function | Parses an XML document and transforms it into a DOM document, making the document’s nodes and attributes available as objects and object properties |
ClassName |
|
Component |
|
Function | Given an XML document and an XSLT or JSP template, transforms and outputs the XML document, with the formatting provided by the template |
Transaction Servlet Beans
The following table provides a list of the servlet beans for transaction demarcation.
ClassName |
|
---|---|
Component |
|
Function | Commits or rolls back the current transaction |
ClassName |
|
Component |
|
Function | Marks the bounds of a transaction within a JSP |
Personalization Servlet Beans
The following table provides a list of the servlet beans for use with user profiles.
ClassName |
|
---|---|
Component |
|
Function | Add a profile marker to a profile |
ClassName |
|
Component |
|
Function | Locates the last profile marker added to a profile |
ClassName |
|
Component |
|
Function | Locates the last profile marker with a particular key that was added to a profile |
ClassName |
|
Component |
|
Function | Determines whether a profile has a profile marker |
ClassName |
|
Component |
|
Function | Removes all profile markers from a profile |
ClassName |
|
Component |
|
Function | Removes a profile marker from a profile |
ClassName |
|
Component |
|
Function | Filters objects in a collection |
ClassName |
|
Component |
|
Function | Returns the |
ClassName |
|
Component |
|
Function | Fires a content event if a user has the appropriate Principal (identity) |
ClassName |
|
Component |
|
Function | Sends page viewed events for the current page being viewed |
ClassName |
|
Component |
|
Function | Renders a collection of |
ClassName |
|
Component |
|
Function | Looks up an item in a specific repository, based on the item’s ID, and renders the item on the page |
ClassName |
|
Component |
|
Function | Performs a targeting operation and then passes the results to another servlet bean for display |
ClassName |
|
Component |
|
Function | Performs a targeting operation and displays the first n items returned by the targeter, where n is a number you specify |
ClassName |
|
Component |
|
Function | Performs a targeting operation and displays all of the items returned by the targeter |
ClassName |
|
Component |
|
Function | Performs a targeting operation and randomly selects and displays n items returned by the targeter, where n is a number you specify |
ClassName |
|
Component |
|
Function | Performs a targeting operation and displays a subset of the items returned by the targeter, specified as a range |
ClassName |
|
Component | |
Function | Returns information about a specified set of workflow instances |
ClassName |
|
Component | |
Function | Returns information about a specified set of workflow tasks |
Business Process Tracking Servlet Beans
The following table provides a list of the servlet beans that work with business process tracking.
ClassName |
|
---|---|
Component |
|
Function | Adds a marker when a business object reaches a new business process stage |
ClassName |
|
Component |
|
Function | Tests whether a business object has reached a specified business process stage |
ClassName |
|
Component |
|
Function | Tests whether the business process stage most recently reached by a business object matches the specified stage |
ClassName |
|
Component |
|
Function | Removes a specified business process stage |