com.ibm.db.models.db2.luw
Interface FederatedParameter

All Superinterfaces:
commonj.sdo.DataObject, org.eclipse.emf.ecore.sdo.EDataObject, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.ENamedElement, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, org.eclipse.wst.rdb.internal.models.sql.routines.Parameter, java.io.Serializable, org.eclipse.wst.rdb.internal.models.sql.schema.SQLObject, org.eclipse.wst.rdb.internal.models.sql.schema.TypedElement
All Known Implementing Classes:
FederatedParameterImpl

public interface FederatedParameter
extends org.eclipse.wst.rdb.internal.models.sql.routines.Parameter

A representation of the model object 'Federated Parameter'. Federated Parameter object capturs the remote procedure atributes that are stored as options in the DB2 Catalog. Those that could not be inherited through the Parameter object, have been modeled specifically. These attributes are remoteCodePage and remoteParamTypeID. The attributes & where they can be found from the Parameter object are below. RemoteParamName - Remote parameter name, from name feild of any named object RemoteTypeSchema - found through getDatatype, inherited from Parameter Remote_Param_Type_Name - found through getDatatype, inherited from Parameter Remote_Remote_Param_Scale - found through getDatatype, inherited from Parameter Remote_Remote_Param_Length - found through getDatatype, inherited from Parameter Remote_Is_Return_Value - Found in ParameterMode enumeration, inherited from Parameter Remote_Codepage Remote_Param_Type_ID - the remote parameter type as an integer, attribute of Federated Paramter paramtypeid

The following features are supported:

See Also:
LUWPackage.getFederatedParameter()

Method Summary
 FederatedProcedure getFederatedProcedure()
          Returns the value of the 'Federated Procedure' reference.
 int getRemoteCodePage()
          Returns the value of the 'Remote Code Page' attribute.
 org.eclipse.emf.common.util.EList getRemoteParameter()
          Returns the value of the 'Remote Parameter' reference list.
 int getRemoteParamTypeID()
          Returns the value of the 'Remote Param Type ID' attribute.
 void setFederatedProcedure(FederatedProcedure value)
          Sets the value of the 'Federated Procedure' reference.
 void setRemoteCodePage(int value)
          Sets the value of the 'Remote Code Page' attribute.
 void setRemoteParamTypeID(int value)
          Sets the value of the 'Remote Param Type ID' attribute.
 
Methods inherited from interface org.eclipse.wst.rdb.internal.models.sql.routines.Parameter
getMode, getRoutine, getStringTypeOption, isLocator, setLocator, setMode, setRoutine, setStringTypeOption
 
Methods inherited from interface org.eclipse.wst.rdb.internal.models.sql.schema.TypedElement
getContainedType, getDataType, getReferencedType, setContainedType, setDataType, setReferencedType
 
Methods inherited from interface org.eclipse.wst.rdb.internal.models.sql.schema.SQLObject
addEAnnotation, addEAnnotationDetail, getComments, getDependencies, getDescription, getEAnnotation, getEAnnotationDetail, getLabel, getPrivileges, removeEAnnotationDetail, setAnnotationDetail, setDescription, setLabel
 
Methods inherited from interface org.eclipse.emf.ecore.sdo.EDataObject
getInstanceProperties
 
Methods inherited from interface commonj.sdo.DataObject
createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, delete, get, get, get, getBigDecimal, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getBytes, getBytes, getBytes, getChar, getChar, getChar, getContainer, getContainmentProperty, getDataGraph, getDataObject, getDataObject, getDataObject, getDate, getDate, getDate, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInt, getList, getList, getList, getLong, getLong, getLong, getSequence, getSequence, getSequence, getShort, getShort, getShort, getString, getString, getString, getType, isSet, isSet, isSet, set, set, set, setBigDecimal, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBigInteger, setBoolean, setBoolean, setBoolean, setByte, setByte, setByte, setBytes, setBytes, setBytes, setChar, setChar, setChar, setDataObject, setDataObject, setDataObject, setDate, setDate, setDate, setDouble, setDouble, setDouble, setFloat, setFloat, setFloat, setInt, setInt, setInt, setList, setList, setList, setLong, setLong, setLong, setShort, setShort, setShort, setString, setString, setString, unset, unset, unset
 
Methods inherited from interface org.eclipse.emf.ecore.ENamedElement
getName, setName
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotations
 

Method Detail

getRemoteCodePage

int getRemoteCodePage()
Returns the value of the 'Remote Code Page' attribute.

If the meaning of the 'Remote Code Page' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Remote Code Page' attribute.
See Also:
setRemoteCodePage(int), LUWPackage.getFederatedParameter_RemoteCodePage()

setRemoteCodePage

void setRemoteCodePage(int value)
Sets the value of the 'Remote Code Page' attribute.

Parameters:
value - the new value of the 'Remote Code Page' attribute.
See Also:
getRemoteCodePage()

getRemoteParamTypeID

int getRemoteParamTypeID()
Returns the value of the 'Remote Param Type ID' attribute.

If the meaning of the 'Remote Param Type ID' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Remote Param Type ID' attribute.
See Also:
setRemoteParamTypeID(int), LUWPackage.getFederatedParameter_RemoteParamTypeID()

setRemoteParamTypeID

void setRemoteParamTypeID(int value)
Sets the value of the 'Remote Param Type ID' attribute.

Parameters:
value - the new value of the 'Remote Param Type ID' attribute.
See Also:
getRemoteParamTypeID()

getFederatedProcedure

FederatedProcedure getFederatedProcedure()
Returns the value of the 'Federated Procedure' reference. It is bidirectional and its opposite is 'Federated Parameter'.

If the meaning of the 'Federated Procedure' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Federated Procedure' reference.
See Also:
setFederatedProcedure(FederatedProcedure), LUWPackage.getFederatedParameter_FederatedProcedure(), FederatedProcedure.getFederatedParameter()

setFederatedProcedure

void setFederatedProcedure(FederatedProcedure value)
Sets the value of the 'Federated Procedure' reference.

Parameters:
value - the new value of the 'Federated Procedure' reference.
See Also:
getFederatedProcedure()

getRemoteParameter

org.eclipse.emf.common.util.EList getRemoteParameter()
Returns the value of the 'Remote Parameter' reference list. The list contents are of type Parameter.

If the meaning of the 'Remote Parameter' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Remote Parameter' reference list.
See Also:
LUWPackage.getFederatedParameter_RemoteParameter()