com.sap.mw.jco
Class JCO.ParameterList

java.lang.Object
  |
  +--com.sap.mw.jco.JCO.MetaData
        |
        +--com.sap.mw.jco.JCO.Record
              |
              +--com.sap.mw.jco.JCO.ParameterList

All Implemented Interfaces:

java.lang.Cloneable, IMetaData, java.io.Serializable

Direct Known Subclasses:

JCO.Request, JCO.Response

Enclosing class:

JCO

public static class JCO.ParameterList

extends JCO.Record

implements java.lang.Cloneable, java.io.Serializable

A class that encapsulates a parameter list used to pass on data to a function.

See Also:

JCO.Function, Serialized Form

Fields inherited from interface com.sap.mw.jco.IMetaData

EXPORT_PARAMETER, IMPORT_PARAMETER, INACTIVE_PARAMETER, NESTED_TYPE1_STRUCTURE, OPTIONAL_PARAMETER, TYPE_BCD, TYPE_BYTE, TYPE_CHAR, TYPE_DATE, TYPE_EXCEPTION, TYPE_FLOAT, TYPE_INT, TYPE_INT1, TYPE_INT2, TYPE_INVALID, TYPE_ITAB, TYPE_NUM, TYPE_STRING, TYPE_STRUCTURE, TYPE_TABLE, TYPE_TIME, TYPE_XSTRING, UNINITIALIZED, UNINITIALIZED_PARAMETER

Constructor Summary

JCO.ParameterList()
Creates an instance of a parameter list

JCO.ParameterList(IMetaData meta_data)
Creates an instance of a parameter list

JCO.ParameterList(JCO.ParameterList value)
Creates an new instance of a parameter list which has the same contents as the parameter list argument

Method Summary

void	appendValue(java.lang.String name, int type, int length, byte[] value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, double value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, int value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, int decimals, byte[] value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, int decimals, double value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, int decimals, int value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, int decimals, java.lang.Object value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, int decimals, java.lang.String value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, java.lang.Object value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, int type, int length, java.lang.String value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, JCO.Structure value) Deprecated. Internal use only. This method will be removed in the next release.
void	appendValue(java.lang.String name, JCO.Table value) Deprecated. Internal use only. This method will be removed in the next release.
void	setActive(boolean active, int index) Sets the marshall/unmashall behavior of a table or structure parameter.
void	setActive(boolean active, java.lang.String name) Sets the marshall/unmashall behavior of an optional table parameter.

Methods inherited from class com.sap.mw.jco.JCO.Record

addInfo, clear, clone, copyFrom, equals, fields, fromXML, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBinaryStream, getBinaryStream, getByte, getByte, getByteArray, getByteArray, getChar, getChar, getCharacterStream, getCharacterStream, getCharArray, getCharArray, getClassNameOfValue, getClassNameOfValue, getDate, getDate, getDouble, getDouble, getField, getField, getFloat, getFloat, getInt, getInt, getLong, getLong, getShort, getShort, getString, getString, getStructure, getStructure, getTable, getTable, getTime, getTime, getValue, getValue, hashCode, readXML, readXML, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, toXML, toXML, toXML, writeHTML, writeHTML, writeXML, writeXML, writeXML, writeXML

Methods inherited from class com.sap.mw.jco.JCO.MetaData

addInfo, addInfo, addInfo, addInfo, addInfo, addInfo, addInfo, getCapacity, getDecimals, getDecimals, getDefault, getDefault, getDescription, getDescription, getExtendedFieldMetaData, getExtendedFieldMetaData, getFieldCount, getFlags, getFlags, getInternalLength, getInternalLength, getLength, getLength, getLineTypeName, getMetaData, getMetaData, getMetaData, getName, getName, getNumFields, getOffset, getOffset, getTabLength, getTabName, getTabName, getType, getType, getTypeAsString, getTypeAsString, hasField, indexOf, isActive, isActive, isException, isException, isExport, isExport, isImport, isImport, isInitialized, isInitialized, isNestedType1Structure, isNestedType1Structure, isNestedType1Structure, isOptional, isOptional, isStructure, isStructure, isTable, isTable, setExtendedFieldMetaData, setExtendedFieldMetaData, setFlags, setNestedType1Structure, setTabLength

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JCO.ParameterList

public JCO.ParameterList()

