public interface

WebFeatures

com.microstrategy.web.objects.WebFeatures
Known Indirect Subclasses

Class Overview

The WebFeatures interface can be used to determine whether a specific feature is available to the user.
A WebFeature is a generic term for a variety of preferences, privileges, settings, etc. that can be used to control the availability of functionality in MicroStrategy Web applications. Some general examples of Web Features include:

  • the current context of the application.
    Specific example:
    • Whether the browser supports HTML or not
    • Whether a certain preference is on or off
  • the current functionality available to the user
    Specific example:
    • Whether the user can access the history list, based on the user's privileges
    • Whether the user can view a particular report, based on the user's privileges
  • a specific setting for a specific object operation
    Specific example:
    • Whether a report is in outline mode
    • Whether grid headers are locked on a report
    • Whether the user can view a particular report, based on the user's privileges

The purpose of Web Features is to allow you to create conditional functionality, by basing the availability of functionality on whether a specific feature (or set of features) is true or false. In all cases, a Web Feature is either true or false.

Some examples of conditional functionality that can be associated with a Web Feature include:
  • whether a shortcut is displayed on a toolbar, is active, or is selected by default
  • whether a menu entry is displayed, is active, or is selected by default (checked)
  • whether a system-picker is displayed, is active, or is selected by default (checked)
  • whether a shortcut is part of a page template
  • whether a user has access to a page
  • whether a bean is instantiated in a request
  • whether a Web component is refreshed after an iFrame request
  • whether a property is assigned to a bean
  • whether a certain block of javascript is used in a page
  • what content is included in a JSP or ASP.NET file
  • what content is included in an XML layout file

Summary

Public Methods
abstract boolean isFeatureAvailable(String feature, Object dependencyObject)
Returns whether the given feature is available or not.
abstract boolean isFeatureAvailable(String feature)
Returns whether the given feature is available or not.

Public Methods

public abstract boolean isFeatureAvailable (String feature, Object dependencyObject)

Returns whether the given feature is available or not.

Parameters
feature The feature to check for, from EnumWebObjectsFeatures.
dependencyObject A dependency object which can be used as an additional parameter for certain feature types.
Returns
  • Whether the given feature is available.

public abstract boolean isFeatureAvailable (String feature)

Returns whether the given feature is available or not.

Parameters
feature The feature to check for, from EnumWebObjectsFeatures.
Returns
  • Whether the given feature is available.