vs.starlet
Class STS

java.lang.Object
  extended byvs.starlet.STS

public class STS
extends java.lang.Object

Contains all definitions in the STARLET module STSDEF.


Field Summary
static int sts$k_error
           
static int STS$K_ERROR
          error
static int sts$k_info
           
static int STS$K_INFO
          information
static int sts$k_severe
           
static int STS$K_SEVERE
          severe error
static int sts$k_success
           
static int STS$K_SUCCESS
          successful completion
static int sts$k_warning
           
static int STS$K_WARNING
          warning
static int sts$m_code
           
static int STS$M_CODE
           
static int sts$m_cond_id
           
static int STS$M_COND_ID
           
static int sts$m_control
           
static int STS$M_CONTROL
           
static int sts$m_cust_def
           
static int STS$M_CUST_DEF
           
static int sts$m_fac_no
           
static int STS$M_FAC_NO
           
static int sts$m_fac_sp
           
static int STS$M_FAC_SP
           
static int sts$m_inhib_msg
           
static int STS$M_INHIB_MSG
           
static int sts$m_msg_no
           
static int STS$M_MSG_NO
           
static int sts$m_severity
           
static int STS$M_SEVERITY
           
static int sts$m_success
           
static int STS$M_SUCCESS
           
static int sts$s_code
           
static int STS$S_CODE
          code
static int sts$s_cond_id
           
static int STS$S_COND_ID
          condition id
static int sts$s_control
           
static int STS$S_CONTROL
          control bits
static int sts$s_fac_no
           
static int STS$S_FAC_NO
          facility is 12 bits
static int sts$s_msg_no
           
static int STS$S_MSG_NO
          message number
static int sts$s_severity
           
static int STS$S_SEVERITY
          severity code
static int sts$s_stsdef
           
static int STS$S_STSDEF
           
static FieldDescriptor sts$v_code
           
static FieldDescriptor STS$V_CODE
           
static FieldDescriptor sts$v_cond_id
           
static FieldDescriptor STS$V_COND_ID
           
static FieldDescriptor sts$v_control
           
static FieldDescriptor STS$V_CONTROL
           
static FieldDescriptor sts$v_cust_def
           
static FieldDescriptor STS$V_CUST_DEF
          1 if sub-system is customer (or css) defined
static FieldDescriptor sts$v_fac_no
           
static FieldDescriptor STS$V_FAC_NO
           
static FieldDescriptor sts$v_fac_sp
           
static FieldDescriptor STS$V_FAC_SP
          1 if facility specific
static FieldDescriptor sts$v_inhib_msg
           
static FieldDescriptor STS$V_INHIB_MSG
          1 if message should not be printed
static FieldDescriptor sts$v_msg_no
           
static FieldDescriptor STS$V_MSG_NO
           
static FieldDescriptor sts$v_severity
           
static FieldDescriptor STS$V_SEVERITY
           
static FieldDescriptor sts$v_success
           
static FieldDescriptor STS$V_SUCCESS
          success
 
Constructor Summary
STS()
           
 
Method Summary
static int $VMS_STATUS_CODE(int code)
          Return the value in the field STS$V_CODE.
static int $VMS_STATUS_COND_ID(int code)
          Return the value in the field STS$V_COND_ID
static int $VMS_STATUS_CONTROL(int code)
          Return the value in the field STS$V_CONTROL.
static boolean $VMS_STATUS_CUST_DEF(int code)
          Return the value in the field STS$V_CUST_DEF.
static int $VMS_STATUS_FAC_NO(int code)
          Return the value in the field STS$V_FAC_NO.
static boolean $VMS_STATUS_FAC_SP(int code)
          Return the value in the field STS$V_FAC_SP.
static boolean $VMS_STATUS_INHIB_MSG(int code)
          Return the value in the field STS$V_INHIB_MSG.
static int $VMS_STATUS_MSG_NO(int code)
          Return the value in the field STS$V_MSG_NO.
static int $VMS_STATUS_SEVERITY(int code)
          Return the value in the field STS$V_SEVERITY.
static boolean $VMS_STATUS_SUCCESS(int code)
          Return the value in the field STS$V_SUCCESS.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STS$K_ERROR

