public class

FolderDetailsTransform

extends AbstractFolderTransform
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.FolderDetailsTransform

Class Overview

This transform displays the number of folder, reports and documents within the specified FolderBean

Summary

[Expand]
Inherited Constants
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.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderDetailsTransform()
Class constructor.
Public Methods
String getDescription()
Return description for this transform
void renderDescription(MarkupOutput out)
Renders the description of the folder object, if available.
void renderDescription(MarkupOutput out, WebFolder folder)
This method is deprecated. please use renderDescriptionInfo(MarkupOutput, WebObjectInfo) instead
void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Renders the description of the folder object, if available.
void renderDocumentCount(MarkupOutput out)
Renders the number of documents in the folder
void renderFilterCount(MarkupOutput out)
Renders the number of filters in the folder
void renderFolderCount(MarkupOutput out)
Renders the number of folders in the folder
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. Please use and customize renderList(MarkupOutput) instead since this method will not be called by future releases
void renderReportCount(MarkupOutput out)
Renders the number of reports in the folder
void renderTemplateCount(MarkupOutput out)
Renders the number of templates in the folder
void transformForRequestInError(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestEndsInError.
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.
[Expand]
Inherited Methods
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 FolderDetailsTransform ()

Class constructor. Initializes the formal parameters

Public Methods

public String getDescription ()

Return description for this transform

Returns
  • String with the description for the transform.

public void renderDescription (MarkupOutput out)

Renders the description of the folder object, if available.

Parameters
out MarkupOutput instance to modify with the transform's output.
Throws
WebBeanException if an error happens obtaining the description of the object
WebObjectsException if an error happens obtaining the description of the object

public void renderDescription (MarkupOutput out, WebFolder folder)

This method is deprecated.
please use renderDescriptionInfo(MarkupOutput, WebObjectInfo) instead

Renders the description of the folder object, if available.

Parameters
out MarkupOutput instance to modify with the transform's output.
folder WebFolder instance of the FolderBean from where the description to display will be obtained.

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo object)

Renders the description of the folder object, if available.

Parameters
out MarkupOutput instance to modify with the transform's output.
object from where the description to display will be obtained.

public void renderDocumentCount (MarkupOutput out)

Renders the number of documents in the folder

Parameters
out MarkupOutput instance where the HTML output of this method will be saved

public void renderFilterCount (MarkupOutput out)

Renders the number of filters in the folder

Parameters
out MarkupOutput instance where the HTML output of this method will be saved

public void renderFolderCount (MarkupOutput out)

Renders the number of folders in the folder

Parameters
out MarkupOutput instance where the HTML output of this method will be saved

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
Please use and customize renderList(MarkupOutput) instead since this method will not be called by future releases

Renders the number of children objects defined inside the folder. Currently it counts objects from the following types:

  • DssXmlTypeFolder
  • DssXmlTypeReportDefinition
  • DssXmlTypeDocumentDefinition
  • DssXmlTypeFilter
  • DssXmlTypeTemplate The count is based on the getSortedList() method output.

  • Parameters
    out MarkupOutput instance to modify with the transform's output.
    list WebDisplayUnits instance with the list of objects that will be used for rendering the transform.

    public void renderReportCount (MarkupOutput out)

    Renders the number of reports in the folder

    Parameters
    out MarkupOutput instance where the HTML output of this method will be saved

    public void renderTemplateCount (MarkupOutput out)

    Renders the number of templates in the folder

    Parameters
    out MarkupOutput instance where the HTML output of this method will be saved

    public void transformForRequestInError (MarkupOutput out)

    Transforms the assosciated WebBean when its status is WebBeanRequestEndsInError.

    Parameters
    out MarkupOutput instance where the contents of this transform will be saved.

    public void transformForRequestSuccessful (MarkupOutput out)

    Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful. Overwrites the original method by adding a call to render the folder's description after the renderList() method contents have been obtained.

    Parameters
    out MarkupOutput instance where the contents of this transform will be saved.