Creates an instance of a parameter list

JCO.ParameterList

public JCO.ParameterList(IMetaData meta_data)

Creates an instance of a parameter list

JCO.ParameterList

public JCO.ParameterList(JCO.ParameterList value)

Creates an new instance of a parameter list which has the same contents as the parameter list argument

Parameters:

value - the initial value of the parameter list argument

Method Detail

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        java.lang.String value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a value to the parameter list.
Note: This API cannot be used for communication with unicode enabled backend system. The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.
In cases where this way is not possible create first a MetaData object, fill it using suitable addInfo APIs and then create a ParameterList.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        int value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a value to the parameter list The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.
In cases where this way is not possible create first a MetaData object, fill it using suitable addInfo APIs and then create a ParameterList.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        double value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a value to the parameter list The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.
In cases where this way is not possible create first a MetaData object, fill it using suitable addInfo APIs and then create a ParameterList.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        byte[] value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a ByteArray value to the parameter list The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.
In cases where this way is not possible create first a MetaData object, fill it using suitable addInfo APIs and then create a ParameterList.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        java.lang.Object value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds an Object value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.
In cases where this way is not possible create first a MetaData object, fill it using suitable addInfo APIs and then create a ParameterList.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        JCO.Table value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a Table value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.
In cases where this way is not possible create first a MetaData object, fill it using suitable addInfo APIs and then create a ParameterList.

Parameters:

name - Field name for identifying this data field

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        JCO.Structure value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a structure value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.
In cases where this way is not possible create first a MetaData object, fill it using suitable addInfo APIs and then create a ParameterList.

Parameters:

name - Field name for identifying this data field

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        int decimals,
                        java.lang.String value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a string value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. Please create first a MetaData object and then a ParameterList.
The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

decimals - Data field number of decimals (only necessary for the data types JCO.TYPE_BCD and JCO.TYPE_FLOAT)

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        int decimals,
                        int value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds an integer value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. Please create first a MetaData object and then a ParameterList.
The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

decimals - Data field number of decimals (only necessary for the data types JCO.TYPE_BCD and JCO.TYPE_FLOAT)

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        int decimals,
                        double value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a double value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. Please create first a MetaData object and then a ParameterList.
The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

decimals - Data field number of decimals (only necessary for the data types JCO.TYPE_BCD and JCO.TYPE_FLOAT)

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        int decimals,
                        byte[] value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds a ByteArray value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. Please create first a MetaData object and then a ParameterList.
The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

decimals - Data field number of decimals (only necessary for the data types JCO.TYPE_BCD and JCO.TYPE_FLOAT)

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

appendValue

public void appendValue(java.lang.String name,
                        int type,
                        int length,
                        int decimals,
                        java.lang.Object value)

Deprecated. Internal use only. This method will be removed in the next release.

Adds an Object value to the parameter list Note: This API cannot be used for communication with unicode enabled backend system. Please create first a MetaData object and then a ParameterList.
The preffered way to create parameter list should be to use JCO.Repository. In this case the meta data fetched by repository is correct independent on having unicode and non unicode backend.

Parameters:

name - Field name for identifying this data field

type - Data field type

length - Data field internal length in bytes

decimals - Data field number of decimals (only necessary for the data types JCO.TYPE_BCD and JCO.TYPE_FLOAT)

value - Data field value

Throws:

JCO.ConversionException - thrown if the value could not be converted to its internal representation

setActive

public void setActive(boolean active,
                      int index)

Sets the marshall/unmashall behavior of a table or structure parameter. If false the parameter's content will never be sent or fetched from the remote system. The default value is true, i.e. always get and sent the parameter contents. The setting of this flags has only influence on table or structure parameters (except structures of type 1).

Parameters:

active - true if the contents of this parameter should be sent or fetched during a JCO call, false if not.

index - the index of the field

setActive

public void setActive(boolean active,
                      java.lang.String name)

Sets the marshall/unmashall behavior of an optional table parameter. If false the table's content will never be sent or fetched from the remote system. The default value is true, i.e. always get and sent the table contents. The setting of this flags has no influence on other than optional table parameters:

Parameters:

active - true if the contents of this table should be sent or fetched during a JCO call, false if not.

name - the field's name

Throws:

JCO.Exception - thrown if a field with the specified name does not exist