com.actuate.activeportal.beans
Class UserInfoBean

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

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

This bean contains the current logged in user information such as authentication id, volume name, server url, etc. and user interface settings. It is initialized when a user logged in to ActivePortal and set as a request attribute with the key "userinfobean".

It can be accessed from a JSP page like this:
<jsp:useBean id="userinfobean"
class="com.actuate.activeportal.beans.UserInfoBean"
scope="request"/>
<%
String userid = userinfobean.getUserid();
%>

You can store your own user property using setProperty and getProperty methods which uses java.util.Properties to store properties.

User interface information:

See Also:
Serialized Form

Constructor Summary
UserInfoBean()
           
 
Method Summary
 com.actuate.common.util.AcLocale getAcLocale()
          Gets the actuate locale for the current logged in user.
 java.lang.String getAdminRights()
          Returns the administrator rights of the logged in user.
 java.lang.String getArchiveLibrary()
          This method can be used only in Management Console application Returns the name of the archive library
 java.lang.String getArchiveServiceCmd()
           
 java.lang.Object getAttribute(java.lang.String name)
          Get a custom attribute object
 java.lang.String getAuthid()
          Gets the authentication ID for IDAPI
 java.lang.String getCurrentfolder()
          Gets the last folder name accessed by the user
 java.lang.String getDefaultAnalyticsExpLevel()
          Returns the default analytics experience level for this user.
static java.lang.String getDefaultServerURL()
          Returns the defaultServerURL.
 java.lang.String getDefaultUserName()
          For internal use only.
static java.lang.String getDefaultVolume()
          Gets the volume name defined in web.xml file.
 java.lang.Boolean getEnableCustomEvent()
           
 java.lang.Long getEventLagTime()
           
 java.lang.Long getEventPollingDuration()
           
 java.lang.Long getEventPollingInterval()
           
 java.lang.String[] getExternalUserPropertyNames()
          This method is used only in management console ( As the external user property are available only in Management console) Returns the names of all the external user properties for the volume.
 FeatureOptionsBean getFeatureOptionsBean()
          Gets the FeatureOptionsBean
 com.actuate.activeportal.functionality.config.Feature[] getFeatures()
          Returns list of available Features defined in functionality-level.config file.
 java.lang.String getFilter()
          Returns the filter used in the file folder list content page.
 java.lang.String getHomefolder()
          Gets the user's home folder
 java.lang.String getIportalid()
          Gets the iPortal session ID
 com.actuate.iv.context.session.IVUserSession getIvUserSession()
          Get IV user session.
 java.util.Locale getLocale()
          Gets the current login user's java.util.Locale
 int getMaxJobPriority()
          Gets the maximum Job Priority defined for the current user.
 java.lang.String getMultivolumeParameter()
           
 java.lang.String getOnlylatest()
          Returns value indicating whether only latest version of files/folders are to be displayed in the file folder list page.
 java.lang.String getPassword()
          Gets the password
 ProfileBean getProfile()
          Gets the ProfileBean.
 java.lang.String getProperty(java.lang.String name)
          Get a custom property value
 java.lang.String getRepositoryType()
          Gets the repository type
 java.lang.String[] getRoleNames()
          Returns the list of feature rolenames to which the current user belongs.
 java.lang.String getServerurl()
          Gets the server URL to which the current user is logged in to.
 java.lang.String getShowdocuments()
          Returns whether documents are to be displayed the file folder list page.
 java.lang.String getShowexecutables()
          Returns whether executables are to be displayed in the file folde list page
 java.lang.String getShowfolders()
          Returns whether folders are to be displayed in the file folder list page
 com.actuate.activeportal.functionality.config.Feature[] getSideBarFeatures()
          Gets the list of Features available on the side bar.
 java.lang.String getSideBarSelected()
          Returns the URL mapping of the selected item in the side bar.
 com.actuate.activeportal.skin.SkinConfig getSkinConfig()
          Returns the Skin configuration that is used for the current user.
 java.lang.String getSkinName()
          Returns the name of the skin used for the user.
 java.util.Collection getSubfeatures()
          Returns list of subFeatures defined.
 java.lang.String getSystemname()
          gets the iServer system name.
 com.actuate.reportcast.utils.AcTimeZone getTimezone()
          Returns the user logged in timezone.
 java.util.Properties getUsageTerms()
          Return the usage terms properties for this login user.
 UserAgentBean getUserAgent()
          Returns the UserAgentBean
 java.lang.String getUserid()
          Gets the logged in user name
 java.lang.String getView()
          Returns the current view for this user
 java.lang.String getVolume()
          Gets the user logged in volume name
 com.actuate.schemas.Volume getVolumeProperty()
          Returns the properites of the current logged in volume This method can be used only in Management Console application
 void init(com.actuate.reportcast.utils.AcRequestHandlerBean requestHandlerBean)
          Initializes the UserInfoBean members.
 boolean isAlwaysGetFolderList()
          Returns if the Always get the folder list even if it is filtered.
 boolean isArchiveLibraryPresent()
          Checks whether the archive library is present or not.
 boolean isDefaultRepositoryType()
           
 boolean isDefaultServerUrl()
           
 boolean isDefaultVolume()
           
 boolean isEanalysisOptionEnabled()
          Returns true if the eAnalysis option is enabled.
 boolean isEnterpriseRepository()
           
 boolean isHomeFolderSet()
          Returns if the home folder is set for the current logged in user.
 boolean isMC()
          Determines whether the request originated from Management Console or not
 boolean isProfileInit()
          returns true if the user profile has already been retrieved from the encyclopedia volume
 boolean isShowFilters()
          Indicates whether the filter panel will be displayed.
 boolean isViewInNewBrowserWindow()
          A boolean indicating whether the viewer is launched in the same window or a new window
 void setAcLocale(com.actuate.common.util.AcLocale acLocale)
          Sets the actuate locale with the specified AcLocale object.
 void setAlwaysGetFolderList(boolean b)
          Set value to true, to indicate to always get the folder list even if it is filtered.
 void setArchiveLibrary(java.lang.String string)
          Sets the archive library name This method can be is used only in Management Console application.
 void setArchiveServiceCmd(java.lang.String string)
           
 void setAttribute(java.lang.String name, java.lang.Object attribute)
          Set a custom attribute object
 void setAuthid(java.lang.String authid)
          Sets the authentication ID for IDAPI
 void setCurrentfolder(java.lang.String currentfolder)
          Sets the current folder accessed by the user.
 void setDefaultAnalyticsExpLevel(java.lang.String analyticsExpLevel)
          This method is used to set the user's default analytics experience level
