6 Oracle Hyperion Load Module

This chapter provides a complete listing and reference for the methods in the OpenScript HyperionLoadService Class of Hyperion Load Module Application Programming Interface (API).

6.1 HyperionLoadService API Reference

The following section provides an alphabetical listing of the methods in the OpenScript HyperionLoadService API.

6.1.1 Alphabetical Command Listing

The following table lists the HyperionLoadService API methods in alphabetical order.

Table 6-1 List of HyperionLoadService Methods

Method	Description
hyperion.getAtSignEncoder	Gets an implementation class of IEncoder, providing an encode method of replacing '\n' to '@'.
hyperion.getBNToCRLFEncoder	Gets an implementation class of IEncoder, providing an encode method of replacing '\' plus '\n' to "\r\n".
hyperion.getBNToLFEncoder	Gets an implementation class of IEncoder, providing an encode method of replacing '\' plus '\n' to '\n'.
hyperion.getCRLFSEncoder	Gets an implementation class of IEncoder, providing an encode method of replacing '\n' to "\r\n*".
hyperion.getStarEncoder	Gets an implementation class of IEncoder, providing an encode method of replacing '\n' to '*'.

The following sections provide detailed reference information for each method and enum in the HyperionLoadService Class of Hyperion Load Module Application Programming Interface.

---

hyperion.getAtSignEncoder

Gets an implementation class of IEncoder, providing an encode method of replacing 'n' to '@'. Will be used to provide custom encode options.

Format

The hyperion.getAtSignEncoder method has the following command format(s):

hyperion.getAtSignEncoder( );

Returns

an implementation class of IEncoder, providing an encode method of replacing newlines to '@'.

Example

Performs an encode action replacing replacing newlines to '@'.

String str_withnewline = "test\nclassofIEcoder";
String str_line = "test\\nclassofIEcoder";
{
String str_getAtSign = hyperion.getAtSignEncoder().encode(str_withnewline);
String str_getAtSign1 = hyperion.getAtSignEncoder().encode(str_line);     * 
if (str_getAtSign.equals("test@classofIEcoder"))
   info("API getAtSignEncoder().encode() passed!");
else
   warn("API getAtSignEncoder().encode() failed!");
if (str_getAtSign1.equals("test\\nclassofIEcoder"))
   info("API getAtSignEncoder().encode() passed!");
else
   warn("API getAtSignEncoder().encode() failed!");
if (hyperion.getAtSignEncoder().getEncoderName().equals("getAtSignEncoder"))
   info("API getAtSignEncoder().getEncoderName() passed!");
else
   warn("API getAtSignEncoder().getEncoderName() failed!");
}

---

hyperion.getBNToCRLFEncoder

Gets an implementation class of IEncoder, providing an encode method of replacing '' plus 'n' to "rn". Will be used to provide custom encode options.

Format

The hyperion.getBNToCRLFEncoder method has the following command format(s):

hyperion.getBNToCRLFEncoder( );

Returns

an implementation class of IEncoder, providing an encode method of replacing '\' plus '\n' to "\r\n".

Example

Performs an encode action replacing replacing '' plus 'n' to "rn".

String str_withnewline = "test\nclassofIEcoder";
String str_line = "test\\nclassofIEcoder";
{
String getBNToCRLF = hyperion.getBNToCRLFEncoder().encode(str_withnewline);
String getBNToCRLF1 = hyperion.getBNToCRLFEncoder().encode(str_line);
if (getBNToCRLF.equals("test\nclassofIEcoder"))
   info("API getBNToCRLFEncoder().encode() passed!");
else
   warn("API getBNToCRLFEncoder().encode() failed!");
if (getBNToCRLF1.equals("test\r\nclassofIEcoder"))
   info("API getBNToCRLFEncoder().encode() passed!");
else
   warn("API getBNToCRLFEncoder().encode() failed!");
if (hyperion.getBNToCRLFEncoder().getEncoderName().equals("getBNToCRLFEncoder"))
   info("API getBNToCRLFEncoder().getEncoderName() passed!");
else
   warn("API getBNToCRLFEncoder().getEncoderName() failed!");
}