public static final int STS$K_ERROR
error

See Also:
Constant Field Values

sts$k_error

public static final int sts$k_error
See Also:
Constant Field Values

STS$K_INFO

public static final int STS$K_INFO
information

See Also:
Constant Field Values

sts$k_info

public static final int sts$k_info
See Also:
Constant Field Values

STS$K_SEVERE

public static final int STS$K_SEVERE
severe error

See Also:
Constant Field Values

sts$k_severe

public static final int sts$k_severe
See Also:
Constant Field Values

STS$K_SUCCESS

public static final int STS$K_SUCCESS
successful completion

See Also:
Constant Field Values

sts$k_success

public static final int sts$k_success
See Also:
Constant Field Values

STS$K_WARNING

public static final int STS$K_WARNING
warning

See Also:
Constant Field Values

STS$M_CODE

public static final int STS$M_CODE
See Also:
Constant Field Values

STS$M_COND_ID

public static final int STS$M_COND_ID
See Also:
Constant Field Values

STS$M_CONTROL

public static final int STS$M_CONTROL
See Also:
Constant Field Values

STS$M_CUST_DEF

public static final int STS$M_CUST_DEF
See Also:
Constant Field Values

STS$M_FAC_NO

public static final int STS$M_FAC_NO
See Also:
Constant Field Values

STS$M_FAC_SP

public static final int STS$M_FAC_SP
See Also:
Constant Field Values

STS$M_INHIB_MSG

public static final int STS$M_INHIB_MSG
See Also:
Constant Field Values

STS$M_MSG_NO

public static final int STS$M_MSG_NO
See Also:
Constant Field Values

STS$M_SEVERITY

public static final int STS$M_SEVERITY
See Also:
Constant Field Values

STS$M_SUCCESS

public static final int STS$M_SUCCESS
See Also:
Constant Field Values

sts$k_warning

public static final int sts$k_warning
See Also:
Constant Field Values

sts$m_code

public static final int sts$m_code
See Also:
Constant Field Values

sts$m_cond_id

public static final int sts$m_cond_id
See Also:
Constant Field Values

sts$m_control

public static final int sts$m_control
See Also:
Constant Field Values

sts$m_cust_def

public static final int sts$m_cust_def
See Also:
Constant Field Values

sts$m_fac_no

public static final int sts$m_fac_no
See Also:
Constant Field Values

sts$m_fac_sp

public static final int sts$m_fac_sp
See Also:
Constant Field Values

sts$m_inhib_msg

public static final int sts$m_inhib_msg
See Also:
Constant Field Values

sts$m_msg_no

public static final int sts$m_msg_no
See Also:
Constant Field Values

sts$m_severity

public static final int sts$m_severity
See Also:
Constant Field Values

sts$m_success

public static final int sts$m_success
See Also:
Constant Field Values

STS$S_CODE

public static final int STS$S_CODE
code

See Also:
Constant Field Values

sts$s_code

public static final int sts$s_code
See Also:
Constant Field Values

STS$S_COND_ID

public static final int STS$S_COND_ID
condition id

See Also:
Constant Field Values

sts$s_cond_id

public static final int sts$s_cond_id
See Also:
Constant Field Values

STS$S_CONTROL

public static final int STS$S_CONTROL
control bits

See Also:
Constant Field Values

sts$s_control

public static final int sts$s_control
See Also:
Constant Field Values

STS$S_FAC_NO

public static final int STS$S_FAC_NO
facility is 12 bits

See Also:
Constant Field Values

sts$s_fac_no

public static final int sts$s_fac_no
See Also:
Constant Field Values

STS$S_MSG_NO

public static final int STS$S_MSG_NO
message number

See Also:
Constant Field Values

sts$s_msg_no

public static final int sts$s_msg_no
See Also:
Constant Field Values

STS$S_SEVERITY

public static final int STS$S_SEVERITY
severity code

See Also:
Constant Field Values

STS$S_STSDEF

public static final int STS$S_STSDEF
See Also:
Constant Field Values

STS$V_CODE

public static final FieldDescriptor STS$V_CODE