static void setDefaultServerURL(java.lang.String defaultServerURL)
          Sets the defaultServerURL.
 void setDefaultUserName(java.lang.String defaultUserName)
          For internal use only.
static void setDefaultVolume(java.lang.String defaultVolume)
          Sets the volume to be used, if no volume name is specified in the url.
 void setEnableCustomEvent(java.lang.Boolean bValue)
           
 void setEventLagTime(java.lang.Long nValue)
           
 void setEventPollingDuration(java.lang.Long nValue)
           
 void setEventPollingInterval(java.lang.Long nValue)
           
 void setExternalUserPropertyNames(java.lang.String[] externalUserPropertyNames)
          This method is used in management console.
 void setFeatureOptions(FeatureOptionsBean featureOptionsBean)
          Sets the FeatureOptionBean
 void setFilter(java.lang.String filter)
          Sets the filter to be used in the file folder list content page.
 void setHomefolder(java.lang.String string)
          Sets the user's home folder
 void setIportalid(java.lang.String isessionid)
          Sets the iPortal session ID
 void setIsMC(java.lang.String isMC)
          Tells iPortal that this request is originating from Management Console or not
 void setIsProfileInit(java.lang.String isProfileSet)
          Set's the userinfobean attribute isprofileinit.
 void setIvUserSession(com.actuate.iv.context.session.IVUserSession ivUserSession)
          Set IV user session.
 void setMaxJobPriority(int priority)
          Sets the maximum job priority for the current user.
 void setOnlylatest(java.lang.String onlylatest)
          Sets value to indicate if only latest version of the document are to displayed in the file folder list
 void setPassword(java.lang.String password)
          Sets the password
 void setProfile(ProfileBean bean)
          Sets the ProfileBean.
 void setProperty(java.lang.String name, java.lang.String value)
          Set a custom property value
 void setRepositoryType(java.lang.String type)
          Sets the repository type
 void setRoleNames(java.lang.String[] strings)
          Based on the list of rolenames to which the user belong it generates the FeatureOptionBean
 void setServerurl(java.lang.String surl)
          Sets the iServer URL, example http://localhost:8000
 void setShowdocuments(java.lang.String showdocuments)
          Sets value to indicate if the documents are to displayed in the file folder list
 void setShowexecutables(java.lang.String showexecutables)
          Sets value to indicate if the executables are to displayed in the file folder list
 void setShowFilters(boolean showFilters)
          This method is used to indicate whether the filter panel should be shown for all the list pages.
 void setShowfolders(java.lang.String showfolders)
          Sets value to indicate if folders to be displayed in the file folder list page
 void setSideBarFeatures(com.actuate.activeportal.functionality.config.Feature[] features)
          Sets the list of features available on the sidebar.
 void setSideBarSelected(java.lang.String sideBarSelected)
          Sets the url mapping of the selected item in the side bar.
 void setSkinConfig(com.actuate.activeportal.skin.SkinConfig config)
          Method to set the skin configuration that is to be used for the current user.
 void setSkinName(java.lang.String name)
           
 void setSkinName(java.lang.String string, boolean isPreview)
          Set the skin name to be used for the current user.
 void setSystemname(java.lang.String systemName)
          Sets the iServer system name
 void setTimezone(com.actuate.reportcast.utils.AcTimeZone timezone)
          Sets the timezone.
 void setUserAgent(UserAgentBean userAgent)
          Sets the UserAgentBean
 void setUserid(java.lang.String userid)
          Sets the logged in user name
 void setView(java.lang.String string)
          See AcConstants.VIEWS for the list
 void setViewInNewBrowserWindow(boolean _newWindow)
          This method is used to indicate whether the report viewer should be launched in a new window or in the same window
 void setVolume(java.lang.String volume)
          Sets the volume name
 void setVolumeProperty(com.actuate.schemas.Volume volumeProperty)
          Sets the volume information.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UserInfoBean

