Package com.microstrategy.web.app.transforms

Class SearchSimpleTransform

    • Field Detail

      • imgCalendar

        public FormalParameter imgCalendar
        Specifies the image file name used by the transform to display the calendar button in DHTML mode.
        This image should be contained in the images folder of the application.
        Usage:
        For example, if you want to specify a different image for the calendar button, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • CLASS_SECTION_NAME

        protected static final java.lang.String CLASS_SECTION_NAME
        See Also:
        Constant Field Values

      • CLASS_FOLDER_NAME

        protected static final java.lang.String CLASS_FOLDER_NAME
        See Also:
        Constant Field Values

      • CLASS_INVALID_FIELD

        protected static final java.lang.String CLASS_INVALID_FIELD
        See Also:
        Constant Field Values

      • DIV_NAME_OPTIONS

        protected static final java.lang.String DIV_NAME_OPTIONS
        See Also:
        Constant Field Values

      • DIV_LOCATION_TITLE

        protected static final java.lang.String DIV_LOCATION_TITLE
        See Also:
        Constant Field Values

      • DIV_DESCRIPTION

        protected static final java.lang.String DIV_DESCRIPTION
        See Also:
        Constant Field Values

    • Constructor Detail

      • SearchSimpleTransform

        public SearchSimpleTransform()
        Default no-args constructor, initialize formal parameters.

    • Method Detail

      • getSearchBean

        protected SearchBean getSearchBean()

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Description copied from class: AbstractAppTransform

        This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

        This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractAppTransform
        Parameters:
        data - the bean to transform.

      • renderProcessingButton

        protected void renderProcessingButton​(MarkupOutput out,
                                      WebEvent event,
                                      java.lang.String buttonDescriptor)
        Overwrites the super's implementation to make the buttons on the wait page use Typical state.
        Overrides:
        renderProcessingButton in class AbstractAppTransform
        Parameters:
        out - the output for the transform
        event - event for the button
        buttonDescriptor - the buton's descriptor
        Since:
        MicroStrategy Web 8.1.0

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Description copied from class: AbstractAppTransform
        Creates an <a> tag from the EventManager.
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - the WebEvent to generate the link with the request
        Returns:
        AnchorTag instance initialized with the information from the event
        Since:
        MicroStrategy Web 8.0.0

      • renderNewSearchLink

        public void renderNewSearchLink​(MarkupOutput out)
        Render a link that will clean the user's search criteria.
        Since:
        MicroStrategy Web 8.0.0

      • getNewSearchEvent

        protected WebEvent getNewSearchEvent()
        Since:
        MicroStrategy Web 9.0.0

      • getSwitchSearchModeEvent

        protected WebEvent getSwitchSearchModeEvent()
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchTypeLink

        public void renderSearchTypeLink​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.0.0

      • renderJavaScriptFooter

        public void renderJavaScriptFooter​(MarkupOutput out)
        Renders javascript variables at the bottom of the transform to be used in DHTML mode.
        Parameters:
        out - where to write the output of the method.

      • renderNameSection

        public void renderNameSection​(MarkupOutput out)
        Deprecated.
        Please use renderSimpleNameSection or renderAdvancedNameSection
        Renders the name section
        Parameters:
        out -

      • renderSimpleNameSection

        public void renderSimpleNameSection​(MarkupOutput out)
        Renders the search name input box without the string constraints drop down box, ie.contains, begins with and etc.
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderAdvancedNameSection

        public void renderAdvancedNameSection​(MarkupOutput out)
        Renders the advanced search name input box including the string contraints dorpdown box.
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderRequiredLabelForSearchName

        public void renderRequiredLabelForSearchName​(MarkupOutput out)
        Renders the "Required" label for the search name
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchNameTextInputBox

        public void renderSearchNameTextInputBox​(MarkupOutput out)
        Renders the search string input text box
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchNameTitle

        public void renderSearchNameTitle​(MarkupOutput out)
        Renders the title for the name section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchStringConstraintsComboBox

        public void renderSearchStringConstraintsComboBox​(MarkupOutput out)
        Renders the string constraints dropdown for the name section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderLocationSection

        public void renderLocationSection​(MarkupOutput out)
        Deprecated.
        Please use renderFullSimpleLocationSection or renderFullAdvancedLocationSection
        Renders the location section
        Parameters:
        out -

      • renderFullSimpleLocationSection

        public void renderFullSimpleLocationSection​(MarkupOutput out)
        Renders the complete location section for simple search
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderFullAdvancedLocationSection

        public void renderFullAdvancedLocationSection​(MarkupOutput out)
        Renders the complete location section for advanced search
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderLocationRadioButtons

        public void renderLocationRadioButtons​(MarkupOutput out)
        Renders the available search locations as radio buttons
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchLocationMyReportFolder

        public void renderSearchLocationMyReportFolder​(MarkupOutput out)
        Renders the search location option for "my report" folder
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchLocationSharedReportsFolder

        public void renderSearchLocationSharedReportsFolder​(MarkupOutput out)
        Renders the search location option for "Shared Report" folder
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchLocationCurrentFolder

        public void renderSearchLocationCurrentFolder​(MarkupOutput out)
        Renders the search location option for the current folder
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • hasCurrentSearchFolder

        public boolean hasCurrentSearchFolder()
        Returns:
        boolean
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchLocationAllFolders

        public void renderSearchLocationAllFolders​(MarkupOutput out)
        Renders the search location option for all folders
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderLocationTitle

        public void renderLocationTitle​(MarkupOutput out)
        Renders the location section with the horizontal divider i.e. used for advanced search form
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderTypesSection

        public void renderTypesSection​(MarkupOutput out)
        Renders the complete search type section
        Parameters:
        out -

      • renderTypeTitle

        public void renderTypeTitle​(MarkupOutput out)
        Renders the type section title
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypeTemplates

        public void renderSearchObjectTypeTemplates​(MarkupOutput out)
        Renders the search object type option for templates
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypeFilters

        public void renderSearchObjectTypeFilters​(MarkupOutput out)
        Renders the search object type option for filters
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypeCustomGroups

        public void renderSearchObjectTypeCustomGroups​(MarkupOutput out)
        Renders the search object type option for filters
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypeFolders

        public void renderSearchObjectTypeFolders​(MarkupOutput out)
        Renders the search object type option for folders
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypeHTMLDocuments

        public void renderSearchObjectTypeHTMLDocuments​(MarkupOutput out)
        Renders the search object type option for HTML Documents
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypeDocuments

        public void renderSearchObjectTypeDocuments​(MarkupOutput out)
        Renders the search object type option for Documents
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypePrompts

        public void renderSearchObjectTypePrompts​(MarkupOutput out)
        Renders the search object type option for Documents
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • renderSearchObjectTypeReports

        public void renderSearchObjectTypeReports​(MarkupOutput out)
        Renders the search object type option for Reports
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchObjectTypeUsers

        public void renderSearchObjectTypeUsers​(MarkupOutput out)
        Renders the search object type option for users
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • renderSearchObjectTypeGroups

        public void renderSearchObjectTypeGroups​(MarkupOutput out)
        Renders the search object type option for groups
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • renderSearchObjectTypeSecurityRoles

        public void renderSearchObjectTypeSecurityRoles​(MarkupOutput out)
        Renders the search object type option for security roles
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • renderSearchObjectTypeShortcuts

        public void renderSearchObjectTypeShortcuts​(MarkupOutput out)
        Renders the search object type option for Documents
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • isTypeSelected

        public boolean isTypeSelected​(int type)

      • renderDatesSection

        public void renderDatesSection​(MarkupOutput out)
        Renders the date section
        Parameters:
        out -

      • renderDateAdvancedFindAllObjectsWithSpecifiedDates

        public void renderDateAdvancedFindAllObjectsWithSpecifiedDates​(MarkupOutput out)
        Renders the Find All Objects with Dates in Dates section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderDateStartAndEndDate

        public void renderDateStartAndEndDate​(MarkupOutput out)
        Renders the start date and end date
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderDateForPreviousTimeUnits

        public void renderDateForPreviousTimeUnits​(MarkupOutput out)
        Renders the "During Previous ## Hours/Days/Weeks/Months/Years"
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderFindAllObjectsWithCreatedOrModified

        public void renderFindAllObjectsWithCreatedOrModified​(MarkupOutput out)
        Renders the advanced option for Find All Objects with the Created/Modified combo box
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderDateSimpleFindAllObject

        public void renderDateSimpleFindAllObject​(MarkupOutput out)
        Renders the simple option of find all objects without the specific dates
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderDateTitle

        public void renderDateTitle​(MarkupOutput out)
        Renders the title for dates section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderOwnerSection

        public void renderOwnerSection​(MarkupOutput out)
        Renders the complete owner section
        Parameters:
        out -

      • renderOwnerCreatedOnlyByMe

        public void renderOwnerCreatedOnlyByMe​(MarkupOutput out)
        Renders the option of "created only by me" in the owner secction
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderOwnerCreatedByAnyUser

        public void renderOwnerCreatedByAnyUser​(MarkupOutput out)
        Renders the option of "created by any user" in the owner section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderOwnerTitle

        public void renderOwnerTitle​(MarkupOutput out)
        Renders the owner section title
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderDescriptionSection

        public void renderDescriptionSection​(MarkupOutput out)
        Renders the complete description section
        Parameters:
        out -

      • renderDescriptionTextArea

        public void renderDescriptionTextArea​(MarkupOutput out)
        Renders the text area for description section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderDescriptionTitle

        public void renderDescriptionTitle​(MarkupOutput out)
        , Renders the description section title
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderSearchOptionsTitle

        public void renderSearchOptionsTitle​(MarkupOutput out)
        , Renders the search options section title
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.1.0

      • renderSearchOptionsDerefrenceShortcut

        public void renderSearchOptionsDerefrenceShortcut​(MarkupOutput out)
        , Renders the search option DerefrenceShortcut checkboxes
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.1.0

      • renderSearchDetails

        public void renderSearchDetails​(MarkupOutput out)
        Displays the details of the criteria used for the search.
        Parameters:
        out - output by this transform

      • renderImage

        public void renderImage​(MarkupOutput out,
                        java.lang.String image)
        Renders a transform's image
        Overrides:
        renderImage in class AbstractAppTransform
        Parameters:
        out - where to write the output of the method.
        image - the image name

      • renderFieldName

        public void renderFieldName​(MarkupOutput out,
                            java.lang.String field,
                            java.lang.String forField)
        Renders the name of a search field. This function checks if the field is valid and if it is required. To work properly, the className argument must be one of the of the SearchBeanFIELD_ constants.
        Parameters:
        out - where to write the output of the method.
        field - the field's name
        forField - the for attribute in the label *
        Since:
        MicroStrategy Web 8.0.0

      • renderFieldName

        public void renderFieldName​(MarkupOutput out,
                            java.lang.String field)
        Renders the name of a search field. This function checks if the field is valid and if it is required. To work properly, the className argument must be one of the of the SearchBeanFIELD_ constants.
        Parameters:
        out - where to write the output of the method.
        field - the field's name

      • renderSpanStart

        public void renderSpanStart​(MarkupOutput out,
                            java.lang.String className)
        Renders a transform's SPAN tag start. For all tags it generates:
        <SPAN CLASS="className">
        This method automatically adds the prefix to all the classNames.
        To work properly, the className argument must be one of the of the CLASS_ constants of this transform.
        Parameters:
        out - where to write the output of the method.
        className - the css class to use with this span

      • renderSpanEnd

        public void renderSpanEnd​(MarkupOutput out,
                          java.lang.String className)
        Renders a transform's SPAN tag end, i.e.: </DIV >
        Parameters:
        out - where to write the output of the method.
        className - the css class to use with this span

      • renderDivStart

        public void renderDivStart​(MarkupOutput out,
                           java.lang.String name)
        Renders a transform's DIV tag start. For all tags it generates:
        <DIV ID="name">
        To work properly, the name argument must be one of the of the DIV_ constants of this transform.
        DIV tags will not be rended in HTML only mode.
        Parameters:
        out - where to write the output of the method.
        name - the id to use with this div

      • renderDivEnd

        public void renderDivEnd​(MarkupOutput out,
                         java.lang.String name)
        Renders a transform's DIV tag end, i.e.: </DIV>
        To work properly, the name argument must be one of the of the DIV_ constants of this transform.
        Parameters:
        out - where to write the output of the method.
        name - the id to use with this div

      • getCalendar

        public GGCalendar getCalendar​(java.lang.String imgCalendar)
        getCalendar

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Specified by:
        getDescription in interface Transform
        Returns:
        The textual description of the transform.

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Description copied from class: AbstractAppTransform
        Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example: 
         public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
        Specified by:
        getSupportedBeanType in interface Transform
        Overrides:
        getSupportedBeanType in class AbstractAppTransform
        Returns:
        a root class/interface supported by this transform.