Follow the links below to browse sample Javadoc for MJ classes and tools, including the MJ Runtime Library.
The rw package contains constants, and interfaces and factories for run-time contexts,
that provide equivalents to MAPPER reserved words in an MJ application.
| Classes and Interfaces | |
| IMJCallerCtxFactory | Abstract factory for obtaining caller context, which defines equivalent methods for MAPPER reserved words related to originating RUN. |
| IMJCdrCtxFactory | Abstract factory for obtaining CDR context, which defines equivalent methods for MAPPER reserved words related to related to cabinets, drawers and reports (or results). |
| IMJDisplayCtxFactory | Abstract factory for obtaining display context, which defines equivalent methods for MAPPER reserved words related to cursor position and special display characters. |
| IMJGraphicsCtxFactory | Abstract factory for obtaining graphics context, which defines equivalent methods for MAPPER reserved words related to graphics and graphical user interface (GUI). |
| IMJLegacyDBCtxFactory | Abstract factory for obtaining DB context, which defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER) data such as sites and databases. |
| IMJLegacyDTMCtxFactory | Abstract factory for obtaining DTM context, which defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER) Data Transfer Module. |
| IMJLegacyEnvCtxFactory | Abstract factory for obtaining environment context, which defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER) execution environment and resources. |
| IMJLegacyOutputCtxFactory | Abstract factory for obtaining legacy output context, which defines equivalent methods for MAPPER reserved words related to things like printers. |
| IMJLegacySecurityCtxFactory | Abstract factory for obtaining security context, which defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER OS2200) credentials and security. |
| IMJUserAgentCtxFactory | Abstract factory for obtaining caller context, which defines equivalent methods for MAPPER reserved words related to client workstation (also known as user agent). |
| IMJUserCtxFactory | Abstract factory for obtaining caller context, which defines equivalent methods for MAPPER reserved words related to identity of user. |
| MJCallerCtx | Defines equivalent methods for MAPPER reserved words related to originating RUN, or, in other words, the caller of the currently executing program. |
| MJCdrCtx | Defines equivalent methods for MAPPER reserved words related to cabinets, drawers and reports (or results). |
| MJCurrentDate | Current date as MJDate instances associated with various MAPPER date formats,
providing equivalent methods for MAPPER reserved words related to date and time. |
| MJCurrentTime | Current time as MJDate instances associated with various MAPPER time formats,
providing equivalent methods for MAPPER reserved words related to time. |
| MJDisplayCtx | Defines equivalent methods for MAPPER reserved words related to cursor position and special display characters. |
| MJGraphicsCtx | Defines equivalent methods for MAPPER reserved words related to graphics and graphical user interface (GUI). |
| MJLegacyDBCtx | Defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER) data such as sites and databases. |
| MJLegacyDTMCtx | Defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER) Data Transfer Module. |
| MJLegacyEnvCtx | Defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER) execution environment and resources. |
| MJLegacyOutputCtx | Defines equivalent methods for MAPPER reserved words related to legacy output (printers, for example). |
| MJLegacySecurityCtx | Defines equivalent methods for MAPPER reserved words related to legacy (i.e., MAPPER OS2200) credentials and security. |
| MJSpecialChars | Defines constants for characters that are special to MAPPER. |
| MJUserAgentCtx | Defines equivalent methods for MAPPER reserved words related to client workstation (in other words, the user agent). |
| MJUserCtx | Defines equivalent methods for MAPPER reserved words related to identity of user associated with the currently executing program. |
public interface com.arsi.mj.rw.IMJCallerCtxFactory
| Methods |
Get context related to caller of the currently executing program.
public com.arsi.mj.rw.MJCallerCtx callerContext()
|
public interface com.arsi.mj.rw.IMJCdrCtxFactory
| Methods |
Get context related to cabinets, drawers and reports (or results).
public com.arsi.mj.rw.MJCdrCtx cdrContext()
|
public interface com.arsi.mj.rw.IMJDisplayCtxFactory
| Methods |
Get context related to the display.
public com.arsi.mj.rw.MJDisplayCtx displayContext()
|
public interface com.arsi.mj.rw.IMJGraphicsCtxFactory
| Methods |
Get context related to graphics.
public com.arsi.mj.rw.MJGraphicsCtx graphicsContext()
|
public interface com.arsi.mj.rw.IMJLegacyDBCtxFactory
| Methods |
Get context related to legacy sites and databases.
public com.arsi.mj.rw.MJLegacyDBCtx dbContext()
|
public interface com.arsi.mj.rw.IMJLegacyDTMCtxFactory
| Methods |
Get context related to legacy Data Transfer Module.
public com.arsi.mj.rw.MJLegacyDTMCtx dtmContext()
|
public interface com.arsi.mj.rw.IMJLegacyEnvCtxFactory
| Methods |
Get context related to legacy execution environment and resources.
public com.arsi.mj.rw.MJLegacyEnvCtx envContext()
|
public interface com.arsi.mj.rw.IMJLegacyOutputCtxFactory
| Methods |
Get context related to legacy output.
public com.arsi.mj.rw.MJLegacyOutputCtx callerContext()
|
public interface com.arsi.mj.rw.IMJLegacySecurityCtxFactory
| Methods |
Get context related to legacy credentials and security.
public com.arsi.mj.rw.MJLegacySecurityCtx callerContext()
|
public interface com.arsi.mj.rw.IMJUserAgentCtxFactory
| Methods |
Get context related to client workstation (i.e., user agent).
public com.arsi.mj.rw.MJUserAgentCtx uaContext()
|
public interface com.arsi.mj.rw.IMJUserCtxFactory
| Methods |
Get context related to identity of user associated with the currently
executing program.
public com.arsi.mj.rw.MJUserCtx userContext()
|
public interface com.arsi.mj.rw.MJCallerCtx
| Methods |
Originating station number of a background script (in other words, the
logical station number assigned to the currently executing, background
program).
public int backgroundStationID()
|
Script started in the batch port.
public boolean BPORT()
|
Originating user's department sign-on number (in other words, the
department associated with the program that invoked the currently executing
program). If the script is not executing in a network environment, the value
of ODEPN$ is the same as DEPN$.
public int callerDeptNumeric()
|
Originating name of the script executing (in other words, the name of
program that invoked the currently executing program). If blank, a network
session was opened on-demand by the user. If the program is not executing
in a network environment, the value of ORUN$ is the same as RUN$.
public java.lang.String callerName()
|
Originating name or ID of the current site (in other words, the node,
server or instance of the program that invoked the currently executing
program). If the script is not executing in a network environment, the
value of OSITE$ is the same as SITE$.
public java.lang.String callerNode()
|
Originating port identification name (in other words, identity of remote caller).
If blank, this program cannot access information about remote caller and may not
be able to rely on other, related reserved words (such as OSITE$ or OUSER$).
public java.lang.String callerRemoteID()
|
Originating station number executing the script (in other words, the
logical station number of the program that invoked the currently executing
program). If zero, access was initially gained using a transient type
station, such as a background, batch port, or negative station. If the
station is not a transient type station, and if the script is not executing
in a network environment, the value of OSTNUM$ is the same as STNUM$.
public int callerStationID()
|
Originating user-id of the user who started the script (in other words, the
user associated with the program that invoked the currently executing
program). If the script is not executing in a network environment, the value
of OUSER$ is the same as USER$.
public java.lang.String callerUser()
|
Originating user's department sign-on number.
public int ODEPN()
|
Originating station number of a background script.
public int ORSTAN()
|
Originating name of the script executing.
public int ORUN()
|
Originating name or ID of the current site.
public int OSITE()
|
Originating station number executing the script.
public int OSTNUM()
|
Originating port identification name.
public int OSYSNAM()
|
Originating user-id of the user who started the script.
public java.lang.String OUSER()
|
Script started in the batch port (indicates if the currently executing
program is running in the background).
public boolean wasInvokedAsBackground()
|
public interface com.arsi.mj.rw.MJCdrCtx
| Methods |
Alphabetic drawer of the run control report issuing the external Run Subroutine (RSR) statement.
public java.lang.String ACDRW()
|
Alphabetic drawer of the current result.
public java.lang.String ADRW()
|
Alphabetic drawer of the specified result number.
public java.lang.String ADRW(int aResult)
|
Alphabetic drawer of the run control report (in other words, currently running program).
public java.lang.String AEDRW()
|
Alphabetic drawer of the failing script.
public java.lang.String AXDRW()
|
Cabinet number of the report or result last processed.
public int CAB()
|
Currently active cabinet number.
public int CAB1()
|
Currently active cabinet number.
public int cabinetActive()
|
Site's primary (default) language cabinet number.
public int cabinetDefaultLocale()
|
Current form cabinet number.
public int cabinetForm()
|
Cabinet number of the report or result last processed, or cabinet
number of the report or result on display when the script started,
or zero if no report or result was processed or on display.
public int cabinetLastProcessed()
|
Cabinet number of user's currently selected language (i.e., Locale).
public int cabinetLocale()
|
Cabinet number of the run control report (in other words, currently
running program).
public int cabinetRunning()
|
Drawer number of the run control report issuing the Run Subroutine (RSR) statement
to start an external subroutine.
public int CDRW()
|
Number of characters per line in the drawer of the current result.
public int CHAR()
|
Report number of the run control report issuing the external Run Subroutine (RSR) statement.
public int CRPT()
|
Alphabetic drawer of the run control report issuing the external Run
Subroutine (RSR) statement. In other words, drawer letter of the calling
program.
public java.lang.String drawerCaller()
|
Drawer number of the run control report issuing the Run Subroutine (RSR) statement
to start an external subroutine (returns zero if the statement starts an internal
subroutine). In other words, drawer number of the calling program.
public int drawerCallerNumeric()
|
Alphabetic drawer of the failing script (in other words, program in error).
public java.lang.String drawerFailing()
|
Drawer number of the Screen Control form on display.
public int drawerFormNumeric()
|
Drawer (form type) number of free form drawer A.
public int drawerFreeFormNumeric()
|
Drawer number of the System Library Routines.
public int drawerLibraryNumeric()
|
Number of characters per line in the drawer of the current result.
public int drawerLineSize()
|
Drawer number of the script that issued the LNK statement. In other words, drawer
number of the program that invoked the currently running program.
public int drawerLinkerNumeric()
|
Drawer number of the Network Configuration drawer.
public int drawerNetworkNumeric()
|
Alphabetic drawer of the current result.
public java.lang.String drawerResult()
|
Alphabetic drawer of the specified result number.
public java.lang.String drawerResult(int aResult)
|
Drawer number of the current result (-0).
public int drawerResultNumeric()
|
Drawer number of the specified result.
public int drawerResultNumeric(int aResult)
|
Alphabetic drawer of the run control report (in other words, currently
running program).
public java.lang.String drawerRunning()
|
Drawer number of the run control report (in other words, currently
running program).
public int drawerRunningNumeric()
|
Drawer number of the Security Registration reports.
public int drawerSecurityNumeric()
|
Drawer number of the current result (-0).
public int DRW()
|
Drawer number of the specified result.
public int DRW(int aResult)
|
Cabinet number of the run control report.
public int ECAB()
|
Drawer number of the run control report.
public int EDRW()
|
Report number of the run control report.
public int ERPT()
|
Drawer number of the run control report.
public int ETYPE()
|
Current form cabinet number.
public int FCAB()
|
Drawer number of the Screen Control form on display.
public int FDRW()
|
Drawer (form type) number of free form drawer A.
public int FFTYPE()
|
Report number of the Screen Control form on display.
public int FRPT()
|
Cabinet number of user's currently selected language.
public int LCAB()
|
Drawer number of the System Library Routines.
public int LIBDRW()
|
Drawer number of the script that issued the LNK statement.
public int LNKDRW()
|
Report number that issued the LNK statement.
public int LNKRPT()
|
Drawer number of the Network Configuration drawer.
public int NETDRW()
|
The number that represents the current report or result, i.e., -0 in MAPPER.
public int numberOfCurrentReportOrResult()
|
public int PLNG()
|
Report number of the run control report issuing the external Run Subroutine (RSR)
statement (if the report is from an internal subroutine, then zero). In other words,
report number of the calling program.
public int reportCaller()
|
Report number of the Screen Control form on display.
public int reportForm()
|
The number of the report or result last processed, or of the report or
result on display when the script started. If equal to numberOfCurrentReportOrResult(),
the current result. If zero, no report. After the equivalent of an ADR or or DUP statement,
contains the report number of new report.
public int reportLastProcessed()
|
Report number that issued the LNK statement. In other words, report
number of the program that invoked the currently running program.
public int reportLinker()
|
Report number of the run control report (in other words, currently
running program).
public int reportRunning()
|
Report number of the user's security registration. In MAPPER, 11 through 20
in the Security Registration drawer for Windows, Unix and Linux and 1 through
2000 for OS2200.
public int reportSecurity()
|
The number of the report or result last processed.
public int RPT()
|
Drawer number of the Security Registration reports.
public int SECDRW()
|
Report number of the user's security registration.
public int SECRPT()
|
MJDate instances associated with various MAPPER date formats,
providing equivalent methods for MAPPER reserved words related to date and time.
public class com.arsi.mj.rw.MJCurrentDate
extends java.lang.Object
| Constructors |
public MJCurrentDate()
|
| Methods |
Current date in YMMDD format.
public static com.arsi.mj.variable.MJDate DATE0()
|
Current date in YYMMDD format.
public static com.arsi.mj.variable.MJDate DATE1()
|
Current date in YYYYMMDD format.
public static com.arsi.mj.variable.MJDate DATE11()
|
Current date in DD MMM YYYY format.
public static com.arsi.mj.variable.MJDate DATE12()
|
Current date in YYYYDDD format.
public static com.arsi.mj.variable.MJDate DATE14()
|
Current date in DDMMYYYY format.
public static com.arsi.mj.variable.MJDate DATE15()
|
Current date in MM/DD/YYYY format.
public static com.arsi.mj.variable.MJDate DATE16()
|
Current date in MMDDYYYY format.
public static com.arsi.mj.variable.MJDate DATE18()
|
Current date in DD/MM/YYYY format.
public static com.arsi.mj.variable.MJDate DATE19()
|
Current date in DD MMM YY format.
public static com.arsi.mj.variable.MJDate DATE2()
|
Current date in YYYY-MM-DD format.
public static com.arsi.mj.variable.MJDate DATE20()
|
Current date in YDDD format.
public static com.arsi.mj.variable.MJDate DATE3()
|
Current date in YYDDD format.
public static com.arsi.mj.variable.MJDate DATE4()
|
Current date in DDMMYY format.
public static com.arsi.mj.variable.MJDate DATE5()
|
Current date in MM/DD/YY format.
public static com.arsi.mj.variable.MJDate DATE6()
|
Current date in MONTH DD, YYYY format.
public static com.arsi.mj.variable.MJDate DATE7()
|
Current date in MMDDYY format.
public static com.arsi.mj.variable.MJDate DATE8()
|
Current date in DD/MM/YY format.
public static com.arsi.mj.variable.MJDate DATE9()
|
Current date in DD/MM/YY format.
public static com.arsi.mj.variable.MJDate dd_MM_yy()
|
Current date in DD/MM/YYYY format.
public static com.arsi.mj.variable.MJDate dd_MM_yyyy()
|
Current date in DD MMM YYYY format.
public static com.arsi.mj.variable.MJDate dd_MMM_yyyy()
|
Current date in DD MMM YY format.
public static com.arsi.mj.variable.MJDate ddMMMyy()
|
Current date in DDMMYY format.
public static com.arsi.mj.variable.MJDate ddMMyy()
|
Current date in DDMMYYYY format.
public static com.arsi.mj.variable.MJDate ddMMyyyy()
|
Get current date formatted with specified date format.
public static com.arsi.mj.variable.MJDate getInstance(org.apache.commons.lang3.time.FastDateFormat aDateFmt)
|
Get current date in specified time zone formatted with specified date format.
public static com.arsi.mj.variable.MJDate getInstance(org.apache.commons.lang3.time.FastDateFormat aDateFmt, java.util.TimeZone aTZ)
|
Current date in MM/DD/YY format.
public static com.arsi.mj.variable.MJDate MM_dd_yy()
|
Current date in MM/DD/YYYY format.
public static com.arsi.mj.variable.MJDate MM_dd_yyyy()
|
Current date in MMDDYY format.
public static com.arsi.mj.variable.MJDate MMddyy()
|
Current date in MMDDYYYY format.
public static com.arsi.mj.variable.MJDate MMddyyyy()
|
Current date in MONTH DD, YYYY format.
public static com.arsi.mj.variable.MJDate month_dd_yyyy()
|
Current date in YDDD (single digit year and day in year) format.
public static com.arsi.mj.variable.MJDate yDDD()
|
Current date in YMMDD (single digit year and month and date) format.
public static com.arsi.mj.variable.MJDate yMMdd()
|
Current date in YYDDD (two digit year and day in year) format.
public static com.arsi.mj.variable.MJDate yyDDD()
|
Current date in YYMMDD format.
public static com.arsi.mj.variable.MJDate yyMMdd()
|
Current date in YYYY-MM-DD format.
public static com.arsi.mj.variable.MJDate yyyy_MM_dd()
|
Current date in YYYYDDD format.
public static com.arsi.mj.variable.MJDate yyyyDDD()
|
Current date in YYYYMMDD format.
public static com.arsi.mj.variable.MJDate yyyyMMdd()
|
MJDate instances associated with various MAPPER time formats,
providing equivalent methods for MAPPER reserved words related to time.
public class com.arsi.mj.rw.MJCurrentTime
extends java.lang.Object
| Constructors |
public MJCurrentTime()
|
| Methods |
Current day of the week in DAY format (MON, TUE, and so on).
public static java.lang.String currentDayOfWeek()
|
Current number of seconds since January 1, 1970.
public static long currentEpochTime()
|
Current number of seconds since January 1, 1970.
public static long CURSEC()
|
Current day of the week in DAY format (MON, TUE, and so on).
public static java.lang.String DAY()
|
Current time in HH:MM:SS format.
public static com.arsi.mj.variable.MJDate HH_mm_ss()
|
Current number of milliseconds since midnight.
public static long millisSinceMidnight()
|
Current number of milliseconds since midnight.
public static long MSEC()
|
Current time in HH:MM:SS format.
public static com.arsi.mj.variable.MJDate TIME()
|
public interface com.arsi.mj.rw.MJDisplayCtx
| Methods |
Number of held lines.
public int countHeldLines()
|
Horizontal character position of the cursor.
public int CURH()
|
Horizontal character position of the cursor.
public int cursorPosHorz()
|
Vertical character position of the cursor.
public int cursorPosVert()
|
Vertical character position of the cursor.
public int CURV()
|
Line number of the first non-held line on display.
public int displayLineNonHeld()
|
Line number of the first non-held line on display.
public int DLINE()
|
Number of held lines.
public int HLINES()
|
Line number in a list box from which the user transmitted (LITEM$ is valid with the Graphical
Interface for Business Information Server).
public int listboxItem()
|
Line number in a list box from which the user transmitted.
public int LITEM()
|
Horizontal cursor position of the SOE character.
public int SOEH()
|
Vertical cursor position of the SOE character.
public int SOEV()
|
Horizontal cursor position of the SOE character.
public int startOfEntryPosHorz()
|
Vertical cursor position of the SOE character.
public int startOfEntryPosVert()
|
public interface com.arsi.mj.rw.MJGraphicsCtx
| Methods |
Handle of object last accessed.
public int ACTINP()
|
Handle of object last accessed. This could be a window handle, but usually it
is the handle of a control within a window (ACTINP$ is valid with the
Graphical Interface for Business Information Server).
public int activeInputControl()
|
Window handle of last window accessed. When input is received from a control,
ACTWIN$ is the handle of the window containing that control (ACTWIN$ is valid
with the Graphical Interface for Business Information Server).
public int activeWindow()
|
Window handle of last window accessed.
public int ACTWIN()
|
Functional level of the legacy graphical user interface.
public java.lang.String APILVL()
|
Aspect ratio (used with graphics); provides a constant but is ignored.
public int ASPECT()
|
Aspect ratio (used with graphics); provides a constant but is ignored.
public int aspectRatio()
|
Color terminal flag.
public boolean COLOR()
|
Legacy, MAPPER graphics and GUI capabilities available on both the host system and the API.
public java.lang.String DWCAP()
|
Graphics terminal flag.
public boolean GRAPH()
|
Functional level of the legacy graphical user interface.
public java.lang.String legacyAPILevel()
|
Legacy, MAPPER graphics and GUI capabilities available on both the host system and the
API. DWCAP$ is a string of zeros and ones, where 0 indicates an unsupported
capability and 1 indicates a supported capability. Starting from character 1 of
DWCAP$ and moving to the right, one may check for the following capabilities:
1 - Reserved for internal use 2 - Blocked fonts available (@FON T option available to eliminate blocking) 3 - Handles generated by the host 4 - Reserved for internal use 5 - Reserved for internal use 6 - Reserved for internal use 7 - DDE Interface (DDE) 8 - API Repository not currently active or otherwise supported 9 - Font (FON) statement D and P options 10 - Reserved for internal use 11 - 32-bit client 12 - MAPPER Modernization Features 2000 13 - MAPPER Modernization Features 2001 14 - MAPPER Modernization Features 2003 15-32 - Reserved for future useCheck the positions of DWCAP$ using the variable substring format. For example,
DWCAP$(9-1) refers to the ninth character in the reserved word, which, if it contains
a 1, indicates @FON D and P options are supported.
public java.lang.String legacyCapabilities()
|
Main workstation window handle (valid only with Graphical Interface
for Business Information Server and Business Information Server for
Microsoft Windows Client).
public int mainWindow()
|
Color terminal flag; always returns true, even if the display
is monochrome VGA graphics.
public boolean supportsColor()
|
Graphics terminal flag (if false, terminal cannot display graphics).
public boolean supportsGraphics()
|
Main workstation window handle.
public int WND()
|
public interface com.arsi.mj.rw.MJLegacyDBCtx
| Methods |
The current site database path.
public java.lang.String DBASE()
|
The current site database path.
public java.lang.String dbPath()
|
Configured database threshold value.
public int dbThreshold()
|
Configured database threshold value.
public int DBTHRS()
|
Percent of database space currently being used.
public int dbUsage()
|
Percent of database space currently being used.
public int DBUSG()
|
public interface com.arsi.mj.rw.MJLegacyDTMCtx
| Methods |
Status of Data Transfer Module.
public int DTM()
|
Name of this system as known to DTM.
public java.lang.String DTNAM()
|
Indicates that local or network message(s) are queued for current user:
If false, there are no messages queued. If true, there are messages queued.
public boolean hasMessages()
|
Indicates that local or network message(s) are queued for current user.
public boolean MSGQ()
|
Name of this system as known to DTM.
public java.lang.String name()
|
Status of Data Transfer Module:
0 - DTM is not configured. 1 - DTM is configured, but system is not attached. 2 - DTM is configured, and system is attached. 3 - Requesting script is processing DTM input.
public int status()
|
public interface com.arsi.mj.rw.MJLegacyEnvCtx
| Methods |
Number of CALL levels remaining.
public int CALL()
|
Returns the amount of processing time consumed during a script in milliseconds.
public long countCPU()
|
Number of data lines processed during the program.
public long countDataLines()
|
Number of storage I/O requests processed during the program execution.
public long countIO()
|
Number of logic lines processed during the program.
public long countLogicLines()
|
Number of data lines processed during the program.
public long DLP()
|
Available environmental variable space in bytes.
public int ENVSTR()
|
Remaining available characters in the script string and array variable space.
public int FRESTR()
|
Available global variable space in bytes.
public int GLBSTR()
|
Number of storage I/O requests processed during the program execution.
public long IO()
|
Returns the amount of processing time consumed during a script in milliseconds.
public long IP()
|
Number of logic lines processed during the program.
public long LLP()
|
Maximum number of departments.
public int maxDept()
|
Maximum number of environmental variables allowed in program.
public int maxEnvvars()
|
Maximum number of environmental variables allowed in program.
public long MAXEVR()
|
Maximum number of global variables allowed in program.
public int maxGlobals()
|
Maximum number of global variables allowed in program.
public long MAXGVR()
|
Maximum number of global variables allowed in program.
public long MAXLAB()
|
Maximum number of labels allowed in program.
public int maxLabels()
|
Maximum number of departments.
public long MXDEPN()
|
Available environmental variable space in bytes.
public int remainingEnvSpace()
|
Available global variable space in bytes.
public int remainingGlobalSpace()
|
Number of CALL levels remaining.
public int remainingNestedCalls()
|
Remaining available characters in the script string and array variable space.
public int remainingStringSpace()
|
public interface com.arsi.mj.rw.MJLegacyOutputCtx
| Methods |
Escape sequence.
public java.lang.String ESC()
|
Escape sequence. Since the value of this reserved word varies depending
on platform, avoid using it in new applications.
public java.lang.String escape()
|
public interface com.arsi.mj.rw.MJLegacySecurityCtx
| Methods |
Does logged on user have coordinator privileges?
public boolean CPRIV()
|
Do external functions run with host (OS 2200, for example) user ID credentials
or with MAPPER background job credentials?
public boolean externalUsesHostCredentials()
|
Configuration parameter that controls whether host (OS 2200, for example) user IDs
are allowed or required for users to log on to the system.
0 - host user IDs irrelevant 1 - host user IDs allowed 2 - host user IDs required
public int hostCredentialsRequired()
|
Does logged on user have coordinator (a grade of system administrator) privileges?
public boolean isCoordinator()
|
Does logged on user have script design (in other words, run-time debug) privileges?
public boolean isDebugger()
|
Does logged on user have system analyst (in other words, software installation and
configuration) privileges?
public boolean isInstaller()
|
Does logged on user have operator (a grade of system administrator) privileges?
public boolean isOperator()
|
Is user logged on with a host (OS 2200, for example) user ID?
public boolean isUsingHostCredentials()
|
Maximum number of characters in a host (OS 2200, for example) password.
public boolean maxHostPasswordLength()
|
Does logged on user have operator privileges?
public boolean OPRIV()
|
Do external functions run with host credentials or MAPPER credentials?
public boolean OSFILS()
|
Maximum number of characters in a host password.
public boolean OSPLEN()
|
Configuration parameter that controls whether host user IDs
are allowed or required for users to log on to the system.
public int OSUIDS()
|
Is user logged on with a host user ID?
public boolean OSUSER()
|
Does logged on user have script design privileges?
public boolean RPRIV()
|
Does logged on user have system analyst privileges?
public boolean SPRIV()
|
public class com.arsi.mj.rw.MJSpecialChars
extends java.lang.Object
| Fields |
The forward slash character, named for MAPPER reserved word RSLANT.public static final java.lang.String RSLANT = "/"
|
The start-of-entry character, named for MAPPER reserved word SOE.public static final java.lang.String SOE = "\u001b^"
|
The tab character, named for MAPPER reserved word TAB.public static final java.lang.String TAB = "\t"
|
The single quote character, named for MAPPER reserved word TIC.public static final java.lang.String TIC = "\'"
|
| Constructors |
public MJSpecialChars()
|
public interface com.arsi.mj.rw.MJUserAgentCtx
| Methods |
Legacy terminal has FCC.
public boolean FCC()
|
Legacy terminal coded character set identifier (CCS-ID).
public int legacyTerminalCCS()
|
Legacy terminal (UTS 400) has FCC (field control characters, i.e., hardware
protect capability).
public boolean legacyTerminalFCC()
|
Legacy user interface currently in effect at site and in effect for script (specified
in the registration report by the coordinator). The system returns the following values:
0: Pre-35R1 - Pre-35R1 1: Pre-35R1 - Menu 2: Menu - Pre-35R1 3: Menu - Menu
public int legacyTerminalLook()
|
Type of the legacy terminal executing the script (in MAPPER, read from the
configuration report or the MAPTERM environment variable).
public java.lang.String legacyTerminalType()
|
Station number executing the script.
public int logicalStationID()
|
Legacy user interface currently in effect at site and in effect for script.
public int LOOK()
|
Number of columns that can be displayed on the screen.
public java.lang.String SCNH()
|
Number of rows that can be displayed on the screen.
public java.lang.String SCNV()
|
Number of columns that can be displayed on the screen including columns that cannot
be seen without using the scroll bars.
public int screenColumns()
|
Number of rows that can be displayed on the screen including columns that cannot
be seen without using the scroll bars.
public int screenRows()
|
Station number executing the script.
public int STNUM()
|
Legacy terminal coded character set identifier.
public int TCCS()
|
Type of the legacy terminal executing the script.
public java.lang.String TTYPE()
|
The IP address of the workstation, expressed in the form xxx.xxx.xxx.xxx where
each xxx subfield is 1 to 3 decimal characters. If zero, the current session is
not associated with a user agent or the IP address is not available.
public java.lang.String workstationIP()
|
Workstation session opened to a host system. If zero, the user agent associated
with the current session cannot render a graphical interface.
public int workstationSupportsGUI()
|
String of characters forming a unique identifier for each workstation (client).
Guaranteed to be unique across all sessions and system platforms. One use for this
reserved word is forming unique identifiers for workstation objects (pictures,
list boxes, combo boxes, and text boxes). Valid only when current session is
associated with a user agent.
public java.lang.String workstationUUID()
|
Workstation session opened to a host system.
public int WS()
|
The IP address of the workstation.
public java.lang.String WSIPA()
|
String of characters forming a unique identifier for each workstation.
public java.lang.String WSITE()
|
public interface com.arsi.mj.rw.MJUserCtx
| Methods |
User's department sign-on number.
public int DEPN()
|
User's department name (in other words, the department
name associated with the currently executing program).
public java.lang.String dept()
|
User's department name.
public java.lang.String DEPT()
|
User's department sign-on number (in other words, the department
number associated with the currently executing program).
public int deptNumeric()
|
User's security group number.
public int SECGRP()
|
User's security group number, 1 through 200 (in other words, the security
group number number associated with the currently executing program).
public int securityGroupNumeric()
|
User-id of the user who started the script (in other words, the
user associated with the currently executing program).
public java.lang.String user()
|
User-id of the user who started the script.
public java.lang.String USER()
|