RetrieveJournalEntries

java.lang.Object
- com.ibm.jtopenlite.command.program.CallServiceProgramProcedure
- - com.ibm.jtopenlite.command.program.journal.RetrieveJournalEntries

All Implemented Interfaces:: Program, CallServiceProgramParameterFormat

public class RetrieveJournalEntries
extends CallServiceProgramProcedure
implements CallServiceProgramParameterFormat

QJOURNAL.QjoRetrieveJournalEntries

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FORMAT_RJNE0100`
`static java.lang.String`	`FORMAT_RJNE0200`
`static int`	`KEY_COMMIT_CYCLE_IDENTIFIER` KEY_COMMIT_CYCLE_IDENTIFIER corresponds to CMTCYCID parameter of RCVJRNE Command.
`static int`	`KEY_DEPENDENT_ENTRIES` KEY_DEPENDENT_ENTRIES corresponds to DEPENT parameter of RCVJRNE Command.
`static int`	`KEY_DIRECTORY_SUBTREE` KEY_DIRECTORY_SUBTREE corresponds to SUBTREE parameter of RCVJRNE Command.
`static int`	`KEY_ENDING_SEQUENCE_NUMBER` KEY_ENDING_SEQUENCE_NUMBER corresponds to TOENT parameter of RCVJRNE Command.
`static int`	`KEY_ENDING_TIME_STAMP` KEY_ENDING_TIME_STAMP corresponds to TOTIME parameter of RCVJRNE Command.
`static int`	`KEY_FILE` KEY_FILE corresponds to FILE parameter of RCVJRNE Command.
`static int`	`KEY_FORMAT_MINIMIZED_DATA` KEY_FORMAT_MINIMIZED_DATA corresponds to FMTMINDTA parameter of RCVJRNE Command.
`static int`	`KEY_INCLUDE_ENTRIES` KEY_INCLUDE_ENTRIES corresponds to INCENT parameter of RCVJRNE Command.
`static int`	`KEY_JOB` KEY_JOB corresponds to JOB parameter of RCVJRNE Command.
`static int`	`KEY_JOURNAL_CODES` KEY_JOURNAL_CODES corresponds to JRNCDE parameter of RCVJRNE Command.
`static int`	`KEY_JOURNAL_ENTRY_TYPES` KEY_JOURNAL_ENTRY_TYPES corresponds to ENTTYP parameter of RCVJRNE Command.
`static int`	`KEY_NAME_PATTERN` KEY_NAME_PATTERN corresponds to PATTERN parameter of RCVJRNE Command.
`static int`	`KEY_NULL_VALUE_INDICATORS_LENGTH` KEY_NULL_VALUE_INDICATORS_LENGTH corresponds to NULLINDLEN parameter of RCVJRNE Command.
`static int`	`KEY_NUMBER_OF_ENTRIES` KEY_NUMBER_OF_ENTRIES corresponds to NBRENT parameter of RCVJRNE Command.
`static int`	`KEY_OBJECT` KEY_OBJECT corresponds to OBJ parameter of RCVJRNE Command.
`static int`	`KEY_OBJECT_FILE_IDENTIFIER` KEY_OBJECT_FILE_IDENTIFIER corresponds to OBJFID parameter of RCVJRNE Command.
`static int`	`KEY_OBJECT_PATH` KEY_OBJECT_PATH corresponds to OBJPATH parameter of RCVJRNE Command.
`static int`	`KEY_PROGRAM` KEY_PROGRAM corresponds to PGM parameter of RCVJRNE Command.
`static int`	`KEY_RANGE_OF_JOURNAL_RECEIVERS` KEY_RANGE_OF_JOURNAL_RECEIVERS corresponds to RCVRNG parameter of RCVJRNE Command.
`static int`	`KEY_STARTING_SEQUENCE_NUMBER` KEY_STARTING_SEQUENCE_NUMBER corresponds to FROMENT parameter of RCVJRNE Command.
`static int`	`KEY_STARTING_TIME_STAMP` KEY_STARTING_TIME_STAMP corresponds to FROMTIME parameter of RCVJRNE Command.
`static int`	`KEY_USER_PROFILE` KEY_USER_PROFILE corresponds to USRPRF parameter of RCVJRNE Command.

Fields inherited from class com.ibm.jtopenlite.command.program.CallServiceProgramProcedure
RETURN_VALUE_FORMAT_INTEGER, RETURN_VALUE_FORMAT_INTEGER_AND_ERROR_NUMBER, RETURN_VALUE_FORMAT_NONE, RETURN_VALUE_FORMAT_POINTER

Fields inherited from interface com.ibm.jtopenlite.command.program.CallServiceProgramParameterFormat
PARAMETER_FORMAT_BY_REFERENCE, PARAMETER_FORMAT_BY_VALUE

Constructor Summary

Constructors
Constructor and Description
`RetrieveJournalEntries()`
`RetrieveJournalEntries(int lengthOfReceiverVariable, java.lang.String journalName, java.lang.String journalLibrary, java.lang.String format, RetrieveJournalEntriesListener listener)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`fillInputData(int parmIndex, byte[] buffer, int offset)` This method is used to fill an output buffer with the parameter information before the procedure is called.
`java.lang.String`	`getFormatName()`
`java.lang.String`	`getJournalLibrary()`
`java.lang.String`	`getJournalName()`
`int`	`getLengthOfReceiverVariable()`
`RetrieveJournalEntriesListener`	`getListener()`
`int`	`getParameterCount()` This method is called to get the number of parameters used by the service program procedure call.
`int`	`getParameterFormat(int parmIndex)` This method is used to obtain the format of the specified parameter
`int`	`getParameterLength(int parmIndex)` This method is used to obtain the length of the specified parameter
`RetrieveJournalEntriesSelectionListener`	`getSelectionListener()`
`void`	`setFormatName(java.lang.String format)`
`void`	`setJournalLibrary(java.lang.String lib)`
`void`	`setJournalName(java.lang.String name)`
`void`	`setLengthOfReceiverVariable(int length)`
`void`	`setListener(RetrieveJournalEntriesListener listener)`
`void`	`setOutputData(int parmIndex, byte[] buffer, int offset)` This method is used to set the internal value of the parameter from a dataBuffer
`void`	`setSelectionListener(RetrieveJournalEntriesSelectionListener selection)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FORMAT_RJNE0100
```
public static final java.lang.String FORMAT_RJNE0100
```
    See Also:
    Constant Field Values
  - FORMAT_RJNE0200
```
public static final java.lang.String FORMAT_RJNE0200
```
    See Also:
    Constant Field Values
  - KEY_RANGE_OF_JOURNAL_RECEIVERS
```
public static final int KEY_RANGE_OF_JOURNAL_RECEIVERS
```
    KEY_RANGE_OF_JOURNAL_RECEIVERS corresponds to RCVRNG parameter of RCVJRNE Command. Type is CHAR(40)
    
    See Also:
    Constant Field Values
  - KEY_STARTING_SEQUENCE_NUMBER
```
public static final int KEY_STARTING_SEQUENCE_NUMBER
```
    KEY_STARTING_SEQUENCE_NUMBER corresponds to FROMENT parameter of RCVJRNE Command. Type is CHAR(20)
    
    See Also:
    Constant Field Values
  - KEY_STARTING_TIME_STAMP
```
public static final int KEY_STARTING_TIME_STAMP
```
    KEY_STARTING_TIME_STAMP corresponds to FROMTIME parameter of RCVJRNE Command. Type is CHAR(26)
    
    See Also:
    Constant Field Values
  - KEY_ENDING_SEQUENCE_NUMBER
```
public static final int KEY_ENDING_SEQUENCE_NUMBER
```
    KEY_ENDING_SEQUENCE_NUMBER corresponds to TOENT parameter of RCVJRNE Command. Type is CHAR(20)
    
    See Also:
    Constant Field Values
  - KEY_ENDING_TIME_STAMP
```
public static final int KEY_ENDING_TIME_STAMP
```
    KEY_ENDING_TIME_STAMP corresponds to TOTIME parameter of RCVJRNE Command. Type is CHAR(26)
    
    See Also:
    Constant Field Values
  - KEY_NUMBER_OF_ENTRIES
```
public static final int KEY_NUMBER_OF_ENTRIES
```
    KEY_NUMBER_OF_ENTRIES corresponds to NBRENT parameter of RCVJRNE Command. Type is BINARY(4)
    
    See Also:
    Constant Field Values
  - KEY_JOURNAL_CODES
```
public static final int KEY_JOURNAL_CODES
```
    KEY_JOURNAL_CODES corresponds to JRNCDE parameter of RCVJRNE Command. Type is CHAR(*)
    
    See Also:
    Constant Field Values
  - KEY_JOURNAL_ENTRY_TYPES
```
public static final int KEY_JOURNAL_ENTRY_TYPES
```
    KEY_JOURNAL_ENTRY_TYPES corresponds to ENTTYP parameter of RCVJRNE Command. Type is CHAR(*)
    
    See Also:
    Constant Field Values
  - KEY_JOB
```
public static final int KEY_JOB
```
    KEY_JOB corresponds to JOB parameter of RCVJRNE Command. Type is CHAR(26)
    
    See Also:
    Constant Field Values
  - KEY_PROGRAM
```
public static final int KEY_PROGRAM
```
    KEY_PROGRAM corresponds to PGM parameter of RCVJRNE Command. Type is CHAR(10)
    
    See Also:
    Constant Field Values
  - KEY_USER_PROFILE
```
public static final int KEY_USER_PROFILE
```
    KEY_USER_PROFILE corresponds to USRPRF parameter of RCVJRNE Command. Type is CHAR(10)
    
    See Also:
    Constant Field Values
  - KEY_COMMIT_CYCLE_IDENTIFIER
```
public static final int KEY_COMMIT_CYCLE_IDENTIFIER
```
    KEY_COMMIT_CYCLE_IDENTIFIER corresponds to CMTCYCID parameter of RCVJRNE Command. Type is CHAR(20)
    
    See Also:
    Constant Field Values
  - KEY_DEPENDENT_ENTRIES
```
public static final int KEY_DEPENDENT_ENTRIES
```
    KEY_DEPENDENT_ENTRIES corresponds to DEPENT parameter of RCVJRNE Command. Type is CHAR(10)
    
    See Also:
    Constant Field Values
  - KEY_INCLUDE_ENTRIES
```
public static final int KEY_INCLUDE_ENTRIES
```
    KEY_INCLUDE_ENTRIES corresponds to INCENT parameter of RCVJRNE Command. Type is CHAR(10)
    
    See Also:
    Constant Field Values
  - KEY_NULL_VALUE_INDICATORS_LENGTH
```
public static final int KEY_NULL_VALUE_INDICATORS_LENGTH
```
    KEY_NULL_VALUE_INDICATORS_LENGTH corresponds to NULLINDLEN parameter of RCVJRNE Command. Type is CHAR(10)
    
    See Also:
    Constant Field Values
  - KEY_FILE
```
public static final int KEY_FILE
```
    KEY_FILE corresponds to FILE parameter of RCVJRNE Command. Type is CHAR(*)
    
    See Also:
    Constant Field Values
  - KEY_OBJECT
```
public static final int KEY_OBJECT
```
    KEY_OBJECT corresponds to OBJ parameter of RCVJRNE Command. Type is CHAR(*)
    
    See Also:
    Constant Field Values
  - KEY_OBJECT_PATH
```
public static final int KEY_OBJECT_PATH
```
    KEY_OBJECT_PATH corresponds to OBJPATH parameter of RCVJRNE Command. Type is CHAR(*)
    
    See Also:
    Constant Field Values
  - KEY_OBJECT_FILE_IDENTIFIER
```
public static final int KEY_OBJECT_FILE_IDENTIFIER
```
    KEY_OBJECT_FILE_IDENTIFIER corresponds to OBJFID parameter of RCVJRNE Command. Type is CHAR(*)
    
    See Also:
    Constant Field Values
  - KEY_DIRECTORY_SUBTREE
```
public static final int KEY_DIRECTORY_SUBTREE
```
    KEY_DIRECTORY_SUBTREE corresponds to SUBTREE parameter of RCVJRNE Command. Type is CHAR(5)
    
    See Also:
    Constant Field Values
  - KEY_NAME_PATTERN
```
public static final int KEY_NAME_PATTERN
```
    KEY_NAME_PATTERN corresponds to PATTERN parameter of RCVJRNE Command. Type is CHAR(*)
    
    See Also:
    Constant Field Values
  - KEY_FORMAT_MINIMIZED_DATA
```
public static final int KEY_FORMAT_MINIMIZED_DATA
```
    KEY_FORMAT_MINIMIZED_DATA corresponds to FMTMINDTA parameter of RCVJRNE Command. Type is CHAR(10)
    
    See Also:
    Constant Field Values
- Constructor Detail
  - RetrieveJournalEntries
```
public RetrieveJournalEntries()
```
  - RetrieveJournalEntries
```
public RetrieveJournalEntries(int lengthOfReceiverVariable,
                      java.lang.String journalName,
                      java.lang.String journalLibrary,
                      java.lang.String format,
                      RetrieveJournalEntriesListener listener)
