com.ibm.etools.iseries.edit.verifiers.comm.bridge
Class FDKWDStruct

java.lang.Object
  com.ibm.etools.iseries.edit.verifiers.comm.bridge.FDKWDStruct

All Implemented Interfaces:

ICODECommIntegrationConstants

public class FDKWDStruct
extends Object
implements ICODECommIntegrationConstants

This class corresponds to the CODE comm FDKWD struct defined in evfcsys.h typedef struct { SHORT length; Length of keyword parameters SHORT numParameter; number of parameters SHORT id; keyword identifier List of keyword parameters } FDKWD; This structure is then following by a list of all associated parameters, each parameter separated from the next one by a null terminator.

Field Summary

static String

copyright

Fields inherited from interface com.ibm.etools.iseries.edit.verifiers.comm.bridge.ICODECommIntegrationConstants

ADEOPT_ALL, ADEOPT_ASIS, ADEOPT_CODE, ADEOPT_DATE, ADEOPT_EDIT, ADEOPT_FIRST, ADEOPT_INACTIVE, ADEOPT_LENGTH, ADEOPT_NOTAG, ADEOPT_SECOND, ADEOPT_SIZE, ADERC_BUFFER_SMALL, ADERC_CCSID_NF, ADERC_EDIT_NF, ADERC_EOF, ADERC_FIELD_NF, ADERC_FILE_AUTH, ADERC_FILE_NF, ADERC_FILE_TYPE, ADERC_INACT, ADERC_INVALID_ALIAS, ADERC_INVALID_MSG, ADERC_LIB_AUTH, ADERC_LIB_NF, ADERC_MBR_NF, ADERC_NO_SERVER, ADERC_OBJ_AUTH, ADERC_OBJ_NF, ADERC_OK, ADERC_PROG_ERR, ADERC_RECORD_NF, ADERC_RSST_ERR, ADERC_SYS_ERR, ALIAS_LENGTH, BOOL_FALSE, BOOL_TRUE, CHKFILE_ADM, CHKFILE_DBCS, CHKFILE_DDM, CHKFILE_DISPLAY, CHKFILE_ICF, CHKFILE_JOIN, CHKFILE_KEYED, CHKFILE_LOGICAL, CHKFILE_MIXED, CHKFILE_PHYSICAL, CHKFILE_PRINTER, CHKFILE_SOURCE, CHKOP_ADD, CHKOP_ALL, CHKOP_CHANGE, CHKOP_COPY, CHKOP_CPYMBR, CHKOP_DELETE, CHKOP_EDIT, CHKOP_MANAGE, CHKOP_OBJOPERATE, CHKOP_OBJOPRMGT, CHKOP_READ, CHKOP_READADD, CHKOP_UPDATE, CHKOP_USE, CHKOP_USEADD, CHKSTATUS_FTYPERETURNED, CHKSTATUS_IGCSYS, CHKSTATUS_LIBREAD, CHKSTATUS_MBRLOCK, CHKSTATUS_OBJREAD, CHKTYPE_ADM, CHKTYPE_BASEDON, CHKTYPE_LIB, CHKTYPE_MBR, CHKTYPE_OBJ, EXTKWD_CHECKAB, EXTKWD_CHECKFE, EXTKWD_CHECKM10, EXTKWD_CHECKM11, EXTKWD_CHECKME, EXTKWD_CHECKMF, EXTKWD_CHECKMF10, EXTKWD_CHECKMF11, EXTKWD_CHECKVN, EXTKWD_CHECKVNE, EXTKWD_CHKMSGID, EXTKWD_COMPEQ, EXTKWD_COMPGE, EXTKWD_COMPGT, EXTKWD_COMPLE, EXTKWD_COMPLT, EXTKWD_COMPNE, EXTKWD_COMPNG, EXTKWD_COMPNL, EXTKWD_DFT, EXTKWD_RANGE, EXTKWD_VALUES, NULL_CHAR, OP_CONCAT, OP_RENAME, OP_SUBSTRING, OP_TRANS_CONCAT, OP_TRANS_RENAME, OP_TRANSLATE, RSE_CHECK_CCSID, RSE_CHECK_OBJECT, RSE_CHECK_OBJECT_2, RSE_CHECK_OBJECT_IFS, RSE_CLOSE, RSE_CLOSE_SOCKET, RSE_DEFAULT_ALIAS, RSE_DEVFILE_INFO, RSE_EDIT_WORD, RSE_GET_CWD_IFS, RSE_GET_ENCODING_SCHEME, RSE_GET_ENV_IFS, RSE_IS_ALIAS_VALID, RSE_IS_ANY_ALIAS_VALID, RSE_MSG_TEXT, RSE_OPEN_DBF, RSE_OPEN_FIELD, RSE_OPEN_GET, RSE_OPEN_GET_IFS, RSE_OPEN_LIST, RSE_READ, RSE_READ_DBF, RSE_READ_FIELD, RSE_READ_IFS, RSE_RESOLVE_DBF, RSE_SORT_SEQ_TABLE, RSE_SQL_LANG_LENGTH, RSE_SYNTAX_CHECK_SQL, RSE_SYS_INFO, RSE_XLATE, XLATE_GET, XLATE_PUT

Constructor Summary

FDKWDStruct(short id)
Constructor for FDKWDStruct Use this constructor if the keyword has no parameter information

FDKWDStruct(short id, String[] parameters)
Constructor for FDKWDStruct.

Method Summary

protected static int	getFDKWDStructLength() Returns the size of this structure (fields + parameters) in bytes 6 bytes for the length, numParameter and id fields (3 * 2 bytes) + x bytes for the parameter info
protected static byte	getKeywordID(String name) Given a keyword name, convert it to the short ID equivalent as specified in the OS/400 QDBRTVFD api documentation.
protected int	getParameterLength() Return the length of the parameter string.
void	write(JavaToCOutputStream out) Stream the contents of this structure to the output stream in such a way that the contents can be read by the other socket peer (CODE comm written in C) and memcpy'd into the FDKWD structure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

Constructor Detail

FDKWDStruct

public FDKWDStruct(short id)

Constructor for FDKWDStruct Use this constructor if the keyword has no parameter information

FDKWDStruct

public FDKWDStruct(short id,
                   String[] parameters)

Constructor for FDKWDStruct.

Method Detail

write

public void write(JavaToCOutputStream out)
           throws IOException

Stream the contents of this structure to the output stream in such a way that the contents can be read by the other socket peer (CODE comm written in C) and memcpy'd into the FDKWD structure.

Throws:

IOException

getFDKWDStructLength

protected static int getFDKWDStructLength()

Returns the size of this structure (fields + parameters) in bytes 6 bytes for the length, numParameter and id fields (3 * 2 bytes) + x bytes for the parameter info

Returns:

The size of this structure in bytes

getParameterLength

protected int getParameterLength()

Return the length of the parameter string.

getKeywordID

protected static byte getKeywordID(String name)

Given a keyword name, convert it to the short ID equivalent as specified in the OS/400 QDBRTVFD api documentation.