com.ibm.eNetwork.ECL
Interface ECLXferBIDIServices

public interface ECLXferBIDIServices

The ECLXferBIDIServices interface provides access to the ECLXfer Bi-directional (BIDI) Language properties in an ECLXfer object. An ECLXferBIDIServices object is only available when using Bi-directional code pages (420, 424, or 803).

Field Summary

static java.lang.String	HOST_FILE_ORIENTATION String value for HostFileOrientation property keyword used in FileTransfer Bean
static java.lang.String	IMPLICIT PCFileType property value - IMPLICIT
static java.lang.String	LAM_ALEF_COMPRESSION String value for Lam_AlefCompression property keyword used in FileTransfer Bean, this property keyword only applies to Arabic Hosts
static java.lang.String	LAM_ALEF_COMPRESSION_OFF Lam_AlefCompression property value - Lam_AlefCompressionOff, this value only applies to Arabic hosts
static java.lang.String	LAM_ALEF_COMPRESSION_ON Lam_AlefCompression property value - Lam_AlefCompressionOn, this value only applies to Arabic hosts
static java.lang.String	LAM_ALEF_EXPANSION String value for Lam_AlefExpansion property keyword used in FileTransfer Bean, this property keyword only applies to Arabic Hosts
static java.lang.String	LAM_ALEF_EXPANSION_OFF Lam_AlefExpansion property value - Lam_AlefExpansionOff, this value only applies to Arabic hosts
static java.lang.String	LAM_ALEF_EXPANSION_ON Lam_AlefExpansion property value - Lam_AlefExpansionOn, this value only applies to Arabic hosts
static java.lang.String	LEFT_TO_RIGHT hostFileOrientation, PCFileOrientation property value - LEFTTORIGHT file
static java.lang.String	NUMERALS String value for Numerals property keyword used in FileTransfer Bean , this property keyword only applies to Arabic Hosts
static java.lang.String	NUMERALS_CONTEXTUAL Numerals property value - Numerals_Contextual, this value only applies to Arabic hosts
static java.lang.String	NUMERALS_NATIONAL Numerals property value - Numerals_National, this value only applies to Arabic hosts
static java.lang.String	NUMERALS_NOMINAL Numerals property value - Numerals_Nominal, this value only applies to Arabic hosts
static java.lang.String	PC_FILE_ORIENTATION String value for PCFileOrientation property keyword used in FileTransfer Bean
static java.lang.String	PC_FILE_TYPE String value for PCFileType property keyword used in FileTransfer Bean
static java.lang.String	RIGHT_TO_LEFT hostFileOrientation, PCFileOrientation property value - RIGHTTOLEFT file
static java.lang.String	ROUND_TRIP String value for Round_Trip property keyword used in FileTransfer Bean
static java.lang.String	ROUND_TRIP_OFF Round_Trip property value - Round_TripOff
static java.lang.String	ROUND_TRIP_ON Round_Trip property value - Round_TripOn
static java.lang.String	SYM_SWAP String value for Sym_Swap property keyword used in FileTransfer Bean
static java.lang.String	SYM_SWAP_OFF Sym_Swap property value - Sym_SwapOff
static java.lang.String	SYM_SWAP_ON Sym_Swap property value - Sym_SwapOn
static java.lang.String	VISUAL PCFileType property value - VISUAL

Method Summary