```
- Method Detail
  - getSelectionListener
```
public RetrieveJournalEntriesSelectionListener getSelectionListener()
```
  - setSelectionListener
```
public void setSelectionListener(RetrieveJournalEntriesSelectionListener selection)
```
  - getParameterCount
```
public int getParameterCount()
```
    Description copied from interface: CallServiceProgramParameterFormat
    
    This method is called to get the number of parameters used by the service program procedure call.
    
    Specified by:
    
    getParameterCount in interface CallServiceProgramParameterFormat
    
    Returns:
    parameterCount
  - getParameterLength
```
public int getParameterLength(int parmIndex)
```
    Description copied from interface: CallServiceProgramParameterFormat
    
    This method is used to obtain the length of the specified parameter
    
    Specified by:
    
    getParameterLength in interface CallServiceProgramParameterFormat
    
    Parameters:
    parmIndex - 0-based parameter identifier.
    
    Returns:
    parameter length
  - getParameterFormat
```
public int getParameterFormat(int parmIndex)
```
    Description copied from interface: CallServiceProgramParameterFormat
    
    This method is used to obtain the format of the specified parameter
    
    Specified by:
    
    getParameterFormat in interface CallServiceProgramParameterFormat
    
    Parameters:
    parmIndex - 0-based parameter identifier.
    
    Returns:
    parameter format which is one of the following: PARAMETER_FORMAT_BY_VALUE PARAMETER_FORMAT_BY_REFERENCE
  - fillInputData
```
public void fillInputData(int parmIndex,
                 byte[] buffer,
                 int offset)
