public interface SSAList
SSAList
interface represents a list of segment search
arguments used to specify the segments to target in a particular database
call.
Use the SSAList
interface to construct each segment search
argument in the list, and to set the command codes and lock class for the
segment search arguments. The segments can be referenced by name or by using
the 1-based offset of the SSA representing that segment within the
SSAList
.
getPathForRetrieveReplace()
getPathForInsert(String)
getPathForBatchUpdate(String)
In addition, your application can specify which segment fields are to be
returned from a database retrieve call by using the
markFieldForRetrieval
or the
markAllFieldsForRetrieval
methods.
For code examples of how to create and use SSAList
, see:
PCB.getUnique(Path, SSAList, boolean)
,
PCB.batchRetrieve(SSAList)
, PCB.batchUpdate(Path, SSAList)
,
PCB.batchDelete(SSAList)
, PCB.create(Path, SSAList)
,
PCB.replace(Path)
, PCB.delete(SSAList)
,
createPreparedValue(String)
,
PCB.insert(Path, SSAList)
,
markFieldForRetrieval(int, String, boolean)
,
markFieldForRetrieval(String, String, boolean)
,
markAllFieldsForRetrieval(int, boolean)
,
markAllFieldsForRetrieval(String, boolean)
.
Path
,
PCB
,
PreparedValue
Modifier and Type | Field and Description |
---|---|
static byte |
AND
Constant indicating the boolean operator
AND in an SSA
qualification statement |
static byte |
CC_A
Constant indicating the A command code (clear position)
|
static byte |
CC_D
Constant indicating the D command code (path call)
|
static byte |
CC_F
Constant indicating the F command code (first occurrence)
|
static byte |
CC_G
Constant indicating the G command code (no randomization)
|
static byte |
CC_L
Constant indicating the L command code (last occurrence)
|
static byte |
CC_N
Constant indicating the N command code (path call ignore)
|
static byte |
CC_O
Constant indicating the O command code (set parentage)
|
static byte |
CC_P
Constant indicating the P command code (set parentage)
|
static byte |
CC_U
Constant indicating the U command code (maintain position at this level)
|
static byte |
CC_V
Constant indicating the V command code (maintain position at this level
and all superior levels)
|
static short |
EQUALS
Constant indicating the relational operator for equals (=) in an SSA
qualification statement
|
static short |
GREATER_OR_EQUAL
Constant indicating the relational operator for greater than or equal to
(>=) in an SSA qualification statement
|
static short |
GREATER_THAN
Constant indicating the relational operator for greater than (>) in an
SSA qualification statement
|
static byte |
INDEPENDENT_AND
Constant indicating the boolean operator
INDEPENDENT AND in
an SSA qualification statement |
static byte |
LC_A
Constant indicating lock class A
|
static byte |
LC_B
Constant indicating lock class B
|
static byte |
LC_C
Constant indicating lock class C
|
static byte |
LC_D
Constant indicating lock class D
|
static byte |
LC_E
Constant indicating lock class E
|
static byte |
LC_F
Constant indicating lock class F
|
static byte |
LC_G
Constant indicating lock class G
|
static byte |
LC_H
Constant indicating lock class H
|
static byte |
LC_I
Constant indicating lock class I
|
static byte |
LC_J
Constant indicating lock class J
|
static short |
LESS_OR_EQUAL
Constant indicating the relational operator for less than or equal to
(<=) in an SSA qualification statement
|
static short |
LESS_THAN
Constant indicating the relational operator for less than (<) in an SSA
qualification statement
|
static short |
NOT_EQUAL
Constant indicating the relational operator for not equal to (!=) in an
SSA qualification statement
|
static byte |
OR
Constant indicating the boolean operator
OR in an SSA
qualification statement |
Modifier and Type | Method and Description |
---|---|
void |
addCommandCode(int ssaLevel,
byte commandCode)
Add a command code to the
SSAList |
void |
addCommandCode(java.lang.String segmentName,
byte commandCode)
Add a command code to the
SSAList . |
void |
addConcatenatedKey(int ssaLevel,
byte[] concatenatedKey)
Adds command code C and the concatenated key to the
SSAList . |
void |
addConcatenatedKey(java.lang.String segmentName,
byte[] concatenatedKey)
Adds command code C and the concatenated key to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
java.math.BigDecimal value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
boolean value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
byte value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
byte[] value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
java.sql.Date value)
Add the initial qualifiation statement to the
SSAList |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
double value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
float value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
int value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
long value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
java.lang.Object value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
PreparedValue value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
short value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
java.lang.String value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
java.sql.Time value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(int ssaLevel,
java.lang.String fieldName,
short relationalOp,
java.sql.Timestamp value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
java.math.BigDecimal value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
boolean value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
byte value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
byte[] value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
java.sql.Date value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
double value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
float value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
int value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
long value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
java.lang.Object value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
PreparedValue value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
short value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
java.lang.String value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
java.sql.Time value)
Add the initial qualifiation statement to the
SSAList . |
void |
addInitialQualification(java.lang.String segmentName,
java.lang.String fieldName,
short relationalOp,
java.sql.Timestamp value)
Add the initial qualifiation statement to the
SSAList . |
void |
addLockClass(int ssaLevel,
byte lockClass)
Adds a lock class to the
SSAList . |
void |
addLockClass(java.lang.String segmentName,
byte lockClass)
Adds a lock class to the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.math.BigDecimal value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
boolean value)
Append a qualifiation statement to the specified
SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
byte[] value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.sql.Date value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
float value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
int value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
long value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.lang.Object value)
Append a qualifiation statement to the specified
SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
PreparedValue value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
short value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.lang.String value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.sql.Time value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(int ssaLevel,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.sql.Timestamp value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.math.BigDecimal value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
boolean value)
Add the initial qualifiation statement to the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
byte[] value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.sql.Date value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
float value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
int value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
long value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.lang.Object value)
Add the initial qualifiation statement to the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
PreparedValue value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
short value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.lang.String value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.sql.Time value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
void |
appendQualification(java.lang.String segmentName,
byte booleanOp,
java.lang.String fieldName,
short relationalOp,
java.sql.Timestamp value)
Append a qualifiation statement to the specified SSA in the
SSAList . |
byte[][] |
buildSSAListInBytes()
Builds the
SSAList in proper DL/I format. |
PreparedValue |
createPreparedValue(java.lang.String name)
This method is used when the value of a field in a qualification
statement isn't known until runtime.
|
Path |
getPathForBatchUpdate(java.lang.String segmentName)
Returns a
Path that contains a one or more database segments
along a hierarchic path for a batch update operation. |
Path |
getPathForInsert(java.lang.String segmentName)
Returns a
Path that contains one or more database segments
along a hierarchich path for an insert operation. |
Path |
getPathForRetrieveReplace()
Returns a
Path that contains all segments with fields marked
for retrieval. |
PreparedValue |
getPreparedValue(java.lang.String name)
Returns a previously created
PreparedValue object. |
java.util.Collection<PreparedValue> |
getPreparedValues()
Returns a
Collection of all previously created
PreparedValue objects with this SSAList |
boolean |
hasCommandCode(int ssaLevel,
byte commandCode)
Checks to see if a command code is present in the
SSAList . |
boolean |
hasCommandCode(java.lang.String segmentName,
byte commandCode)
Checks to see if a command code is present in the
SSAList . |
void |
markAllFieldsForRetrieval(int ssaLevel,
boolean enableRetrieval)
This method is used to mark all fields in the specified segment for
retrieval from the database.
|
void |
markAllFieldsForRetrieval(java.lang.String segmentName,
boolean enableRetrieval)
This method is used to mark all fields in the specified segment for
retrieval from the database.
|
void |
markFieldForRetrieval(int ssaLevel,
java.lang.String fieldName,
boolean enableRetrieval)
This method is used to mark a specific field for retrieval from the
database.
|
void |
markFieldForRetrieval(java.lang.String segmentName,
java.lang.String fieldName,
boolean enableRetrieval)
This method is used to mark a specific field for retrieval from the
database.
|
void |
removeAllCommandCodes(int ssaLevel)
Removes all command codes from the
SSAList . |
void |
removeAllCommandCodes(java.lang.String segmentName)
Removes all command codes from the
SSAList . |
void |
removeAllQualificationStatements(int ssaLevel)
Removes all qualification statements from the
SSAList . |
void |
removeAllQualificationStatements(java.lang.String segmentName)
Removes all qualification statements from the
SSAList . |
void |
removeCommandCode(int ssaLevel,
byte commandCode)
Remove a command code from the
SSAList . |
void |
removeCommandCode(java.lang.String segmentName,
byte commandCode)
Remove a command code from the
SSAList . |
void |
removeLockClass(int ssaLevel)
Removes the lock class from the
SSAList . |
void |
removeLockClass(java.lang.String segmentName)
Removes the lock class from the
SSAList . |
static final short EQUALS
static final short GREATER_OR_EQUAL
static final short LESS_OR_EQUAL
static final short GREATER_THAN
static final short LESS_THAN
static final short NOT_EQUAL
static final byte AND
AND
in an SSA
qualification statementstatic final byte OR
OR
in an SSA
qualification statementstatic final byte INDEPENDENT_AND
INDEPENDENT AND
in
an SSA qualification statementstatic final byte CC_A
static final byte CC_D
static final byte CC_F
static final byte CC_G
static final byte CC_L
static final byte CC_N
static final byte CC_O
static final byte CC_P
static final byte CC_U
static final byte CC_V
static final byte LC_A
static final byte LC_B
static final byte LC_C
static final byte LC_D
static final byte LC_E
static final byte LC_F
static final byte LC_G
static final byte LC_H
static final byte LC_I
static final byte LC_J
Path getPathForRetrieveReplace()
Path
that contains all segments with fields marked
for retrieval. If no fields are marked for retrieval and the
getPathForRetrieveReplace
method is called, the
Path
instance will contain the fields in the lowest level
segment. The getPathForRetrieveReplace
method can be used
together with the data retrieval methods in the PCB
interface or
with the replace methods to update data.
For code examples of how to use this method, refer to the related
PCB
methods in the Javadoc.
Path
containing the database segments and member
fields.PCB.getUnique(Path, SSAList, boolean)
,
PCB.getNextWithinParent(Path, SSAList, boolean)
,
PCB.getNext(Path, SSAList, boolean)
,
PCB.replace(Path)
,
PCB.replace(Path, SSAList)
Path getPathForInsert(java.lang.String segmentName) throws DLIException
Path
that contains one or more database segments
along a hierarchich path for an insert operation. The
getPathForInsert
method is used together with the insert
method in the PCB
interface to insert new segments in the
database.
For a code example of how to use this method, refer to the related
PCB
method in the Javadoc.
segmentName
- the name of a segment that currently exists in this
SSAList
. The segment search arguments in this
SSAList
must be unqualified, otherwise an
exception is thrownPath
containing the database segment specified
as input, as well as its children segments down to the leaf-most
segment along the hierarchic path indicated by this
SSAList
DLIException
- if an error occurs during processingPCB.insert(Path, SSAList)
Path getPathForBatchUpdate(java.lang.String segmentName) throws DLIException
Path
that contains a one or more database segments
along a hierarchic path for a batch update operation. The
getPathForBatchUpdate
method is used together with
PCB.batchUpdate(Path, SSAList)
to update multiple segment
instances in a database in a single network call. In a batch update
operation, the host will do a GU/GN loop and inside the loop perform the
updates until there are no more segments to update and then return the
number of records updated.
The segmentName
parameter indicates the topmost segment to
be updated in the database. Its children segments are included in the
returned Path
.
For a code example of how to use this method, refer to the related
PCB
method in the Javadoc.
segmentName
- the name of a segment that currently exists in this
SSAList
Path
containing the database segment specified
as input, as well as its children segments down to the leaf-most
segment along the hierarchic path indicated by this
SSAList
DLIException
- if an error occurs during processingPCB.batchUpdate(Path,SSAList)
void addCommandCode(java.lang.String segmentName, byte commandCode) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
commandCode
- the command code to addDLIException
- if an error occurs during processingvoid addCommandCode(int ssaLevel, byte commandCode) throws DLIException
SSAList
ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the command code tocommandCode
- the command code to addDLIException
- if an error occurs during processingvoid addConcatenatedKey(java.lang.String segmentName, byte[] concatenatedKey) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
command code toconcatenatedKey
- the concatenated keyDLIException
- if an error occurs during processingvoid addConcatenatedKey(int ssaLevel, byte[] concatenatedKey) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the command code toconcatenatedKey
- the concatenated keyDLIException
- if an error occurs during processingvoid removeCommandCode(java.lang.String segmentName, byte commandCode) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
commandCode
- the command code to removeDLIException
- if an error occurs during processingvoid removeCommandCode(int ssaLevel, byte commandCode) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
remove the command code fromcommandCode
- the command code to removeDLIException
- if an error occurs during processingboolean hasCommandCode(java.lang.String segmentName, byte commandCode) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
commandCode
- the command code to checktrue
if the command code exists in the
SSA
for the specified segment, false
otherwiseDLIException
- if an error occurs during processingboolean hasCommandCode(int ssaLevel, byte commandCode) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
commandCode
- the command code to checktrue
if the command code exists in the
SSA
for the specified segment, false
otherwiseDLIException
- if an error occurs during processingvoid addLockClass(java.lang.String segmentName, byte lockClass) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
lockClass
- the lock class to addDLIException
- if an error occurs during processingvoid addLockClass(int ssaLevel, byte lockClass) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
lockClass
- the lock class to addDLIException
- if an error occurs during processingvoid removeLockClass(java.lang.String segmentName) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
DLIException
- if an error occurs during processingvoid removeLockClass(int ssaLevel) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
DLIException
- if an error occurs during processingvoid removeAllCommandCodes(java.lang.String segmentName) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
DLIException
- if an error occurs during processingvoid removeAllCommandCodes(int ssaLevel) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
DLIException
- if an error occurs during processingvoid removeAllQualificationStatements(java.lang.String segmentName) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
DLIException
- if an error occurs during processingvoid removeAllQualificationStatements(int ssaLevel) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
DLIException
- if an error occurs during processingvoid markFieldForRetrieval(java.lang.String segmentName, java.lang.String fieldName, boolean enableRetrieval) throws DLIException
markFieldForRetrieval
method is used together
with getPathForRetrieveReplace()
and with the data
retrieval methods in the PCB
interface. When a retrieve call is
made, the resulting Path
object will contain all the fields
that have been marked for retrieval. Following the IMS default, all of
the fields in the lowest level segment specified by the
SSAList
are inititally marked for retrieval.
The following code example shows how to mark and retrieve the ward number and patient name fields from the WARD and PATIENT segments. The WARD, PATIENT, and ILLNESS segments are located in decreasing hierarchic order below the HOSPITAL segment where HOSPNAME is equal to "SANTA TERESA". By default, the retrieval operation also returns all the fields of the ILLNESS segment (ILLLL and ILLNAME).
SSAList ssaList = pcb.getSSAList("HOSPITAL", "ILLNESS"); ssaList.addInitialQualification("HOSPITAL", "HOSPNAME", SSAList.EQUALS, "SANTA TERESA"); ssaList.markFieldForRetrieval("WARD", "WARDNO", true); ssaList.markFieldForRetrieval("PATIENT", "PATNAME", true); Path path = ssaList.getPathForRetrieveReplace(); pcb.getUnique(path, ssaList, false);
When one or more of the fields in the lowest level segment specified in
an SSAList
is marked for retrieval, only the explicitly
marked fields are retrieved.
The following code example shows how to mark and retrieve a single field
ILLNAME from the ILLNESS segment where ILLNESS is the lowest level
segment specified in the SSAList
instance. The retrieval
operation returns no other fields.
SSAList ssaList = pcb.getSSAList("HOSPITAL", "ILLNESS"); ssaList.addInitialQualification("HOSPITAL", "HOSPNAME", SSAList.EQUALS, "SANTA TERESA"); ssaList.markFieldForRetrieval("ILLNESS", "ILLNAME", true); Path path = ssaList.getPathForRetrieveReplace(); pcb.getUnique(path, ssaList, false);
segmentName
- the name of the segment in the SSAList
containing
the fieldfieldName
- the name of the field to be marked for retrieval from the
databaseenableRetrieval
- boolean
indicating whether the field should be
retrieved from the databaseDLIException
- if an error occurs during processinggetPathForRetrieveReplace()
,
PCB.getUnique(Path, SSAList, boolean)
,
PCB.getNextWithinParent(Path, SSAList, boolean)
,
PCB.getNext(Path, SSAList, boolean)
void markFieldForRetrieval(int ssaLevel, java.lang.String fieldName, boolean enableRetrieval) throws DLIException
markFieldForRetrieval
method is used together
with getPathForRetrieveReplace()
and with the data
retrieval methods in the PCB
interface. When a retrieve call is
made, the resulting Path
object will contain all the fields
that have been marked for retrieval. Following the IMS default, all of
the fields in the lowest level segment specified by the
SSAList
are inititally marked for retrieval.
The following code example shows how to mark and retrieve the ward number and patient name fields from the WARD and PATIENT segments. The WARD, PATIENT, and ILLNESS segments are located in decreasing hierarchic order below the HOSPITAL segment where HOSPNAME is equal to "SANTA TERESA". By default, the retrieval operation also returns all the fields of the ILLNESS segment (ILLLL and ILLNAME).
SSAList ssaList = pcb.getSSAList("HOSPITAL", "ILLNESS"); ssaList.addInitialQualification("HOSPITAL", "HOSPNAME", SSAList.EQUALS, "SANTA TERESA"); ssaList.markFieldForRetrieval(3, "WARDNO", true); ssaList.markFieldForRetrieval(4, "PATNAME", true); Path path = ssaList.getPathForRetrieveReplace(); pcb.getUnique(path, ssaList, false);
When one or more of the fields in the lowest level segment specified in
an SSAList
is marked for retrieval, only the explicitly
marked fields are retrieved.
The following code example shows how to mark and retrieve a single field
ILLNAME from the ILLNESS segment where ILLNESS is the lowest level
segment specified in the SSAList
instance. The retrieval
operation returns no other fields.
SSAList ssaList = pcb.getSSAList("HOSPITAL", "ILLNESS"); ssaList.addInitialQualification("HOSPITAL", "HOSPNAME", SSAList.EQUALS, "SANTA TERESA"); ssaList.markFieldForRetrieval(5, "ILLNAME", true); Path path = ssaList.getPathForRetrieveReplace(); pcb.getUnique(path, ssaList, false);
ssaLevel
- the 1-based level of the SSA in the SSAList
that
represents the segment containing the fieldfieldName
- the name of the field to be marked for retrieval from the
databaseenableRetrieval
- boolean
indicating whether the field should be
retrieved from the databaseDLIException
- if an error occurs during processinggetPathForRetrieveReplace()
,
PCB.getUnique(Path, SSAList, boolean)
,
PCB.getNextWithinParent(Path, SSAList, boolean)
,
PCB.getNext(Path, SSAList, boolean)
void markAllFieldsForRetrieval(java.lang.String segmentName, boolean enableRetrieval) throws DLIException
markAllFieldsForRetrieval
method is used together with getPathForRetrieveReplace()
and with the data retrieval methods in the PCB
interface. When a
retrieve call is made the resulting Path
object will contain
only the fields marked for retrieval. Following the IMS default, all of
the fields in the lowest level segment specified by the
SSAList
are inititally marked for retrieval.
The following code example shows how to retrieve the all fields for the PATIENT segment instance. The PATIENT, ILLNESS, and TREATMNT segments are located in decreasing hierarchic order below the HOSPITAL segment where HOSPNAME is equal to "SANTA TERESA". By default, the retrieval operation also returns all the fields of the TREATMNT segment.
SSAList ssaList = pcb.getSSAList("HOSPITAL", "TREATMNT"); ssaList.addInitialQualification("HOSPITAL", "HOSPNAME", SSAList.EQUALS, "SANTA TERESA"); ssaList.markAllFieldsForRetrieval("PATIENT", true); Path path = ssaList.getPathForRetrieveReplace(); pcb.getUnique(path, ssaList, false);
segmentName
- the name of the segment in the SSAList
containing
the desired fieldsenableRetrieval
- boolean
indicating whether the fields should be
retrieved from the databaseDLIException
- if an error occurs during processinggetPathForRetrieveReplace()
,
PCB.getUnique(Path, SSAList, boolean)
,
PCB.getNextWithinParent(Path, SSAList, boolean)
,
PCB.getNext(Path, SSAList, boolean)
void markAllFieldsForRetrieval(int ssaLevel, boolean enableRetrieval) throws DLIException
markAllFieldsForRetrieval
method is used together with getPathForRetrieveReplace()
and with the data retrieval methods in the PCB
interface. When a
retrieve call is made the resulting Path
object will contain
only the fields marked for retrieval. Following the IMS default, all of
the fields in the lowest level segment specified by the
SSAList
are inititally marked for retrieval.
The following code example shows how to retrieve the all fields for the PATIENT segment instance. The PATIENT, ILLNESS, and TREATMNT segments are located in decreasing hierarchic order below the HOSPITAL segment where HOSPNAME is equal to "SANTA TERESA". By default, the retrieval operation also returns all the fields of the TREATMNT segment.
SSAList ssaList = pcb.getSSAList("HOSPITAL", "TREATMNT"); ssaList.addInitialQualification("HOSPITAL", "HOSPNAME", SSAList.EQUALS, "SANTA TERESA"); ssaList.markAllFieldsForRetrieval(4, true); Path path = ssaList.getPathForRetrieveReplace(); pcb.getUnique(path, ssaList, false);
ssaLevel
- the 1-based level of the SSA in the SSAList
that
represents the segment containing the desired fieldsenableRetrieval
- boolean
indicating whether the fields should be
retrieved from the databaseDLIException
- if an error occurs during processinggetPathForRetrieveReplace()
,
PCB.getUnique(Path, SSAList, boolean)
,
PCB.getNextWithinParent(Path, SSAList, boolean)
,
PCB.getNext(Path, SSAList, boolean)
PreparedValue createPreparedValue(java.lang.String name) throws DLIException
SSAList
is
being constructed, a PreparedValue
object can be passed in
as the value of the field. When the value is known, the
PreparedValue
object can be set with the value of the field
and the qualification statement will be complete.
PreparedValues
are also very useful when the same
SSAList
is going to be reused multiple times with different
values for the fields in the qualification statements.
The following code fragment shows how PreparedValue
is used
to retrieve the patient and treatment records for patient "ANDREA SMITH"
from two different hospitals ("SANTA TERESA" and "ALEXANDRIA").
SSAList ssaList = pcb.getSSAList("HOSPITAL", "TREATMNT"); PreparedValue pv = ssaList.createPreparedValue("HOSPNAME"); // pass in the prepared value instead of an actual value as the actual value is unknown at this time ssaList.addInitialQualification("HOSPITAL", "HOSPNAME", SSAList.EQUALS, pv); ssaList.addInitialQualification("PATIENT", "PATNAME", SSAList.EQUALS, "ANDREA SMITH"); Path path = ssaList.getPathForRetrieveReplace(); ... pv.setValue("SANTA TERESA"); pcb.getUnique(path, ssaList, true); ... pv.setValue("ALEXANDRIA"); pcb.getUnique(path, ssaList, true);
name
- the name of the PreparedValue
, typically the name
of the field whose value will be set at a later timePreparedValue
objectDLIException
- if an error occurs during processingaddInitialQualification(String, String, short,
PreparedValue)
,
appendQualification(int, byte, String, short, PreparedValue)
PreparedValue getPreparedValue(java.lang.String name)
PreparedValue
object.name
- the name of a previously created PreparedValue
PreparedValue
objectjava.util.Collection<PreparedValue> getPreparedValues()
Collection
of all previously created
PreparedValue
objects with this SSAList
Collection
of PreparedValue
objectsvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, java.lang.Object value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the field as an ObjectDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, java.lang.Object value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the field as an ObjectDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, boolean value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, boolean value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, byte value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, byte value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, int value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, int value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, short value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, short value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, long value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, long value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, float value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, float value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, double value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, double value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, byte[] value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, byte[] value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, java.lang.String value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, java.lang.String value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, java.math.BigDecimal value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, java.math.BigDecimal value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, java.sql.Date value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, java.sql.Date value) throws DLIException
SSAList
ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, java.sql.Time value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, java.sql.Time value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, java.sql.Timestamp value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, java.sql.Timestamp value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, PreparedValue value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- a PreparedValue
object representing the value of
the fieldDLIException
- if an error occurs during processingcreatePreparedValue(String)
void addInitialQualification(int ssaLevel, java.lang.String fieldName, short relationalOp, PreparedValue value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tofieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- a PreparedValue
object representing the value of
the fieldDLIException
- if an error occurs during processingcreatePreparedValue(String)
void appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, java.lang.Object value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the field as an ObjectDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, java.lang.Object value) throws DLIException
SSA
in the
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the field as an ObjectDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, boolean value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, boolean value) throws DLIException
SSA
in the
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, int value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, int value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, short value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, short value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, long value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, long value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, float value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, float value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, byte[] value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, byte[] value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, java.lang.String value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, java.lang.String value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, java.math.BigDecimal value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, java.math.BigDecimal value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, java.sql.Date value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, java.sql.Date value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, java.sql.Time value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, java.sql.Time value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, java.sql.Timestamp value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, java.sql.Timestamp value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- the value of the fieldDLIException
- if an error occurs during processingvoid appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, PreparedValue value) throws DLIException
SSAList
.segmentName
- the name of the segment in the SSAList
to add the
qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- a PreparedValue
object representing the value of
the fieldDLIException
- if an error occurs during processingcreatePreparedValue(String)
void appendQualification(int ssaLevel, byte booleanOp, java.lang.String fieldName, short relationalOp, PreparedValue value) throws DLIException
SSAList
.ssaLevel
- the 1-based level of the SSA in the SSAList
to
add the qualification tobooleanOp
- the boolean operator to use to connect this qualification to
the previous - one of the SSAList
constantsfieldName
- the name of the fieldrelationalOp
- the relational operator to use - one of the
SSAList
constantsvalue
- a PreparedValue
object representing the value of
the fieldDLIException
- if an error occurs during processingcreatePreparedValue(String)
byte[][] buildSSAListInBytes() throws DLIException
SSAList
in proper DL/I format.
Note: This method doesn't need to be called by client applications. It is only used by clients for debugging purposes.
SSAList
in proper DL/I formatDLIException