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

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

All Implemented Interfaces:

ICODECommIntegrationConstants

public class CHKOUTStruct
extends Object
implements ICODECommIntegrationConstants

This class represents the CODE communications CHKOUT structure used by the VDECheckObject (rseCheckObject) api. typedef struct { ULONG fileType; // File type flags CHAR library[11]; // Actual library name CHAR file[11]; // File name (if overrides ON) CHAR member[11]; // Member name (if overrides & member chk) CHAR fileAttr[11]; // File attribute CHAR ADMpart[132]; // Name if obj/mbr is ADM part USHORT fileRecl; // File record length USHORT status; // Other object status flags } CHKOUT;

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, copyright, 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

CHKOUTStruct()
Constructor for CHKOUTStruct.

Method Summary

String	getADMpart() Returns the aDMpart.
String	getFile() Returns the file.
String	getFileAttr() Returns the fileAttr.
int	getFileRecordLength() Returns the fileRecordLength.
long	getFileType() Returns the fileType.
String	getLibrary() Returns the library.
String	getMember() Returns the member.
int	getStatus() Returns the status.
void	setADMpart(String aDMpart) Sets the aDMpart.
void	setFile(String file) Sets the file.
void	setFileAttr(String fileAttr) Sets the fileAttr.
void	setFileRecordLength(int fileRecordLength) Sets the fileRecordLength.
void	setFileType(IQSYSFile file) Alternative method for setting the file type.
void	setFileType(long mask) Set the file type
void	setLibrary(String library) Sets the library.
void	setMember(String member) Sets the member.
void	setStatus(int status) Sets the status.
void	write(JavaToCOutputStream out) Stream this structure to the output stream

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

CHKOUTStruct

public CHKOUTStruct()

Constructor for CHKOUTStruct.

Method Detail

getADMpart

public String getADMpart()

Returns the aDMpart.

Returns:

String

getFile

public String getFile()

Returns the file.

Returns:

String

getFileAttr

public String getFileAttr()

Returns the fileAttr.

Returns:

String

getFileRecordLength

public int getFileRecordLength()

Returns the fileRecordLength.

Returns:

int

getFileType

public long getFileType()

Returns the fileType.

Returns:

long

getLibrary

public String getLibrary()

Returns the library.

Returns:

String

getMember

public String getMember()

Returns the member.

Returns:

String

getStatus

public int getStatus()

Returns the status.

Returns:

int

setADMpart

public void setADMpart(String aDMpart)

Sets the aDMpart.

Parameters:

aDMpart - The aDMpart to set

setFile

public void setFile(String file)

Sets the file.

Parameters:

file - The file to set

setFileAttr

public void setFileAttr(String fileAttr)

Sets the fileAttr.

Parameters:

fileAttr - The fileAttr to set

setFileRecordLength

public void setFileRecordLength(int fileRecordLength)

Sets the fileRecordLength.

Parameters:

fileRecordLength - The fileRecordLength to set

setFileType

public void setFileType(long mask)

Set the file type

setFileType

public void setFileType(IQSYSFile file)
                 throws Exception

Alternative method for setting the file type. This method determines the file type based on the ISeriesFile instance.

Parameters:

file -

Throws:

Exception

setLibrary

public void setLibrary(String library)

Sets the library.

Parameters:

library - The library to set

setMember

public void setMember(String member)

Sets the member.

Parameters:

member - The member to set

setStatus

public void setStatus(int status)

Sets the status. This adds the status mask to the existing status mask.

Parameters:

status - The status to set

write

public void write(JavaToCOutputStream out)
           throws IOException

Stream this structure to the output stream

Throws:

IOException