```
    Description copied from interface: CallServiceProgramParameterFormat
    
    This method is used to fill an output buffer with the parameter information before the procedure is called.
    
    Specified by:
    
    fillInputData in interface CallServiceProgramParameterFormat
    
    Parameters:
    parmIndex - 0-based parameter identifier
    buffer - buffer containing the data
    offset - offset to where the data should be placed
  - setOutputData
```
public void setOutputData(int parmIndex,
                 byte[] buffer,
                 int offset)
```
    Description copied from interface: CallServiceProgramParameterFormat
    
    This method is used to set the internal value of the parameter from a dataBuffer
    
    Specified by:
    
    setOutputData in interface CallServiceProgramParameterFormat
    
    Parameters:
    parmIndex - 0-based parameter identifier
    buffer - buffer containing the data
    offset - offset to where the data should be retrieved
  - getLengthOfReceiverVariable
```
public int getLengthOfReceiverVariable()
```
  - setLengthOfReceiverVariable
```
public void setLengthOfReceiverVariable(int length)
```
  - getJournalName
```
public java.lang.String getJournalName()
```
  - setJournalName
```
public void setJournalName(java.lang.String name)
```
  - getJournalLibrary
```
public java.lang.String getJournalLibrary()
```
  - setJournalLibrary
```
public void setJournalLibrary(java.lang.String lib)
```
  - getFormatName
```
public java.lang.String getFormatName()
```
  - setFormatName
```
public void setFormatName(java.lang.String format)
```
  - getListener
```
public RetrieveJournalEntriesListener getListener()
```
  - setListener
```
public void setListener(RetrieveJournalEntriesListener listener)
```

Fields inherited from class com.ibm.jtopenlite.command.program.CallServiceProgramProcedure

Fields inherited from interface com.ibm.jtopenlite.command.program.CallServiceProgramParameterFormat

Methods inherited from class com.ibm.jtopenlite.command.program.CallServiceProgramProcedure

Methods inherited from class java.lang.Object

FORMAT_RJNE0100

FORMAT_RJNE0200

KEY_RANGE_OF_JOURNAL_RECEIVERS

KEY_STARTING_SEQUENCE_NUMBER

KEY_STARTING_TIME_STAMP

KEY_ENDING_SEQUENCE_NUMBER

KEY_ENDING_TIME_STAMP

KEY_NUMBER_OF_ENTRIES

KEY_JOURNAL_CODES

KEY_JOURNAL_ENTRY_TYPES

KEY_JOB

KEY_PROGRAM

KEY_USER_PROFILE

KEY_COMMIT_CYCLE_IDENTIFIER

KEY_DEPENDENT_ENTRIES

KEY_INCLUDE_ENTRIES

KEY_NULL_VALUE_INDICATORS_LENGTH

KEY_FILE

KEY_OBJECT

KEY_OBJECT_PATH

KEY_OBJECT_FILE_IDENTIFIER

KEY_DIRECTORY_SUBTREE

KEY_NAME_PATTERN

KEY_FORMAT_MINIMIZED_DATA

RetrieveJournalEntries

RetrieveJournalEntries

getSelectionListener

setSelectionListener

getParameterCount

getParameterLength

getParameterFormat

fillInputData

setOutputData

getLengthOfReceiverVariable

setLengthOfReceiverVariable

getJournalName

setJournalName

getJournalLibrary

setJournalLibrary

getFormatName

setFormatName

getListener

setListener