Class SearchSupportedTypesAddon

  • All Implemented Interfaces:

    public class SearchSupportedTypesAddon
    extends AbstractAppAddOn
    This add-on will change the search definition of the WebSearchObject of a SearchBean before the search is executed by a search event to ensure that only the list of supported-types are included as part of the search-results.
    This add-on will only work if the TypeRestriction property has been set with a comma separated list of integers representing the supported types. If this property is not set or is empty, it will not modify the search.
    MicroStrategy Web 9.0.0
    • Constructor Detail

      • SearchSupportedTypesAddon

        public SearchSupportedTypesAddon()
    • Method Detail

      • filterUnsupportedTypes

        protected void filterUnsupportedTypes​(SearchBean sb)
                                       throws java.lang.ClassCastException,
      • isTypeSupported

        protected boolean isTypeSupported​(int type)
      • isSearchEvent

        protected boolean isSearchEvent​(PageComponent page)
      • setTypeRestriction

        public void setTypeRestriction​(java.lang.String values)
        This method receives a comma separated list of the types that are supported by the application. The SearchBean will be modified to include in its results only objects of this type.
      • getAddOnDescription

        public java.lang.String getAddOnDescription()
        Description copied from interface: AppAddOns
        This method describes the tasks performed by the AddOn.
        The tasks which the Add On performs. This needs to be as descriptive as possible.