Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
Global objects and functions (JavaScript™)
Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
bluemixContext (JavaScript)
Used to help in the development of XPages applications running on Bluemix. The bluemixContext global object is based on the Java™ class com.ibm.xsp.bluemix.util.context.BluemixContext and provides methods to retrieve information from the XPages runtime and connection information from any bound XPages NoSQL Database service.
getPlan (DataService - JavaScript™)
Read-only. Returns the Bluemix™ service plan information assigned to the application associated with the bound service.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
  - applicationScope (JavaScript)
    Allows you to share values across pages for the duration of an application.
  - bluemixContext (JavaScript)
    Used to help in the development of XPages applications running on Bluemix. The bluemixContext global object is based on the Java™ class com.ibm.xsp.bluemix.util.context.BluemixContext and provides methods to retrieve information from the XPages runtime and connection information from any bound XPages NoSQL Database service.
    - atHybridDbName (bluemixContext - JavaScript™)
      Read-only. For use with hybrid applications. Returns a Vector value that contains the address of your private Domino® server as the first element and the path to your database in the second element.
    - findHybridDatabaseName (bluemixContext - JavaScript™)
      Read-only. For use with hybrid applications. Returns a String value that can be passed to the databaseName property of XPages data sources. This value will be properly formatted to point a data source to a data NSF on the private Domino server of your hybrid environment.
    - getAPP_HOME_URL (bluemixContext - JavaScript™)
      Read-only. Returns the Home URL for the application.
    - getAPP_INCLUDE_XPAGES_TOOLBOX (bluemixContext - JavaScript™)
      Read-only. Returns "true" if the Bluemix application includes the XPages Toolbox.
    - getAPP_JVM_HEAPSIZE (bluemixContext - JavaScript™)
      Read-only. Returns the heapsize of the JVM running this application.
    - getAPP_PRELOAD_DB (bluemixContext - JavaScript™)
      Read-only. Returns the preload db environment variable.
    - getAPP_VERBOSE_STAGING (bluemixContext - JavaScript™)
      Read-only. Returns the verbose staging environment variable.
    - getBuildPackVersion (bluemixContext - JavaScript™)
      Read-only. Returns the XPages buildpack version number.
    - getDataService (bluemixContext - JavaScript™)
      Returns a DataService object representing a bound XPages NoSQL Database service.
    - getDataServiceByName (bluemixContext - JavaScript™)
      Returns a named DataService object representing a bound XPages NoSQL Database service.
    - isDataServiceByNameExists (bluemixContext - JavaScript™)
      Read-only. Returns true if this application is bound to a named XPages NoSQL Database Service.
    - isDataServiceExists (bluemixContext - JavaScript™)
      Read-only. Returns true if this application is bound to any XPages NoSQL Database Service.
    - isHybridApplication (bluemixContext - JavaScript™)
      Read-only. For use with hybrid applications. Returns true if this application has been configured as a hybrid Bluemix application.
    - isRunningOnBluemix (bluemixContext - JavaScript™)
      Read-only. Returns true if this XPages application is running in the Bluemix environment.
    - DataService (JavaScript™)
      Used to help in the development of XPages applications running on Bluemix™. The DataService object is based on the Java™ class com.ibm.xsp.bluemix.util.context.BluemixContext.DataService. This object provides methods to retrieve information about the bound XPages NoSQL Database Service from the VCAP_SERVICES environment.
    - atDbName (DataService - JavaScript™)
      Read-only. This method is intended to be used as a substitute for the @DbName() at-function. @DbName() and atDbName() are commonly used with the @DbLookup and @DbColumn at-functions.
    - findDatabaseName (DataService - JavaScript™)
      Read-only. Returns the database name associated with the bound service being queried.
    - getAppPath (DataService - JavaScript™)
      Read-only. Returns the application location path of the database associated with the bound service.
    - getCredentialsValue (DataService - JavaScript™)
      Read-only. Can be used as an alternative to return the same credential values as getAppPath(), getUserName(), and getPassword() and so on. The method looks directly at the "credentials" values found in the VCAP_SERVICES environment variable.
    - getHost (DataService - JavaScript™)
      Read-only. Returns the name of the host associated with the application using the bound service.
    - getLabel (DataService - JavaScript™)
      Read-only. Returns the label that was assigned to the application associated with the bound service.
    - getPlan (DataService - JavaScript™)
      Read-only. Returns the Bluemix™ service plan information assigned to the application associated with the bound service.
    - getRootDir (DataService - JavaScript™)
      Read-only. Returns the root directory information related to the application associated with the bound service.
    - getServerName (DataService - JavaScript™)
      Read-only. Returns the hosting server name information related to the application associated with the bound service.
    - getUserName (DataService - JavaScript™)
      Read-only. Returns the user name information related to the application associated with the bound service.
    - getValue (DataService - JavaScript™)
      Read-only. Can be used as an alternative to return the same values as getName(), getLabel(), and getPlan(). The method looks directly at the values in the VCAP_SERVICES environment variable.
  - requestScope (JavaScript)
    Allows you to share values across pages for the duration of a request.
  - sessionScope (JavaScript)
    Allows you to share values across pages for the duration of a session.
  - getComponent (Global objects and functions - JavaScript)
    Gets the base object for a UI component.
  - getLabelFor (Global objects and functions - JavaScript)
    Gets the base object for the label associated with a UI component.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the IBM® Domino® back-end.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

getPlan (DataService - JavaScript™)

Read-only. Returns the Bluemix™ service plan information assigned to the application associated with the bound service.

Defined in

Syntax

getPlan() : String

Usage

Use this method to write to the DataService object and have it return the Bluemix™ service plan information assigned to the application associated with the bound service.

Language cross-reference

getPlan method in Java™ DataService class.