public UserInfoBean()
Method Detail

getUsageTerms

public java.util.Properties getUsageTerms()
Return the usage terms properties for this login user. If no watermark is applied, watermark type and watermark text will be null. The following constants are used for the returned properties StaticFuncs.LICENSE_TERMS_PROP_USAGETYPE = "usageType"; StaticFuncs.String LICENSE_TERMS_PROP_ISDEVELOPMENT = "isDevelopment"; StaticFuncs.LICENSE_TERMS_PROP_APPLYWATERMARK = "applyWatermark"; StaticFuncs.LICENSE_TERMS_PROP_WATERMARKTYPE = "waterMarkType"; StaticFuncs.LICENSE_TERMS_PROP_WATERMARKTEXT = "waterMarkText"; StaticFuncs.LICENSE_TERMS_PROP_WATERMARKSTYLES = "waterMarkStyles";

Returns:
Properties

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object attribute)
Set a custom attribute object

Parameters:
name - attribute name to be set
attribute - attribute to be set.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Get a custom attribute object

Parameters:
name - attribute name to get

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
Set a custom property value

Parameters:
name - property name to be set
value - value to be set.

getProperty

public java.lang.String getProperty(java.lang.String name)
Get a custom property value

Parameters:
name - property name to get

setIsProfileInit

public void setIsProfileInit(java.lang.String isProfileSet)
Set's the userinfobean attribute isprofileinit. Enterprise mode only supports storing profiles so this should only be set to true when the user profile is retreived from the encyclopedia volume for the first time. the login handler should be the one setting this so that we don't have to send multiple request to the server

Parameters:
isProfileSet -

isProfileInit

public boolean isProfileInit()
returns true if the user profile has already been retrieved from the encyclopedia volume

Returns:
true or false.

setAuthid

public void setAuthid(java.lang.String authid)
Sets the authentication ID for IDAPI


getAuthid

public java.lang.String getAuthid()
Gets the authentication ID for IDAPI


getIportalid

public java.lang.String getIportalid()
Gets the iPortal session ID

Returns:
the iportal id.

setIportalid

public void setIportalid(java.lang.String isessionid)
Sets the iPortal session ID


getRepositoryType

public java.lang.String getRepositoryType()
Gets the repository type

Returns:
the repository type.

setRepositoryType

public void setRepositoryType(java.lang.String type)
Sets the repository type


isEnterpriseRepository

public boolean isEnterpriseRepository()

isDefaultRepositoryType

public boolean isDefaultRepositoryType()

isMC

public boolean isMC()
Determines whether the request originated from Management Console or not

Returns:
true or false.

setIsMC

public void setIsMC(java.lang.String isMC)
Tells iPortal that this request is originating from Management Console or not

