All Packages  This Package  Class Hierarchy  Class Search  Index

Class bmsi.sna.FMH_1
java.lang.Object
   |
   +----bmsi.sna.FMH_1

  Summary

public class  FMH_1
     extends java.lang.Object
{
          // Fields 29
     public static final byte DSP_BASE;
     public static final byte DSP_DOC;
     public static final byte DSP_EXCHANGE;
     public static final byte DSP_GENERAL;
     public static final byte DSP_JOB;
     public static final byte DSP_OII2;
     public static final byte DSP_RJE;
     public static final byte DSP_SCS;
     public static final byte DSP_STRUCT;
     public static final byte DSP_WPRAW;
     public static final byte DSSEL_ABORT;
     public static final byte DSSEL_BEGIN;
     public static final byte DSSEL_CONTINUE;
     public static final byte DSSEL_END;
     public static final byte DSSEL_RESUME;
     public static final byte DSSEL_SUSPEND;
     public static final byte FM_ANY;
     public static final byte FM_CARD;
     public static final byte FM_CONSOLE;
     public static final byte FM_DATASET;
     public static final byte FM_DISK;
     public static final byte FM_DOCUMENT;
     public static final byte FM_EXCHANGE;
     public static final byte FM_EXTCARD;
     public static final byte FM_EXTDOC;
     public static final byte FM_WP1;
     public static final byte FM_WP2;
     public static final byte FM_WP3;
     public static final byte FM_WP4;

          // Constructors 1
     public FMH_1(byte[]);

          // Methods 12
     public boolean equals(Object);
     public byte[] getBytes();
     public String getDSName();
     public int getDSP();
     public int getDSSEL();
     public int getECRL();
     public int getMedium();
     public int getType();
     public int hashCode();
     public boolean isCompacted();
     public boolean isSCB();
     public void setBytes(byte[]);
}

Encapsulate various fields in an FMH-1 header.

Author:
Stuart D. Gathman Copyright (C) 1999 Business Management Systems, Inc.


  Cross Reference

Returned By:
JBMLU.getFMH()





  Fields

· FM_CONSOLE

Summary  |  Top
   public static final byte FM_CONSOLE

FMH-1 device codes.


· FM_EXCHANGE

Summary  |  Top
   public static final byte FM_EXCHANGE

FMH-1 device codes.


· FM_CARD

Summary  |  Top
   public static final byte FM_CARD

FMH-1 device codes.


· FM_DOCUMENT

Summary  |  Top
   public static final byte FM_DOCUMENT

FMH-1 device codes.


· FM_DISK

Summary  |  Top
   public static final byte FM_DISK

FMH-1 device codes.


· FM_EXTDOC

Summary  |  Top
   public static final byte FM_EXTDOC

FMH-1 device codes.


· FM_EXTCARD

Summary  |  Top
   public static final byte FM_EXTCARD

FMH-1 device codes.


· FM_DATASET

Summary  |  Top
   public static final byte FM_DATASET

FMH-1 device codes.


· FM_WP1

Summary  |  Top
   public static final byte FM_WP1

FMH-1 device codes.


· FM_WP2

Summary  |  Top
   public static final byte FM_WP2

FMH-1 device codes.


· FM_WP3

Summary  |  Top
   public static final byte FM_WP3

FMH-1 device codes.


· FM_WP4

Summary  |  Top
   public static final byte FM_WP4

FMH-1 device codes.


· FM_ANY

Summary  |  Top
   public static final byte FM_ANY

Subaddress wildcard.


· DSP_BASE

Summary  |  Top
   public static final byte DSP_BASE

Data stream profile constants.


· DSP_GENERAL

Summary  |  Top
   public static final byte DSP_GENERAL

Data stream profile constants.


· DSP_SCS

Summary  |  Top
   public static final byte DSP_SCS

Data stream profile constants.


· DSP_JOB

Summary  |  Top
   public static final byte DSP_JOB

Data stream profile constants.


· DSP_RJE

Summary  |  Top
   public static final byte DSP_RJE

Data stream profile constants.


· DSP_WPRAW

Summary  |  Top
   public static final byte DSP_WPRAW

Data stream profile constants.


· DSP_EXCHANGE

Summary  |  Top
   public static final byte DSP_EXCHANGE

Data stream profile constants.


· DSP_OII2

Summary  |  Top
   public static final byte DSP_OII2

Data stream profile constants.


· DSP_DOC

Summary  |  Top
   public static final byte DSP_DOC

Data stream profile constants.


· DSP_STRUCT

Summary  |  Top
   public static final byte DSP_STRUCT

Data stream profile constants.


· DSSEL_RESUME

Summary  |  Top
   public static final byte DSSEL_RESUME

Destination selection constants.


· DSSEL_END

Summary  |  Top
   public static final byte DSSEL_END

Destination selection constants.


· DSSEL_BEGIN

Summary  |  Top
   public static final byte DSSEL_BEGIN

Destination selection constants.


· DSSEL_SUSPEND

Summary  |  Top
   public static final byte DSSEL_SUSPEND

Destination selection constants.


· DSSEL_ABORT

Summary  |  Top
   public static final byte DSSEL_ABORT

Destination selection constants.


· DSSEL_CONTINUE

Summary  |  Top
   public static final byte DSSEL_CONTINUE

Destination selection constants.


  Constructors

· FMH_1

Summary  |  Top

   public FMH_1(byte[] fmh) 


  Methods

· setBytes

Summary  |  Top
   public void setBytes(byte[] fmh) 


· getBytes

Summary  |  Top
   public byte[] getBytes() 


· getDSName

Summary  |  Top
   public String getDSName() 

Return the destination name.

Returns:
the destination name, or null if not present or unavailable.


· getDSP

Summary  |  Top
   public int getDSP() 

Return the data stream profile. This should match one of the DSP_xxx constants. The DSP indicates what kind of data will be sent. For example, DSP_BASE is plain EBCDIC text, DSP_RJE is EBCDIC text with SCS (SNA Character Stream) escape sequences. DSP_EXCHANGE is fixed length binary records.

The return value is computed by starting with the DSP field. A value of 0 selects a default according to the selected medium. For FM_DISK and FM_EXCHANGE, the default depends on the DST (Data Set Transmission) flag.

Returns:
the profile code, or 0 if unknown

See Also: SCSInputStream



· getECRL

Summary  |  Top
   public int getECRL() 

Return the exchange record length. This method takes into account defaults and the selected medium as follows: The value is defined for FM_CARD and FM_EXCHANGE and for these devices a value of 0 is returned as 80.

Returns:
the record length, or 0 if unknown.


· getMedium

Summary  |  Top
   public int getMedium() 

Return the medium selection. The result will be one of the FM_xxx constants added to a 4 bit subaddress. A subaddress of FM_ANY matches any subaddress.

Returns:
the medium selection, or -1 if unknown


· isSCB

Summary  |  Top
   public boolean isSCB() 

Return true if this FMH-1 header precedes SCB encoded data.

Returns:
true if either the CMI (compression) or CPI (compaction) flag is set


· isCompacted

Summary  |  Top
   public boolean isCompacted() 

Return true if this FMH-1 header precedes compacted data.



· getDSSEL

Summary  |  Top
   public int getDSSEL() 

Return the dataset selection.

Returns:
one of the DSSEL_xxx values, or -1


· getType

Summary  |  Top
   public int getType() 


· hashCode

Summary  |  Top
   public int hashCode() 
Overrides:
hashCode in class Object


· equals

Summary  |  Top
   public boolean equals(Object obj) 
Overrides:
equals in class Object


All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7