java.lang.String	GetHostFileOrientation() Get the current setting of the BIDI HostFileOrientation property
java.lang.String	GetLam_AlefCompression() Get the current setting of the BIDI Lam_AlefCompression property
java.lang.String	GetLam_AlefExpansion() Get the current setting of the BIDI Lam_AlefExpansion property
java.lang.String	GetNumerals() Get the current setting of the BIDI Numerals Shaping property
java.lang.String	GetPCFileOrientation() Get the current setting of the BIDI PCFileOrientation property
java.lang.String	GetPCFileType() Get the current setting of the BIDI PCFileType property
java.lang.String	GetRound_Trip() Get the current setting of the BIDI Round Trip property
java.lang.String	GetSym_Swap() Get the current setting of the BIDI Symmetric Swapping property
void	SetHostFileOrientation(java.lang.String hfo) Set the BIDI HostFileOrientation property.
void	SetLam_AlefCompression(java.lang.String pft) Set the BIDI Lam_AlefCompression property.
void	SetLam_AlefExpansion(java.lang.String pft) Set the BIDI Lam_AlefExpansion property.
void	SetNumerals(java.lang.String pft) Set the BIDI Numerals Shaping property.
void	SetPCFileOrientation(java.lang.String pfo) Set the BIDI PCFileOrientation property.
void	SetPCFileType(java.lang.String pft) Set the BIDI PCFileType property.
void	SetRound_Trip(java.lang.String pft) Set the BIDI Round Trip property.
void	SetSym_Swap(java.lang.String pft) Set the BIDI Symmetric Swapping property.

Field Detail

HOST_FILE_ORIENTATION

public static final java.lang.String HOST_FILE_ORIENTATION

String value for HostFileOrientation property keyword used in FileTransfer Bean

PC_FILE_ORIENTATION

public static final java.lang.String PC_FILE_ORIENTATION

String value for PCFileOrientation property keyword used in FileTransfer Bean

PC_FILE_TYPE

public static final java.lang.String PC_FILE_TYPE

String value for PCFileType property keyword used in FileTransfer Bean

VISUAL

public static final java.lang.String VISUAL

PCFileType property value - VISUAL

IMPLICIT

public static final java.lang.String IMPLICIT

PCFileType property value - IMPLICIT

LEFT_TO_RIGHT

public static final java.lang.String LEFT_TO_RIGHT

hostFileOrientation, PCFileOrientation property value - LEFTTORIGHT file

RIGHT_TO_LEFT

public static final java.lang.String RIGHT_TO_LEFT

hostFileOrientation, PCFileOrientation property value - RIGHTTOLEFT file

LAM_ALEF_EXPANSION

public static final java.lang.String LAM_ALEF_EXPANSION

String value for Lam_AlefExpansion property keyword used in FileTransfer Bean, this property keyword only applies to Arabic Hosts

LAM_ALEF_EXPANSION_ON

public static final java.lang.String LAM_ALEF_EXPANSION_ON

Lam_AlefExpansion property value - Lam_AlefExpansionOn, this value only applies to Arabic hosts

LAM_ALEF_EXPANSION_OFF

public static final java.lang.String LAM_ALEF_EXPANSION_OFF

Lam_AlefExpansion property value - Lam_AlefExpansionOff, this value only applies to Arabic hosts

LAM_ALEF_COMPRESSION

public static final java.lang.String LAM_ALEF_COMPRESSION

String value for Lam_AlefCompression property keyword used in FileTransfer Bean, this property keyword only applies to Arabic Hosts

LAM_ALEF_COMPRESSION_ON

public static final java.lang.String LAM_ALEF_COMPRESSION_ON

Lam_AlefCompression property value - Lam_AlefCompressionOn, this value only applies to Arabic hosts

LAM_ALEF_COMPRESSION_OFF

public static final java.lang.String LAM_ALEF_COMPRESSION_OFF

Lam_AlefCompression property value - Lam_AlefCompressionOff, this value only applies to Arabic hosts

SYM_SWAP

public static final java.lang.String SYM_SWAP

String value for Sym_Swap property keyword used in FileTransfer Bean

SYM_SWAP_ON

public static final java.lang.String SYM_SWAP_ON

Sym_Swap property value - Sym_SwapOn

SYM_SWAP_OFF

public static final java.lang.String SYM_SWAP_OFF

Sym_Swap property value - Sym_SwapOff

NUMERALS

public static final java.lang.String NUMERALS

String value for Numerals property keyword used in FileTransfer Bean , this property keyword only applies to Arabic Hosts

NUMERALS_NOMINAL

public static final java.lang.String NUMERALS_NOMINAL

Numerals property value - Numerals_Nominal, this value only applies to Arabic hosts

NUMERALS_NATIONAL