Parameters:
isMC -

getPassword

public java.lang.String getPassword()
Gets the password

Returns:
the password.

setPassword

public void setPassword(java.lang.String password)
Sets the password


getUserid

public java.lang.String getUserid()
Gets the logged in user name

Returns:
the user id.

setUserid

public void setUserid(java.lang.String userid)
Sets the logged in user name


setServerurl

public void setServerurl(java.lang.String surl)
Sets the iServer URL, example http://localhost:8000


getServerurl

public java.lang.String getServerurl()
Gets the server URL to which the current user is logged in to.

Returns:
the server url.

isDefaultServerUrl

public boolean isDefaultServerUrl()

setSystemname

public void setSystemname(java.lang.String systemName)
Sets the iServer system name


getSystemname

public java.lang.String getSystemname()
gets the iServer system name.

Returns:
the system name.

getCurrentfolder

public java.lang.String getCurrentfolder()
Gets the last folder name accessed by the user

Returns:
the current folder.

setCurrentfolder

public void setCurrentfolder(java.lang.String currentfolder)
Sets the current folder accessed by the user.


getHomefolder

public java.lang.String getHomefolder()
Gets the user's home folder

Returns:
the home folder.

setHomefolder

public void setHomefolder(java.lang.String string)
Sets the user's home folder


getLocale

public java.util.Locale getLocale()
Gets the current login user's java.util.Locale

Returns:
the locale.

getVolume

public java.lang.String getVolume()
Gets the user logged in volume name

Returns:
the volume.

setVolume

public void setVolume(java.lang.String volume)
Sets the volume name


getFilter

public java.lang.String getFilter()
Returns the filter used in the file folder list content page.

Returns:
the filter

isDefaultVolume

public boolean isDefaultVolume()

setFilter

public void setFilter(java.lang.String filter)
Sets the filter to be used in the file folder list content page.

Parameters:
filter - The filter to set

getSideBarSelected

public java.lang.String getSideBarSelected()
Returns the URL mapping of the selected item in the side bar. This is used for highlighting the sidebar item.

Returns:
the integer URL mapping of the selected side bar.

setSideBarSelected

public void setSideBarSelected(java.lang.String sideBarSelected)
Sets the url mapping of the selected item in the side bar.

Parameters:
sideBarSelected - The sideBarSelected to set

getAcLocale

public com.actuate.common.util.AcLocale getAcLocale()
Gets the actuate locale for the current logged in user.

Returns:
AcLocale

setAcLocale

public void setAcLocale(com.actuate.common.util.AcLocale acLocale)
Sets the actuate locale with the specified AcLocale object. Also changes the java locale

Parameters:
acLocale - The acLocale to set

getTimezone

public com.actuate.reportcast.utils.AcTimeZone getTimezone()
Returns the user logged in timezone.

Returns:
AcTimeZone

setTimezone

public void setTimezone(com.actuate.reportcast.utils.AcTimeZone timezone)
Sets the timezone.

Parameters:
timezone - The timezone to set

getDefaultServerURL

public static java.lang.String getDefaultServerURL()
Returns the defaultServerURL.

Returns:
the default server url.

getDefaultVolume

public static java.lang.String getDefaultVolume()
Gets the volume name defined in web.xml file. This volume name is used as the default volume name.

Returns:
the default volume.

setDefaultServerURL

public static void setDefaultServerURL(java.lang.String defaultServerURL)
Sets the defaultServerURL.

Parameters:
defaultServerURL - The defaultServerURL to set

setDefaultVolume

public static void setDefaultVolume(java.lang.String defaultVolume)
Sets the volume to be used, if no volume name is specified in the url.

Parameters:
defaultVolume - The default volume name to be set

getFeatureOptionsBean

public FeatureOptionsBean getFeatureOptionsBean()
Gets the FeatureOptionsBean

Returns:
the feature options bean.

setFeatureOptions

public void setFeatureOptions(FeatureOptionsBean featureOptionsBean)
Sets the FeatureOptionBean


isEanalysisOptionEnabled

public boolean isEanalysisOptionEnabled()
Returns true if the eAnalysis option is enabled.


getDefaultUserName

public java.lang.String getDefaultUserName()
For internal use only.


setDefaultUserName

public void setDefaultUserName(java.lang.String defaultUserName)
For internal use only.


getUserAgent

