com.actuate.activeportal.beans
Class FeatureOptionsBean

java.lang.Object
  extended by com.actuate.activeportal.beans.FeatureOptionsBean
All Implemented Interfaces:
java.io.Serializable

public class FeatureOptionsBean
extends java.lang.Object
implements java.io.Serializable

This bean contains the features available to the current logged in user. You can get this class from userinfobean using the getFeatureOptionsBean method. It contains both Active Portal features and Reporting features available to the current logged in server. The reporting feature bit constants are:

  • REPORTGENERATION_OPTION
  • SPREADHSHEETGENERATION_OPTION
  • PAGESECUREVIEWING_OPTION
  • EANALYSIS_OPTION
  • ACTUATEQUERY_OPTION

    See Also:
    Serialized Form

    Field Summary
    static int ACTUATEQUERY_OPTION
               
    static int BIRTINTERACTIVEVIEWER_OPTION
               
    static java.lang.String BIRTINTERACTIVEVIEWER_OPTION_STRING
               
    static int BIRTREPORT_OPTION
               
    static java.lang.String BIRTREPORT_OPTION_STRING
               
    static int BIRTREPORTSTUDIO_OPTION
               
    static java.lang.String BIRTREPORTSTUDIO_OPTION_STRING
               
    static int BUSINESSREPORT_OPTION
               
    static java.lang.String BUSINESSREPORT_OPTION_STRING
               
    static int EANALYSIS_OPTION
               
    static int PAGESECUREVIEWING_OPTION
               
    static int REPORTGENERATION_OPTION
               
    static int SPREADHSHEETGENERATION_OPTION
               
     
    Constructor Summary
    FeatureOptionsBean()
              Construct a new feature options bean with no features enabled.
    FeatureOptionsBean(java.lang.String[] featureOptions)
              Construct a new feature options bean with the server reporting options specified enabled.
     
    Method Summary
     boolean actuateQueryOptionEnabled()
              Returns whether Actuate Query is enabled on the server.
     boolean birtInterativeViewerOptionEnabled()
              Returns whether birt interactive viewer is enabled on the server
     boolean birtReportOptionEnabled()
              Returns whether birt report is enabled on the server
     boolean birtReportStudioOptionEnabled()
              Returns whether business report studio is enabled on the server
     boolean businessReportOptionEnabled()
              Returns whether business report is enabled on the server
     boolean eAnalysisOptionEnabled()
              Returns whether eanalysis is enabled on the server.
     java.lang.String getCustomizationLabelkey()
              Returns the message resource key that contains the text that is displayed for the customization label
     java.lang.String getCustomizationLink()
              Returns the link for customization feature.
     java.lang.String getSearchLabelkey()
              Returns the message resource key that contains the text for displaying the search link
     java.lang.String getSearchLink()
              Returns the link for search feature.
     boolean isChannelsFeature()
              Returns whether the current user has access to the channels page.
     boolean isCreateFolderSubfeature()
              Returns whether the current user is allowed to create folders
     boolean isCustomizeFeature()
              Returns whether the current user has the customization feature enabled.
     boolean isDeleteFileSubfeature()
              Returns whether the current user has the delete file feature enabled.
     boolean isDeleteFolderSubfeature()
              Returns whether the current user has the delete folder feature enabled.
     boolean isDocumentsFeature()
              Returns whether the current user has access to the documents page.
     boolean isJobPrioritySubfeature()
              Returns whether the current user has the job priority feature enabled.
     boolean isJobsFeature()
              Returns whether the current user has access to the jobs page.
     boolean isOptionEnabled(int featureOption)
              Checks to see if the specified feature is enabled on the report server.
     boolean isSearchFeature()
              Returns whether the current user is allowed to search for files in the encyclopedia.
     boolean isSelfNotificationWithAttachmentSubfeature()
              Returns whether the current user is allowed to change their self notification settings when submitting a job.
     boolean isShareFileSubfeature()
              Returns whether the current user is allowed to share files or folders
     boolean isSubscribeChannelSubfeature()
              Returns whether the current user can subscribe/unsubscribe to/from channels.
     boolean pageSecureViewingOptionEnabled()
              Returns whether page security is enabled on the server.
     boolean reportGenerationOptionEnabled()
              Returns whether report generation is enabled on the server.
     void setChannelsFeature(boolean b)
              Sets whether the current user is allowed access to the channels page.
     void setCreateFolderSubfeature(boolean b)
              Sets whether the current user has the ability to create folders
    static void setCustomizationLabelkey(java.lang.String string)
              Sets the message resource key that contains the text that is displayed for the customization label
    static void setCustomizationLink(java.lang.String string)
              Sets the link for customization feature.
     void setCustomizeFeature(boolean customizeFeature)
              Sets whether the current user has the customization feature enabled.
     void setDeleteFileSubfeature(boolean deleteFileSubfeature)
              Sets the current user has the delete file feature enabled.
     void setDeleteFolderSubfeature(boolean deleteFolderSubfeature)
              Sets the current user has the delete folder feature enabled.
     void setDocumentsFeature(boolean b)
              Sets whether the current user is allowed access to the documents page.
     void setJobPrioritySubfeature(boolean jobPrioritySubfeature)
              Sets whether the current user can change the job priority for jobs submitted
     void setJobsFeature(boolean b)
              Sets whether the current user is allowed access to the jobs page.
     void setSearchFeature(boolean searchFeature)
              Sets whether the current user can perform a search on the encyclopedia.
    static void setSearchLabelkey(java.lang.String string)
              Sets the message resource key that contains the text for displaying the search link
    static void setSearchLink(java.lang.String string)
              Sets the link for search feature.
     void setSelfNotificationWithAttachmentSubfeature(boolean selfNotificationWithAttachmentSubfeature)
              Sets whether the current user can change the self notification settings wheile submitting a job.
     void setShareFileSubfeature(boolean shareFileSubfeature)
              Sets whether the current user can share files or folders
     void setSubscribeChannelSubfeature(boolean subscribeChannelSubfeature)
              Sets whether the current user can subscribe/unsubscribe to/from channels
     boolean spreadsheetGenerationOptionEnabled()
              Returns whether spreadsheet report generation is enabled on the server.
     
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Field Detail

    REPORTGENERATION_OPTION

    public static final int REPORTGENERATION_OPTION
    See Also:
    Constant Field Values

    SPREADHSHEETGENERATION_OPTION

    public static final int SPREADHSHEETGENERATION_OPTION
    See Also:
    Constant Field Values

    PAGESECUREVIEWING_OPTION

    public static final int PAGESECUREVIEWING_OPTION
    See Also:
    Constant Field Values

    EANALYSIS_OPTION

    public static final int EANALYSIS_OPTION
    See Also:
    Constant Field Values

    ACTUATEQUERY_OPTION

    public static final int ACTUATEQUERY_OPTION
    See Also:
    Constant Field Values

    BIRTREPORT_OPTION

    public static final int BIRTREPORT_OPTION
    See Also:
    Constant Field Values

    BUSINESSREPORT_OPTION

    public static final int BUSINESSREPORT_OPTION
    See Also:
    Constant Field Values

    BIRTINTERACTIVEVIEWER_OPTION

    public static final int BIRTINTERACTIVEVIEWER_OPTION
    See Also:
    Constant Field Values

    BIRTREPORTSTUDIO_OPTION

    public static final int BIRTREPORTSTUDIO_OPTION
    See Also:
    Constant Field Values

    BIRTREPORT_OPTION_STRING

    public static final java.lang.String BIRTREPORT_OPTION_STRING
    See Also:
    Constant Field Values

    BUSINESSREPORT_OPTION_STRING

    public static final java.lang.String BUSINESSREPORT_OPTION_STRING
    See Also:
    Constant Field Values

    BIRTREPORTSTUDIO_OPTION_STRING

    public static final java.lang.String BIRTREPORTSTUDIO_OPTION_STRING
    See Also:
    Constant Field Values

    BIRTINTERACTIVEVIEWER_OPTION_STRING

    public static final java.lang.String BIRTINTERACTIVEVIEWER_OPTION_STRING
    See Also:
    Constant Field Values
    Constructor Detail

    FeatureOptionsBean

    public FeatureOptionsBean()
    Construct a new feature options bean with no features enabled.


    FeatureOptionsBean

    public FeatureOptionsBean(java.lang.String[] featureOptions)
    Construct a new feature options bean with the server reporting options specified enabled.

    Parameters:
    featureOptions -
    Method Detail

    isOptionEnabled

    public boolean isOptionEnabled(int featureOption)
    Checks to see if the specified feature is enabled on the report server.

    Parameters:
    featureOption - the reporting feature bit constant
    Returns:
    true if the feature is enabled, false otherwise

    reportGenerationOptionEnabled

    public boolean reportGenerationOptionEnabled()
    Returns whether report generation is enabled on the server.

    Returns:
    true if report generateion is enabled.

    spreadsheetGenerationOptionEnabled

    public boolean spreadsheetGenerationOptionEnabled()
    Returns whether spreadsheet report generation is enabled on the server.

    Returns:
    true if spreadsheet report generation is enabled.

    pageSecureViewingOptionEnabled

    public boolean pageSecureViewingOptionEnabled()
    Returns whether page security is enabled on the server.

    Returns:
    true if page security is supported .

    eAnalysisOptionEnabled

    public boolean eAnalysisOptionEnabled()
    Returns whether eanalysis is enabled on the server.

    Returns:
    true if eanalysis is enabled.

    actuateQueryOptionEnabled

    public boolean actuateQueryOptionEnabled()
    Returns whether Actuate Query is enabled on the server.

    Returns:
    true if Actuate Query is enabled.

    birtReportOptionEnabled

    public boolean birtReportOptionEnabled()
    Returns whether birt report is enabled on the server

    Returns:
    true if birt report is enabled.

    businessReportOptionEnabled

    public boolean businessReportOptionEnabled()
    Returns whether business report is enabled on the server

    Returns:
    true if business report is enabled.

    birtReportStudioOptionEnabled

    public boolean birtReportStudioOptionEnabled()
    Returns whether business report studio is enabled on the server

    Returns:
    true if business report studio is enabled.

    birtInterativeViewerOptionEnabled

    public boolean birtInterativeViewerOptionEnabled()
    Returns whether birt interactive viewer is enabled on the server

    Returns:
    true if birt interactive viewer is enabled.

    isCustomizeFeature

    public boolean isCustomizeFeature()
    Returns whether the current user has the customization feature enabled.

    Returns:
    true if the customization feature is enabled

    setCustomizeFeature

    public void setCustomizeFeature(boolean customizeFeature)
    Sets whether the current user has the customization feature enabled.

    Parameters:
    customizeFeature - true if customization is enabled, false otherwise

    isDeleteFileSubfeature

    public boolean isDeleteFileSubfeature()
    Returns whether the current user has the delete file feature enabled.

    Returns:
    true if the current user is allowed to delete files

    setDeleteFileSubfeature

    public void setDeleteFileSubfeature(boolean deleteFileSubfeature)
    Sets the current user has the delete file feature enabled.

    Parameters:
    deleteFileSubfeature - true if the user is allowed to delete files

    isDeleteFolderSubfeature

    public boolean isDeleteFolderSubfeature()
    Returns whether the current user has the delete folder feature enabled.

    Returns:
    true if the user can delete a folder

    setDeleteFolderSubfeature

    public void setDeleteFolderSubfeature(boolean deleteFolderSubfeature)
    Sets the current user has the delete folder feature enabled.

    Parameters:
    deleteFolderSubfeature - true if the user is allowed to delete folders

    isJobPrioritySubfeature

    public boolean isJobPrioritySubfeature()
    Returns whether the current user has the job priority feature enabled.

    Returns:
    true if the user can change the job priority

    setJobPrioritySubfeature

    public void setJobPrioritySubfeature(boolean jobPrioritySubfeature)
    Sets whether the current user can change the job priority for jobs submitted

    Parameters:
    jobPrioritySubfeature - true if the user is allowed to change the priority

    isSearchFeature

    public boolean isSearchFeature()
    Returns whether the current user is allowed to search for files in the encyclopedia.

    Returns:
    true if the user can perform a search

    setSearchFeature

    public void setSearchFeature(boolean searchFeature)
    Sets whether the current user can perform a search on the encyclopedia.

    Parameters:
    searchFeature - true if the user can perform a search

    isSelfNotificationWithAttachmentSubfeature

    public boolean isSelfNotificationWithAttachmentSubfeature()
    Returns whether the current user is allowed to change their self notification settings when submitting a job.

    Returns:
    true if the user can change the notification settings.

    setSelfNotificationWithAttachmentSubfeature

    public void setSelfNotificationWithAttachmentSubfeature(boolean selfNotificationWithAttachmentSubfeature)
    Sets whether the current user can change the self notification settings wheile submitting a job.

    Parameters:
    selfNotificationWithAttachmentSubfeature - true if the user can change the notification settings

    isShareFileSubfeature

    public boolean isShareFileSubfeature()
    Returns whether the current user is allowed to share files or folders

    Returns:
    true if the current user can share files

    setShareFileSubfeature

    public void setShareFileSubfeature(boolean shareFileSubfeature)
    Sets whether the current user can share files or folders

    Parameters:
    shareFileSubfeature - true if the current user can share files.

    isSubscribeChannelSubfeature

    public boolean isSubscribeChannelSubfeature()
    Returns whether the current user can subscribe/unsubscribe to/from channels.

    Returns:
    true if the user can subscribe/unsubscribe

    setSubscribeChannelSubfeature

    public void setSubscribeChannelSubfeature(boolean subscribeChannelSubfeature)
    Sets whether the current user can subscribe/unsubscribe to/from channels

    Parameters:
    subscribeChannelSubfeature - true if the user can subscribe/unsubscribe

    isCreateFolderSubfeature

    public boolean isCreateFolderSubfeature()
    Returns whether the current user is allowed to create folders

    Returns:
    true if the current user can create folders

    setCreateFolderSubfeature

    public void setCreateFolderSubfeature(boolean b)
    Sets whether the current user has the ability to create folders

    Parameters:
    b - true if the user is allowed to create folders

    isChannelsFeature

    public boolean isChannelsFeature()
    Returns whether the current user has access to the channels page.

    Returns:
    true if the current user can access the channels page

    isDocumentsFeature

    public boolean isDocumentsFeature()
    Returns whether the current user has access to the documents page.

    Returns:
    true if the current user has access to the documents page

    isJobsFeature

    public boolean isJobsFeature()
    Returns whether the current user has access to the jobs page.

    Returns:
    true if the current user has access to the jobs page.

    setChannelsFeature

    public void setChannelsFeature(boolean b)
    Sets whether the current user is allowed access to the channels page.

    Parameters:
    b - true if the user is allowed access

    setDocumentsFeature

    public void setDocumentsFeature(boolean b)
    Sets whether the current user is allowed access to the documents page.

    Parameters:
    b - true if the user is allowed access

    setJobsFeature

    public void setJobsFeature(boolean b)
    Sets whether the current user is allowed access to the jobs page.

    Parameters:
    b - true if the user is allowed access

    getCustomizationLink

    public java.lang.String getCustomizationLink()
    Returns the link for customization feature. The customization link is static.

    Returns:
    The customization link

    setCustomizationLink

    public static void setCustomizationLink(java.lang.String string)
    Sets the link for customization feature. The customization link is static.

    Parameters:
    string - The customization link

    getCustomizationLabelkey

    public java.lang.String getCustomizationLabelkey()
    Returns the message resource key that contains the text that is displayed for the customization label

    Returns:
    Message resource key for customization label

    setCustomizationLabelkey

    public static void setCustomizationLabelkey(java.lang.String string)
    Sets the message resource key that contains the text that is displayed for the customization label

    Parameters:
    string - The message resource key name

    getSearchLink

    public java.lang.String getSearchLink()
    Returns the link for search feature. The search link is static.

    Returns:
    The search link

    setSearchLink

    public static void setSearchLink(java.lang.String string)
    Sets the link for search feature. The search link is static.

    Parameters:
    string - The search link

    getSearchLabelkey

    public java.lang.String getSearchLabelkey()
    Returns the message resource key that contains the text for displaying the search link

    Returns:
    The message resource key for the search link

    setSearchLabelkey

    public static void setSearchLabelkey(java.lang.String string)
    Sets the message resource key that contains the text for displaying the search link

    Parameters:
    string - The search label resource key.