STS$V_COND_ID

public static final FieldDescriptor STS$V_COND_ID

STS$V_CONTROL

public static final FieldDescriptor STS$V_CONTROL

sts$s_severity

public static final int sts$s_severity
See Also:
Constant Field Values

sts$s_stsdef

public static final int sts$s_stsdef
See Also:
Constant Field Values

sts$v_code

public static final FieldDescriptor sts$v_code

sts$v_cond_id

public static final FieldDescriptor sts$v_cond_id

sts$v_control

public static final FieldDescriptor sts$v_control

STS$V_CUST_DEF

public static final FieldDescriptor STS$V_CUST_DEF
1 if sub-system is customer (or css) defined


STS$V_FAC_NO

public static final FieldDescriptor STS$V_FAC_NO

sts$v_cust_def

public static final FieldDescriptor sts$v_cust_def

sts$v_fac_no

public static final FieldDescriptor sts$v_fac_no

STS$V_FAC_SP

public static final FieldDescriptor STS$V_FAC_SP
1 if facility specific


sts$v_fac_sp

public static final FieldDescriptor sts$v_fac_sp

STS$V_INHIB_MSG

public static final FieldDescriptor STS$V_INHIB_MSG
1 if message should not be printed


STS$V_MSG_NO

public static final FieldDescriptor STS$V_MSG_NO

STS$V_SEVERITY

public static final FieldDescriptor STS$V_SEVERITY

sts$v_inhib_msg

public static final FieldDescriptor sts$v_inhib_msg

sts$v_msg_no

public static final FieldDescriptor sts$v_msg_no

sts$v_severity

public static final FieldDescriptor sts$v_severity

STS$V_SUCCESS

public static final FieldDescriptor STS$V_SUCCESS
success


sts$v_success

public static final FieldDescriptor sts$v_success
Constructor Detail

STS

public STS()
Method Detail

$VMS_STATUS_CODE

public static final int $VMS_STATUS_CODE(int code)
Return the value in the field STS$V_CODE.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_CODE.

$VMS_STATUS_COND_ID

public static final int $VMS_STATUS_COND_ID(int code)
Return the value in the field STS$V_COND_ID

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_COND_ID.

$VMS_STATUS_CONTROL

public static final int $VMS_STATUS_CONTROL(int code)
Return the value in the field STS$V_CONTROL.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_CONTROL.

$VMS_STATUS_CUST_DEF

public static final boolean $VMS_STATUS_CUST_DEF(int code)
Return the value in the field STS$V_CUST_DEF.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_CUST_DEF.

$VMS_STATUS_FAC_NO

public static final int $VMS_STATUS_FAC_NO(int code)
Return the value in the field STS$V_FAC_NO.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_FAC_NO.

$VMS_STATUS_FAC_SP

public static final boolean $VMS_STATUS_FAC_SP(int code)
Return the value in the field STS$V_FAC_SP.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_FAC_SP.

$VMS_STATUS_INHIB_MSG

public static final boolean $VMS_STATUS_INHIB_MSG(int code)
Return the value in the field STS$V_INHIB_MSG.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_INHIB_MSG.

$VMS_STATUS_MSG_NO

public static final int $VMS_STATUS_MSG_NO(int code)
Return the value in the field STS$V_MSG_NO.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_MSG_NO.

$VMS_STATUS_SEVERITY

public static final int $VMS_STATUS_SEVERITY(int code)
Return the value in the field STS$V_SEVERITY.

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_SEVERITY.

$VMS_STATUS_SUCCESS

public static final boolean $VMS_STATUS_SUCCESS(int code)
Return the value in the field STS$V_SUCCESS.

The value in STS$V_SUCCESS is converted and returned as a boolean. This allows this method to be used in if tests in much the same way as the equivalent C macro.

The following example tests for successful completion.

 import vs.starlet.SS;
 import vs.starlet.STS;

 int sstatus = SS.SS$_NORMAL;

 if (STS.$VMS_STATUS_SUCCESS(sstatus))
     System.out.println("That was a success!");
 

Parameters:
code - OpenVMS status code
Returns:
the contents of the field STS$V_SUCCESS as a boolean.