Information Console UserInfoBean class reference

Table 9-13 lists and describes the methods other than set methods available in the Information Console com.actuate.activeportal.beans.UserInfoBean class.

Table 9-13  UserInfoBean methods 

Method	Description
getAcLocale( )	Gets the AcLocale object specifying the Actuate locale for the current user.
getAdminRights( )	Gets the administrator rights of the current user. If the user is not an administrator or operator, this method returns null. An administrator or application sets these rights when creating a user.
getAuthid( )	Gets a String containing the authentication ID returned by the iServer for this user during login. Use this authentication ID in IDAPI calls.
getCurrentfolder( )	Gets a String containing the name of the most recent folder accessed by the user.
getDefaultAnalyticsExpLevel( )	Gets a string for the default Actuate Analytics experience level for this user. The level is Novice unless overridden on the options page or by calling setDefaultAnalyticsExpLevel( ).
getDefaultServerURL( )	Gets a string for the URL to use for the default server for the user.
getDefaultVolume( )	Gets the volume name from the VOLUME_DEFAULT tag in <context root>\WEB-INF\web.xml.
getFeatureOptionsBean( )	Gets a JavaBean that stores the features and iServer options that are available to the current user.
getFeatures( )	Gets a list of all features defined in the functionality-level.config file.
getFilter( )	Gets a String containing the filter the user most recently typed into the search field of the Documents page. If the user has not typed a filter, this method returns null.
getHomefolder( )	Gets a String specifying the user’s home folder. An administrator or application sets this value when creating a user.
getIportalid()	Gets a string specifying the Information Console session id.
getLocale( )	Gets the current login user’s java.util.Locale object.
getMaxJobPriority( )	Gets the maximum job priority permitted for this user. An administrator or application sets this value when creating a user.
getOnlylatest( )	Gets the String “true” if the filter on the Documents page specifies showing only the most recent version of each file.
getPassword( )	Gets a String containing the user’s password.
getProfile( )	Gets the ProfileBean. This JavaBean stores information about the user’s settings on the Information Console options page. This information includes current skin, view, experience level, and so on.
getProperty(java.lang.String name)	Gets a String containing the value of a custom property having the name passed as a parameter. Create custom properties and set their values using setProperty( ).
getRepositoryType()	Gets a string specifying the type of repository that the user is accessing as: workgroup: local file system enterprise: an Encyclopedia volume
getRoleNames( )	Gets an array of Strings containing a list of the user’s feature roles, such as Actuate Information Console Intermediate, Actuate Information Console Advanced, or Actuate Information Console Administrator.
getServerurl( )	Gets the URL of the server to which the current user is logged in. This URL includes the protocol and the port. For example: http://localhost:9000
getShowdocuments( )	Gets the String “true” if the filter on the Documents page specifies including documents.
getShowexecutables( )	Gets the String “true” if the filter on the Documents page specifies including executable files.
getShowfolders( )	Gets the String “true” if the filter on the Documents page specifies including folders.
getSideBarFeatures( )	Gets the list of features available to this user on the side menu, tabs, the tree, or equivalent structure. Some features, such as customization, are not part of this set.
getSidebarSelected( )	Gets the URL for the feature selected on the side menu, tab, tree, or equivalent structure. This method is used to highlight a feature in the sidebar.
getSkinConfig( )	Gets the SkinConfig object for the user’s current skin. The SkinConfig object contains all information defined for the skin.
getSkinName( )	Gets a String containing the name of the skin used by the user.
getSubfeatures( )	Gets a Collection containing a list of all subFeatures defined in <context root>\WEB-INF\functionality-level.config.
getSystemname( )	Gets a String containing the name of the iServer machine.
getTimezone( )	Gets the AcTimeZone object specifying the time zone for the current user.
getUserAgent( )	Gets the UserAgentBean object for the user. UserAgentBean detects the user’s browser type.
getUserid( )	Gets the userID of the current user.
getView( )	Gets the String specifying the current view for this user.
getVolume( )	Gets the String specifying the Encyclopedia volume that the user is accessing.
init( )	Initializes the UserInfoBean members.
isAlwaysGetFolderList( )	Returns True if the Documents page should always show the folder list, even if it is not selected on the filter.
isEanalysisOptionEnabled( )	Returns True if the Actuate e.Analysis option is enabled for the user.
isHomeFolderSet( )	Returns True if the user has a home folder specified in the Encyclopedia volume.
isShowFilters( )	Returns True if the filter panel is shown for all lists of documents, jobs, and channels.
isViewInNewBrowserWindow( )	Returns True if the report viewer is specified to launch in a new browser window.
toString( )	Returns a string representation of the object.

UserInfoBean calls set methods when the user logs in to set the values that the get methods return. Typically, your application should not call the set methods as the bean would then be inconsistent with the information stored in the repository or external security application. These set methods only change the values in the bean, so the results of the calls are not deterministic.

Table 9-14 lists and describes set methods that are available in the Information Console com.actuate.activeportal.beans.UserInfoBean class.

Table 9-14  UserInfoBean Set methods 

