LobCopyParameter (P2J - Progress 4GL to Java Conversion and Runtime)

All Known Implementing Classes:

LobCopyInput, LobCopyOutput, SourceLob, SourceLobFile, TargetLob, TargetLobFile
```
public interface LobCopyParameter
```
A parameter of a converted COPY-LOB statement.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TYPE_BLOB` The type identifier for a BLOB field.
`static int`	`TYPE_CHAR_BIT` A marker bit for easy filtering character LOBs.
`static int`	`TYPE_CLOB` The type identifier for a CLOB field.
`static int`	`TYPE_FIELD_BIT` A marker bit for easy filtering field LOBs.
`static int`	`TYPE_FILE` The type identifier for a FILE.
`static int`	`TYPE_LONGCHAR` The type identifier for a LONGCHAR variable.
`static int`	`TYPE_MEMPTR` The type identifier for a MEMPTR variable.
`static int`	`TYPE_UNKNOWN` The unknown type of LOB.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default java.lang.String`	`getCodePage()` Get the code page of this parameter, if any.
`int`	`getObjectType()` Obtain the type of the object wrapped by this parameter
`default boolean`	`isCharacterData()` Indicate whether the large object represented by this parameter natively represents encoded character data, as opposed to binary data.
`default boolean`	`isLargeObject()` Indicate whether this object is a valid large object data type.
`default boolean`	`validate(int peerType)` Validate this parameter.
`default boolean`	`validateOffset(int peerType)` Checks if the optional offset is valid.

- Field Detail
  - TYPE_UNKNOWN
```
static final int TYPE_UNKNOWN
```
    The unknown type of LOB. Its occurrence means something went wrong.
    
    See Also:
    
    Constant Field Values
  - TYPE_FIELD_BIT
```
static final int TYPE_FIELD_BIT
```
    A marker bit for easy filtering field LOBs. There are only two of them: CLOBs and BLOBs.
    
    See Also:
    
    Constant Field Values
  - TYPE_CHAR_BIT
```
static final int TYPE_CHAR_BIT
```
    A marker bit for easy filtering character LOBs. There are only two of them: CLOBs and LONGCHARs.
    
    See Also:
    
    Constant Field Values
  - TYPE_CLOB
```
static final int TYPE_CLOB
```
    The type identifier for a CLOB field. This contains both the
    
    See Also:
    
    Constant Field Values
  - TYPE_BLOB
```
static final int TYPE_BLOB
```
    The type identifier for a BLOB field.
    
    See Also:
    
    Constant Field Values
  - TYPE_FILE
```
static final int TYPE_FILE
```
    The type identifier for a FILE.
    
    See Also:
    
    Constant Field Values
  - TYPE_LONGCHAR
```
static final int TYPE_LONGCHAR
```
    The type identifier for a LONGCHAR variable.
    
    See Also:
    
    Constant Field Values
  - TYPE_MEMPTR
```
static final int TYPE_MEMPTR
```
    The type identifier for a MEMPTR variable.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isLargeObject
```
default boolean isLargeObject()
```
    Indicate whether this object is a valid large object data type. It is possible to pass a POLY which is not a valid LOB type as a COPY-LOB parameter, and this error must be determined at runtime.
    
    Returns:
    
    true if valid, else false. The default implementation assumes validity; implementors which must handle runtime type verification must override this method.
  - isCharacterData
```
default boolean isCharacterData()
```
    Indicate whether the large object represented by this parameter natively represents encoded character data, as opposed to binary data.
    
    Returns:
    
    true if character data; false if binary data.
  - getCodePage
```
default java.lang.String getCodePage()
```
    Get the code page of this parameter, if any.
    
    Returns:
    
    4GL code page name or null if parameter represents non-character data.
  - validateOffset
```
default boolean validateOffset(int peerType)
```
    Checks if the optional offset is valid.
    
    Parameters:
    
    peerType - The type of the source or target peer object. The error messages are different in some cases.
    
    Returns:
    
    true if the optional offset is valid.
  - validate
```
default boolean validate(int peerType)
```
    Validate this parameter.
    
    Parameters:
    
    peerType - The type of the peer object. The error messages might be different in some cases.
    
    Returns:
    
    true if validation did not encounter any issue and false otherwise, when in NO-ERROR mode and the ErrorConditionException is not thrown.
    
    Throws:
    
    ErrorConditionException - if the parameter fails validation and silent error mode is not active.
  - getObjectType
```
int getObjectType()
```
    Obtain the type of the object wrapped by this parameter
    
    Returns:
    
    The numerical id of a type declared as one of the TYPE static constants above.

Interface LobCopyParameter

Field Summary

Method Summary

Field Detail

TYPE_UNKNOWN

TYPE_FIELD_BIT

TYPE_CHAR_BIT

TYPE_CLOB

TYPE_BLOB

TYPE_FILE

TYPE_LONGCHAR

TYPE_MEMPTR

Method Detail

isLargeObject

isCharacterData

getCodePage

validateOffset

validate

getObjectType