---

hyperion.getBNToLFEncoder

Gets an implementation class of IEncoder, providing an encode method of replacing '' plus 'n' to 'n'. Will be used to provide custom encode options.

Format

The hyperion.getBNToLFEncoder method has the following command format(s):

hyperion.getBNToLFEncoder( );

Returns

an implementation class of IEncoder, providing an encode method of replacing '\' plus '\n' to '\n'.

Example

Performs an encode action replacing replacing '' plus 'n' to 'n'.

String str_withnewline = "test\nclassofIEcoder";
String str_line = "test\\nclassofIEcoder";
{
String getBNToLF = hyperion.getBNToLFEncoder().encode(str_withnewline);
String getBNToLF1 = hyperion.getBNToLFEncoder().encode(str_line);
if (getBNToLF.equals("test\nclassofIEcoder"))
   info("API getBNToLFEncoder().encode() passed!");
else
   warn("API getBNToLFEncoder().encode() failed!");
if (getBNToLF1.equals("test\nclassofIEcoder"))
   info("API getBNToLFEncoder().encode() passed!");
else
   warn("API getBNToLFEncoder().encode() failed!");
if (hyperion.getBNToLFEncoder().getEncoderName().equals("getBNToLFEncoder"))
   info("API getBNToLFEncoder().getEncoderName() passed!");
else
   warn("API getBNToLFEncoder().getEncoderName() failed!");
}

---

hyperion.getCRLFSEncoder

Gets an implementation class of IEncoder, providing an encode method of replacing 'n' to "rn*". Will be used to provide custom encode options.

Format

The hyperion.getCRLFSEncoder method has the following command format(s):

hyperion.getCRLFSEncoder( );

Returns

an implementation class of IEncoder, providing an encode method of replacing '\n' to "\r\n*".

Example

Performs an encode action replacing replacing 'n' to "rn*".

String str_withnewline = "test\nclassofIEcoder";
String str_line = "test\\nclassofIEcoder";
{
String str_getCRLF = hyperion.getCRLFSEncoder().encode(str_withnewline);
String str_getCRLF1 = hyperion.getCRLFSEncoder().encode(str_line);
if (str_getCRLF.equals("test\r\n*classofIEcoder"))
   info("API getCRLFSEncoder().encode() passed!");
else
   warn("API getCRLFSEncoder().encode() failed!");
if (str_getCRLF1.equals("test\\nclassofIEcoder"))
   info("API getCRLFSEncoder().encode() passed!");
else
   warn("API getCRLFSEncoder().encode() failed!");
if (hyperion.getCRLFSEncoder().getEncoderName().equals("getCRLFSEncoder"))
   info("API getCRLFSEncoder().getEncoderName() passed!");
else
   warn("API getCRLFSEncoder().getEncoderName() failed!");
}

---

hyperion.getStarEncoder

Gets an implementation class of IEncoder, providing an encode method of replacing 'n' to '*'. Will be used to provide custom encode options.

Format

The hyperion.getStarEncoder method has the following command format(s):

hyperion.getStarEncoder( );

Returns

an implementation class of IEncoder, providing an encode method of replacing newlines to '*'.

Example

Performs an encode action replacing newlines to '*'

String str_withnewline = "test\nclassofIEcoder";
String str_line = "test\\nclassofIEcoder";
{
String str_getStar = hyperion.getStarEncoder().encode(str_withnewline);
String str_getStar1 = hyperion.getStarEncoder().encode(str_line);
if (str_getStar.equals("test*classofIEcoder"))
   info("API getStarEncoder().encode() passed!");
else
   warn("API getStarEncoder().encode() failed!");
if (str_getStar1.equals("test\\nclassofIEcoder"))
   info("API getStarEncoder().encode() passed!");
else
   warn("API getStarEncoder().encode() failed!");
if (hyperion.getStarEncoder().getEncoderName().equals("getStarEncoder"))
   info("API getStarEncoder().getEncoderName() passed!");
else
   warn("API getStarEncoder().getEncoderName() failed!");
}