Environment

Last updated
Save as PDF

Environment

The Environment class is an implementation of the IEnvironment interface.

Implements

pentaho.environment.IEnvironment

Constructor

Name	Description
new Environment(spec, defaultSpec) Static	Creates an environment given its specification.

Members

Name	Description
application : `nonEmptyString`	Gets the identifier of the client application.
locale : `nonEmptyString`	Gets the identifier of the locale.
reservedChars : `nonEmptyString`	Gets the reserved characters for file names, all concatenated in a single string.
server : `pentaho.environment.IServer`	Gets information about the server web application.
theme : `nonEmptyString`	Gets the identifier of the theme.
user : `pentaho.environment.IUser`	Gets information about the user.

Methods

Name	Description
createChild(childSpec) : `pentaho.environment.IEnvironment`	Creates a child context of this one given its specification. Any unspecified information is inherited from this context.
toSpec() : `pentaho.environment.spec.IEnvironment`	Creates a specification with the information of this context.

Constructor Details

new Environment(spec, defaultSpec)

Static

Creates an environment given its specification.

Any absent or undefined-valued properties assume the values of the given default specification, if any, or null, if none.

Source: javascript/web/pentaho/environment/impl/Environment.js, line 44

Parameters:
Name	Default Value	Summary
spec : `pentaho.environment.spec.IEnvironment` Optional		The environment specification.
defaultSpec : `pentaho.environment.spec.IEnvironment` Optional		The environment specification from which unspecified or `undefined` `spec` properties are initialized.

Members Details

Implements:

pentaho.environment.IEnvironment#application

application: `nonEmptyString`
Gets the identifier of the client application. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 34

application: nonEmptyString

Gets the identifier of the client application.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 34

Implements:

pentaho.environment.IEnvironment#locale

locale: `nonEmptyString`
Gets the identifier of the locale. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 70

locale: nonEmptyString

Gets the identifier of the locale.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 70

Implements:

pentaho.environment.IEnvironment#reservedChars

reservedChars: `nonEmptyString`
Gets the reserved characters for file names, all concatenated in a single string. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 79

reservedChars: nonEmptyString

Gets the reserved characters for file names, all concatenated in a single string.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 79

Implements:

pentaho.environment.IEnvironment#server

server: `pentaho.environment.IServer`
Gets information about the server web application. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 52

server: pentaho.environment.IServer

Gets information about the server web application.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 52

Implements:

pentaho.environment.IEnvironment#theme

theme: `nonEmptyString`
Gets the identifier of the theme. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 61

theme: nonEmptyString

Gets the identifier of the theme.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 61

Implements:

pentaho.environment.IEnvironment#user

user: `pentaho.environment.IUser`
Gets information about the user. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 43

user: pentaho.environment.IUser

Gets information about the user.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 43

Methods Details

Implements:

pentaho.environment.IEnvironment#createChild

createChild(childSpec) : `pentaho.environment.IEnvironment`
Creates a child context of this one given its specification. Any unspecified information is inherited from this context. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 88

createChild(childSpec) : pentaho.environment.IEnvironment

Creates a child context of this one given its specification. Any unspecified information is inherited from this context.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 88

Parameters:
Name	Default Value	Summary
childSpec : `pentaho.environment.spec.IEnvironment` Optional		The child context specification.

Returns:
Name	Description
`pentaho.environment.IEnvironment`	The child context.

Implements:

pentaho.environment.IEnvironment#toSpec

toSpec() : `pentaho.environment.spec.IEnvironment`
Creates a specification with the information of this context. Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 99

toSpec() : pentaho.environment.spec.IEnvironment

Creates a specification with the information of this context.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 99

Returns:
Name	Description
`pentaho.environment.spec.IEnvironment`	The context specification.