Method	Description
setAcLocale(com.actuate.reportcast.utils.AcLocale acLocale)	Sets the Actuate locale for the current user with the specified AcLocale object. Also changes the Java locale.
setAlwaysGetFolderList(boolean b)	Set to True if the Documents page should always show the folder list, even if it is not selected on the filter.
setAuthid(java.lang.String authid)	Sets the authentication ID to the String passed in as a parameter. The authentication ID is returned by the Actuate BIRT iServer and set for the user during login. Use getAuthid( ) to use this authentication ID in IDAPI calls.
setCurrentfolder(java.lang.String currentfolder)	Sets the String specifying the most recent folder name accessed by the user.
setDefaultAnalyticsExpLevel(java.lang.String analyticsExpLevel)	Sets the default Actuate Analytics experience level for this user. The level is Novice unless overridden on the options page or by calling this method.
setDefaultServerURL(java.lang.String defaultServerURL)	Sets the URL to use as a default value for users.
setDefaultVolume(java.lang.String defaultVolume)	Sets the volume to use if no volume name is specified by the URL in the request. By default, Information Console sets the default volume to the value in the VOLUME_DEFAULT tag in <context root>\WEB-INF\web.xml.
setFeatureOptions(FeatureOptionsBean featureOptionsBean)	Sets a list of all Information Console features and iServer options that are available to the current user.
setFilter(java.lang.String filter)	Sets the String specifying the filter to use as a default value in the Documents page. Information Console sets this String to the filter that the user most recently typed into the search field of the Documents page.
setHomefolder(java.lang.String string)	Sets the String specifying the user’s home folder.An administrator or application sets this value when creating a user.
setMaxJobPriority(int priority)	Sets the maximum job priority permitted for this user. An administrator sets this value for a user.
setOnlylatest(java.lang.String onlylatest)	Sets value to indicate if only latest version of the documents are to be displayed in the file folder list. “true” sets Information Console to show only the most recent version of each file.
setPassword(java.lang.String password)	Sets the password to the value of the String passed as a parameter.
setProfile( )	Sets the ProfileBean. This JavaBean stores information about the user’s settings on the Information Console options page. This information includes current skin, view, experience level, and so on.
setProperty(java.lang.String name, java.lang.String value)	Sets the value of a custom property. Create custom properties and set their values using this method. The parameters are the name of the custom property and the value to set.
setRoleNames(java.lang.String[] strings[])	Sets a list of the user’s feature roles, such as Active Portal Intermediate, Active Portal Advanced, or Active Portal Administrator.
setServerurl(java.lang.String surl)	Sets the server URL currently used by the user. This URL includes the protocol and the port, for example: http://localhost:9000.
setShowdocuments(java.lang.String showdocuments)	Sets the value to indicate if documents are to be displayed in the file folder list. “true” sets Information Console to display documents.
setShowexecutables(java.lang.String showexecutables)	Sets the value to indicate if executables are to be displayed in the file folder list. “true” sets Information Console to display executables.
setShowFilters(boolean showFilters)	Set to True to specify that Information Console display the filter panel for all pages showing lists of files, jobs, or channels.
setShowfolders(java.lang.String showfolders)	Sets the value to indicate if folders are to be displayed in the file folder list. “true” sets Information Console to display folders.
setSideBarFeatures(com.actuate.activeportal.functionality.config.Feature[] feature)	Sets the list of features available to this user on the side menu, tabs, the tree, or equivalent structure. This list is a subset of the features available to the user.
setSidebarSelected(java.lang.String sideBarSelected)	Sets the feature highlighted on the side menu, tab, tree, or equivalent structure. To highlight a feature, pass a String containing the URI invoked by the feature. To not highlight any features, pass a String, such as “No highlighting”, that does not match the URI for any feature in the side menu. By default, Information Console highlights the Documents feature.
setSkinConfig(com.actuate.activeportal.skin.SkinConfig config)	Sets the SkinConfig object for the user’s current skin. The SkinConfig object contains all information defined for the skin.
setSkinName(java.lang.String string)	Sets the name of the skin used by the user.
setSystemname(java.lang.String systemName)	Sets the iServer system name to the value of the String parameter.
setTimezone(com.actuate.reportcast.utils.AcTimeZone timezone)	Sets the AcTimeZone object specifying the user’s time zone.
setUserAgent(UserAgentBean userAgent)	Sets the UserAgentBean for this user. The UserAgentBean specifies the user’s browser type.
setUserid(java.lang.String userid)	Sets the user ID for the user.
setView(java.lang.String string)	Sets the current view for the user. The string contains the name of the constant for the desired view. The available constants are: n   AcConstants.VIEW_CATEGORY n   AcConstants.VIEW_LIST n   AcConstants.VIEW_DETAIL n   AcConstants.VIEW_ICON
setViewInNewBrowserWindow(boolean _newWindow)	Set to True to specify that the report viewer launch in a new browser window.
setVolume(java.lang.String volume)	Sets the value of the String specifying the name of the Encyclopedia volume the user is accessing.

 

(c) Copyright Actuate Corporation 2011