Class actuate.RequestOptions

RequestOptions contains attributes that describes a repository on a given iserver volume.
Member of: actuate.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.RequestOptions(requestOptions) The RequestOptions class contains attributes that describes a repository on a given iserver volume.

Field Summary
Field Attributes	Field Name and Description
<static> <constant>	REPOSITORY_ENCYCLOPEDIA Enterprise repository.
<static> <constant>	REPOSITORY_STANDALONE Workgroup repository.

Method Summary
Method Attributes	Method Name and Description
	getIServerUrl() Returns the IServer URL.
	getLocale() Returns the locale string or null if none has been set.
	getRepositoryType() Returns the repository type.
	getVolume() Returns the volume.
	getVolumeProfile() Returns the volumeProfile.
	setCustomParameters(parameters) Sets custom URL parameters.
	setIServerUrl(iServerUrl) Sets the IServer URL.
	setLocale(locale) Sets the locale string.
	setRepositoryType(repositoryType) Sets the repository type.
	setVolume(volume) Sets the volume.
	setVolumeProfile(volumeProfile) Sets the volume profile.

Class Detail

actuate.RequestOptions(requestOptions)

The RequestOptions class contains attributes that describes a repository on a given iserver volume. The attributes iServerUrl and volume are only used when the repository type is encyclopedia. In standalone mode they are ignored.

Parameters:
{actuate.RequestOptions} requestOptions: optional requestOptions to copy the values from.

Field Detail

<static> <constant> {String} REPOSITORY_ENCYCLOPEDIA

Enterprise repository.

<static> <constant> {String} REPOSITORY_STANDALONE

Workgroup repository.

Method Detail

{String} getIServerUrl()

Returns the IServer URL. This value is only used in for the REPOSITORY_ENCYCLOPEDIA repository type.

Returns:: {String} IServer URL

{String} getLocale()

Returns the locale string or null if none has been set.

Returns:: {String} locale string

{String} getRepositoryType()

Returns the repository type.

Returns:: {String} repository type

{String} getVolume()

Returns the volume. This value is only used in for the REPOSITORY_ENCYCLOPEDIA repository type.

Returns:: {String} volume

{String} getVolumeProfile()

Returns the volumeProfile.

Returns:: {String} volumeProfile

setCustomParameters(parameters)

Sets custom URL parameters.

Parameters:
{Map} parameters: map of custom URL parameters (map of string to string)

setIServerUrl(iServerUrl)

Sets the IServer URL. This value is only used in for the REPOSITORY_ENCYCLOPEDIA repository type.

Parameters:
{String} iServerUrl

setLocale(locale)

Sets the locale string.

Parameters:
{String} locale: string or null for default

setRepositoryType(repositoryType)

Sets the repository type.

Parameters:
{String} repositoryType

setVolume(volume)

Sets the volume. This value is only used in for the REPOSITORY_ENCYCLOPEDIA repository type.

Parameters:
{String} volume

setVolumeProfile(volumeProfile)

Sets the volume profile.

Parameters:
{String} volumeProfile

Classes

Class actuate.RequestOptions