public UserAgentBean getUserAgent()
Returns the UserAgentBean

Returns:
UserAgent

setUserAgent

public void setUserAgent(UserAgentBean userAgent)
Sets the UserAgentBean

Parameters:
userAgent - The userAgent to set

isHomeFolderSet

public boolean isHomeFolderSet()
Returns if the home folder is set for the current logged in user.

Returns:
boolean

init

public void init(com.actuate.reportcast.utils.AcRequestHandlerBean requestHandlerBean)
Initializes the UserInfoBean members.


getSkinConfig

public com.actuate.activeportal.skin.SkinConfig getSkinConfig()
Returns the Skin configuration that is used for the current user. Skin Configuration contains all the information defined for that skin.


getSkinName

public java.lang.String getSkinName()
Returns the name of the skin used for the user.


setSkinName

public void setSkinName(java.lang.String name)

setSkinName

public void setSkinName(java.lang.String string,
                        boolean isPreview)
Set the skin name to be used for the current user. The skin configuration for the specified skin name is also correspondingly changed.

Parameters:
string -

getFeatures

public com.actuate.activeportal.functionality.config.Feature[] getFeatures()
Returns list of available Features defined in functionality-level.config file.


getSubfeatures

public java.util.Collection getSubfeatures()
Returns list of subFeatures defined.


getRoleNames

public java.lang.String[] getRoleNames()
Returns the list of feature rolenames to which the current user belongs.


getAdminRights

public java.lang.String getAdminRights()
Returns the administrator rights of the logged in user. Refer to ActuateAPI LoginResponse for more details


setRoleNames

public void setRoleNames(java.lang.String[] strings)
Based on the list of rolenames to which the user belong it generates the FeatureOptionBean

Parameters:
strings - list of role names

getView

public java.lang.String getView()
Returns the current view for this user

Returns:
The current view

setView

public void setView(java.lang.String string)
See AcConstants.VIEWS for the list

Parameters:
string - AcConstants.VIEW_CATEGORY AcConstants.VIEW_LIST AcConstants.VIEW_DETAIL AcConstants.VIEW_ICON

getSideBarFeatures

public com.actuate.activeportal.functionality.config.Feature[] getSideBarFeatures()
Gets the list of Features available on the side bar.


isAlwaysGetFolderList

public boolean isAlwaysGetFolderList()
Returns if the Always get the folder list even if it is filtered.


setAlwaysGetFolderList

public void setAlwaysGetFolderList(boolean b)
Set value to true, to indicate to always get the folder list even if it is filtered.


setShowFilters

public void setShowFilters(boolean showFilters)
This method is used to indicate whether the filter panel should be shown for all the list pages. If the value is true the filter panel will be displayed.

Parameters:
showFilters -

isShowFilters

public boolean isShowFilters()
Indicates whether the filter panel will be displayed.

Returns:
A boolean indicating that the filter panel will be displayed.

setViewInNewBrowserWindow

public void setViewInNewBrowserWindow(boolean _newWindow)
This method is used to indicate whether the report viewer should be launched in a new window or in the same window

Parameters:
_newWindow - (If this is true then the viewer is launched in a new window)

isViewInNewBrowserWindow

public boolean isViewInNewBrowserWindow()
A boolean indicating whether the viewer is launched in the same window or a new window

Returns:
A boolean indicating whether the viewer is launched in the same window or a new window

setSideBarFeatures

public void setSideBarFeatures(com.actuate.activeportal.functionality.config.Feature[] features)
Sets the list of features available on the sidebar.


setDefaultAnalyticsExpLevel

public void setDefaultAnalyticsExpLevel(java.lang.String analyticsExpLevel)
This method is used to set the user's default analytics experience level

Parameters:
analyticsExpLevel -

getDefaultAnalyticsExpLevel

public java.lang.String getDefaultAnalyticsExpLevel()
Returns the default analytics experience level for this user.

Returns:
A string indicating the user's default analytics experience level

getProfile

public ProfileBean getProfile()
Gets the ProfileBean.


setProfile

public void setProfile(ProfileBean bean)
Sets the ProfileBean.


setSkinConfig

public void setSkinConfig(com.actuate.activeportal.skin.SkinConfig config)
Method to set the skin configuration that is to be used for the current user.


getMaxJobPriority

public int getMaxJobPriority()
Gets the maximum Job Priority defined for the current user. The job priority is one of the user properties returned in the LoginResponse.


setMaxJobPriority