public static final java.lang.String NUMERALS_NATIONAL

Numerals property value - Numerals_National, this value only applies to Arabic hosts

NUMERALS_CONTEXTUAL

public static final java.lang.String NUMERALS_CONTEXTUAL

Numerals property value - Numerals_Contextual, this value only applies to Arabic hosts

ROUND_TRIP

public static final java.lang.String ROUND_TRIP

String value for Round_Trip property keyword used in FileTransfer Bean

ROUND_TRIP_ON

public static final java.lang.String ROUND_TRIP_ON

Round_Trip property value - Round_TripOn

ROUND_TRIP_OFF

public static final java.lang.String ROUND_TRIP_OFF

Round_Trip property value - Round_TripOff

Method Detail

SetHostFileOrientation

public void SetHostFileOrientation(java.lang.String hfo)
                            throws ECLErr

Set the BIDI HostFileOrientation property. This indicates whether the host file is in "left to right" style or "right to left" style.

Parameters:

one - of the following string constants:

• LEFT_TO_RIGHT
• RIGHT_TO_LEFT

Throws:

ECLErr - Thrown on improper value.

See Also:

GetHostFileOrientation(), LEFT_TO_RIGHT, RIGHT_TO_LEFT

GetHostFileOrientation

public java.lang.String GetHostFileOrientation()

Get the current setting of the BIDI HostFileOrientation property

Parameters:

one - of the following string constants:

• LEFT_TO_RIGHT
• RIGHT_TO_LEFT

See Also:

SetHostFileOrientation(java.lang.String), LEFT_TO_RIGHT, RIGHT_TO_LEFT

SetPCFileOrientation

public void SetPCFileOrientation(java.lang.String pfo)
                          throws ECLErr

Set the BIDI PCFileOrientation property. This indicates whether the workstation file being transferred is "left to right" style or "right to left" style.

Parameters:

one - of the following string constants:

• LEFT_TO_RIGHT
• RIGHT_TO_LEFT

Throws:

ECLErr - Thrown on improper value.

See Also:

GetPCFileOrientation(), LEFT_TO_RIGHT, RIGHT_TO_LEFT

GetPCFileOrientation

public java.lang.String GetPCFileOrientation()

Get the current setting of the BIDI PCFileOrientation property

Parameters:

one - of the following string constants:

• LEFT_TO_RIGHT
• RIGHT_TO_LEFT

See Also:

SetPCFileOrientation(java.lang.String), LEFT_TO_RIGHT, RIGHT_TO_LEFT

SetPCFileType

public void SetPCFileType(java.lang.String pft)
                   throws ECLErr

Set the BIDI PCFileType property. This indicates the type of the workstation file being transferred.

Parameters:

one - of the following string constants:

• VISUAL
• IMPLICIT

Throws:

ECLErr - Thrown on improper value.

See Also:

GetPCFileType(), VISUAL, IMPLICIT

GetPCFileType

public java.lang.String GetPCFileType()

Get the current setting of the BIDI PCFileType property

Returns:

one of the following string constants:

• VISUAL
• IMPLICIT

See Also:

SetPCFileType(java.lang.String), VISUAL, IMPLICIT

SetLam_AlefExpansion

public void SetLam_AlefExpansion(java.lang.String pft)
                          throws ECLErr

Set the BIDI Lam_AlefExpansion property. This indicates whether the Lam_Alef Expansion is in "ON" style or "OFF" style. This method only applies to Arabic hosts.

Parameters:

one - of the following string constants:

• LAM_ALEF_EXPANSION_ON
• LAM_ALEF_EXPANSION_OFF

Throws:

ECLErr - Thrown on improper value.

See Also:

GetLam_AlefExpansion(), LAM_ALEF_EXPANSION_ON, LAM_ALEF_EXPANSION_OFF

GetLam_AlefExpansion

public java.lang.String GetLam_AlefExpansion()

Get the current setting of the BIDI Lam_AlefExpansion property

Returns:

one of the following string constants:

• LAM_ALEF_EXPANSION_ON
• LAM_ALEF_EXPANSION_OFF

See Also:

SetLam_AlefExpansion(java.lang.String), LAM_ALEF_EXPANSION_ON, LAM_ALEF_EXPANSION_OFF

SetLam_AlefCompression

public void SetLam_AlefCompression(java.lang.String pft)
                            throws ECLErr

Set the BIDI Lam_AlefCompression property. This indicates whether the Lam_Alef Compression is in "ON" style or "OFF" style. This method only applies to Arabic hosts.

Parameters:

one - of the following string constants:

• LAM_ALEF_COMPRESSION_ON
• LAM_ALEF_COMPRESSION_OFF

Throws:

ECLErr - Thrown on improper value.

See Also:

GetLam_AlefCompression(), LAM_ALEF_COMPRESSION_ON, LAM_ALEF_COMPRESSION_OFF

GetLam_AlefCompression

public java.lang.String GetLam_AlefCompression()

Get the current setting of the BIDI Lam_AlefCompression property

Returns:

one of the following string constants:

• LAM_ALEF_COMPRESSION_ON
• LAM_ALEF_COMPRESSION_OFF

See Also:

SetLam_AlefCompression(java.lang.String), LAM_ALEF_COMPRESSION_ON, LAM_ALEF_COMPRESSION_OFF

SetSym_Swap

public void SetSym_Swap(java.lang.String pft)
                 throws ECLErr

Set the BIDI Symmetric Swapping property. This indicates whether the Symmetric Swapping is in "ON" style or "OFF" style.

Parameters:

one - of the following string constants:

• SYM_SWAP_ON
• SYM_SWAP_OFF

Throws:

ECLErr - Thrown on improper value.

See Also:

GetSym_Swap(), SYM_SWAP_ON, SYM_SWAP_OFF

GetSym_Swap

public java.lang.String GetSym_Swap()

Get the current setting of the BIDI Symmetric Swapping property

Returns:

one of the following string constants:

• SYM_SWAP_ON
• SYM_SWAP_OFF

See Also:

SetSym_Swap(java.lang.String), SYM_SWAP_ON, SYM_SWAP_OFF

SetNumerals

public void SetNumerals(java.lang.String pft)
                 throws ECLErr

Set the BIDI Numerals Shaping property. This indicates whether the Numerals Shaping is in "NOMINAL" style or "NATIONAL" style or "CONTEXTUAL" style. This method only applies to Arabic hosts.

Parameters:

one - of the following string constants:

• NUMERALS_NOMINAL
• NUMERALS_NATIONAL
• NUMERALS_CONTEXTUAL

Throws:

ECLErr - Thrown on improper value.

See Also:

GetNumerals(), NUMERALS_NOMINAL, NUMERALS_NATIONAL, NUMERALS_CONTEXTUAL

GetNumerals

public java.lang.String GetNumerals()

Get the current setting of the BIDI Numerals Shaping property

Returns:

one of the following string constants:

• NUMERALS_NOMINAL
• NUMERALS_NATIONAL
• NUMERALS_CONTEXTUAL

See Also:

SetNumerals(java.lang.String), NUMERALS_NOMINAL, NUMERALS_NATIONAL, NUMERALS_CONTEXTUAL

SetRound_Trip

public void SetRound_Trip(java.lang.String pft)
                   throws ECLErr

Set the BIDI Round Trip property. This indicates whether the RoundTrip is in "ON" style or "OFF" style.

Parameters:

one - of the following string constants:

• ROUND_TRIP_ON
• ROUND_TRIP_OFF

Throws:

ECLErr - Thrown on improper value.

See Also:

GetRound_Trip(), ROUND_TRIP_ON, ROUND_TRIP_OFF

GetRound_Trip

public java.lang.String GetRound_Trip()

Get the current setting of the BIDI Round Trip property

Returns:

one of the following string constants:

• ROUND_TRIP_ON
• ROUND_TRIP_OFF

See Also:

SetRound_Trip(java.lang.String), ROUND_TRIP_ON, ROUND_TRIP_OFF