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, 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) Adds a ByteArray value to the parameter list
void	appendValue(java.lang.String name, int type, int length, double value) Adds a value to the parameter list
void	appendValue(java.lang.String name, int type, int length, int value) Adds a value to the parameter list
void	appendValue(java.lang.String name, int type, int length, int decimals, byte[] value) Adds a ByteArray value to the parameter list
void	appendValue(java.lang.String name, int type, int length, int decimals, double value) Adds a double value to the parameter list
void	appendValue(java.lang.String name, int type, int length, int decimals, int value) Adds an integer value to the parameter list
void	appendValue(java.lang.String name, int type, int length, int decimals, java.lang.Object value) Adds an Object value to the parameter list
void	appendValue(java.lang.String name, int type, int length, int decimals, java.lang.String value) Adds a string value to the parameter list
void	appendValue(java.lang.String name, int type, int length, java.lang.Object value) Adds an Object value to the parameter list
void	appendValue(java.lang.String name, int type, int length, java.lang.String value) Adds a value to the parameter list
void	appendValue(java.lang.String name, JCO.Structure value) Adds a structure value to the parameter list
void	appendValue(java.lang.String name, JCO.Table value) Adds a Table value to the parameter list
void	setActive(boolean active, int index) Sets the marshall/unmashall behavior of an optional table 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, getByteArray, getByteArray, getChar, getChar, getCharacterStream, getCharacterStream, getClassNameOfValue, getClassNameOfValue, getDate, getDate, getDouble, getDouble, getField, getField, 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, 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, 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, isOptional, isOptional, isStructure, isStructure, isTable, isTable, setExtendedFieldMetaData, setExtendedFieldMetaData, setFlags, 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)

Adds a value to the parameter list

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)

Adds a value to the parameter list

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)

Adds a value to the parameter list

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)

Adds a ByteArray value to the parameter list

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)

Adds an Object value to the parameter list

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)

Adds a Table value to the parameter list

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)

Adds a structure value to the parameter list

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)

Adds a string value to the parameter list

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)

Adds an integer value to the parameter list

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)

Adds a double value to the parameter list

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)

Adds a ByteArray value to the parameter list

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)

Adds an Object value to the parameter list

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 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.

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