public class

FolderSearchResultsTransform

extends FolderListTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderListTransform
               ↳ com.microstrategy.web.app.transforms.FolderSearchResultsTransform

This class is deprecated.
Use FolderSearchResultsXHTMLTransform instead.

Class Overview

This class extends the FolderListTransform by rendering specific messages related to search results.
After all, the results of a search are returned as a Folder, this transform shows the messages when the maxObject count was reached, or when the search returned no results.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderListTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderListTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderSearchResultsTransform()
Public Methods
WebEvent getEvent(WebObjectInfo object)
Extends getEvent by changing the event of the folder bean to make sure it uses browse folder event.
void initializeCss()
Initializes the Css Classes to use.
void renderEmptyList(MarkupOutput out, WebFolder folder)
This method is deprecated. please use renderEmptyList(MarkupOutput) instead. The folder to access will be the available for this transform.
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.
void renderSearchResultsCount(MarkupOutput out, WebSearch search)
Get the HTML to be displayed which includes the number of elements found
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
WebEvent getAdvancedSearchEvent(WebSearch search)
Get the WebEvent for obtaining the advanced search interface.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderListTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public FolderSearchResultsTransform ()

Public Methods

public WebEvent getEvent (WebObjectInfo object)

Extends getEvent by changing the event of the folder bean to make sure it uses browse folder event.

Parameters
object a WebObjectInfo for which the event must be retrieved.
Returns
  • the WebEvent associated with browsing folders for the objects of type DssXmlTypeFolder. For any other object types, returns what the parent class would obtain. If the application does not support the event, returns null.

public void initializeCss ()

Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.

public void renderEmptyList (MarkupOutput out, WebFolder folder)

This method is deprecated.
please use renderEmptyList(MarkupOutput) instead. The folder to access will be the available for this transform.

Get the HTML to display when the folder does not have any contents to be rendered. Extend renderEmtpyList(MarkupOutout, WebFolder), by showin a message indicating that the search returned no objects and some tips on how to extend the search.

Parameters
out MarkupOutput instance where the transform's output will be saved.
folder the WebFolder instance from the FolderBean being transformed.

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.

Extends renderList by adding a message about the count of objects and for adding a summary descriptor (localized string for This table displays the objects result of your search) for the global table that will hold the results.

Parameters
out MarkupOutput instance where the transform's output will be saved.
list WebDisplayUnits instance to be rendered

public void renderSearchResultsCount (MarkupOutput out, WebSearch search)

Get the HTML to be displayed which includes the number of elements found

Parameters
out MarkupOutput instance where the transform's output will be saved.
search the WebSearch instance with the results of the search.

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent from where the link information will be obtained
Returns
  • AnchorTag instance initialized with the event information

protected WebEvent getAdvancedSearchEvent (WebSearch search)

Get the WebEvent for obtaining the advanced search interface.

Parameters
search WebSearch instance currently used
Returns
  • a WebEvent instance initialized with the event, or null if the application doesn't support it.