public void setMaxJobPriority(int priority)
Sets the maximum job priority for the current user.

Parameters:
priority - The maximum job priority

getVolumeProperty

public com.actuate.schemas.Volume getVolumeProperty()
Returns the properites of the current logged in volume This method can be used only in Management Console application

Returns:
Volume

setVolumeProperty

public void setVolumeProperty(com.actuate.schemas.Volume volumeProperty)
Sets the volume information. This method can be used only in Management Console application

Parameters:
volumeProperty - The volume properties for this user

getExternalUserPropertyNames

public java.lang.String[] getExternalUserPropertyNames()
This method is used only in management console ( As the external user property are available only in Management console) Returns the names of all the external user properties for the volume.

Returns:
String[]

setExternalUserPropertyNames

public void setExternalUserPropertyNames(java.lang.String[] externalUserPropertyNames)
This method is used in management console. Sets the externalUserPropertyNames.

Parameters:
externalUserPropertyNames - The externalUserPropertyNames to set

getOnlylatest

public java.lang.String getOnlylatest()
Returns value indicating whether only latest version of files/folders are to be displayed in the file folder list page.

Returns:
String value "true" or "false"

getShowdocuments

public java.lang.String getShowdocuments()
Returns whether documents are to be displayed the file folder list page.

Returns:
String value "true" or "false"

getShowexecutables

public java.lang.String getShowexecutables()
Returns whether executables are to be displayed in the file folde list page

Returns:
String value "true" or "false"

getShowfolders

public java.lang.String getShowfolders()
Returns whether folders are to be displayed in the file folder list page

Returns:
String value "true" or "false"

setOnlylatest

public void setOnlylatest(java.lang.String onlylatest)
Sets value to indicate if only latest version of the document are to displayed in the file folder list

Parameters:
onlylatest - value "true" or "false"

setShowdocuments

public void setShowdocuments(java.lang.String showdocuments)
Sets value to indicate if the documents are to displayed in the file folder list

Parameters:
showdocuments - value "true" or "false"

setShowexecutables

public void setShowexecutables(java.lang.String showexecutables)
Sets value to indicate if the executables are to displayed in the file folder list

Parameters:
showexecutables - value "true" or "false"

setShowfolders

public void setShowfolders(java.lang.String showfolders)
Sets value to indicate if folders to be displayed in the file folder list page

Parameters:
showfolders - value "true" or "false"

getMultivolumeParameter

public java.lang.String getMultivolumeParameter()

getArchiveLibrary

public java.lang.String getArchiveLibrary()
This method can be used only in Management Console application Returns the name of the archive library

Returns:
The archive library name

setArchiveLibrary

public void setArchiveLibrary(java.lang.String string)
Sets the archive library name This method can be is used only in Management Console application.

Parameters:
string - The archive library name

isArchiveLibraryPresent

public boolean isArchiveLibraryPresent()
Checks whether the archive library is present or not. This method can be is used only in Management Console application.

Returns:
true if the archive library is present, false otherwise.

getArchiveServiceCmd

public java.lang.String getArchiveServiceCmd()
Returns:
the archive service command.

setArchiveServiceCmd

public void setArchiveServiceCmd(java.lang.String string)
Parameters:
string -

getEventPollingInterval

public java.lang.Long getEventPollingInterval()
Returns:
the event polling interval.

setEventPollingInterval

public void setEventPollingInterval(java.lang.Long nValue)
Parameters:
nValue -

getEventPollingDuration

public java.lang.Long getEventPollingDuration()
Returns:
the event polling duration.

setEventPollingDuration

public void setEventPollingDuration(java.lang.Long nValue)
Parameters:
nValue -

getEventLagTime

public java.lang.Long getEventLagTime()
Returns:
the event lag time.

setEventLagTime

public void setEventLagTime(java.lang.Long nValue)
Parameters:
nValue -

getEnableCustomEvent

public java.lang.Boolean getEnableCustomEvent()
Returns:
the enable custom event value.

setEnableCustomEvent

public void setEnableCustomEvent(java.lang.Boolean bValue)
Parameters:
bValue -

getIvUserSession

public com.actuate.iv.context.session.IVUserSession getIvUserSession()
Get IV user session.

Returns:
the IV user session.

setIvUserSession

public void setIvUserSession(com.actuate.iv.context.session.IVUserSession ivUserSession)
Set IV user session.

Parameters:
ivUserSession -