| Prototype: |
| Bind_Device_To_Slot( |
number OUT_RetCode, number OUT_idDeviceBind, number IN_idDeviceToBind, number IN_idSlotToBind, number IN_idContextDevice, number IN_tOff, number IN_tOn, number IN_bOverwrite); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_bind_device_to_slot.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown Error |
| -2 |
NULL IN_idDeviceToBind. IN_idDeviceToBind must contain a valid idDevice value. |
| -3 |
NULL IN_idSlotToBind. IN_idSlotToBind must contain a valid idDeviceSlot value. |
| -4 |
Invalid foreign key. Either IN_idSlotToBind, IN_idDeviceToBind, or IN_idContextDevice did not contain valid values. IN_idContextDevice must correspond to a Device.idDevice unless it is NULL or 0. |
| -5 |
Overlapping DeviceBind records exist, a IN_bOverwrite was not set to 1. |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
| -2X |
Error in Fix_Device_Bind(), where X indicates error returned by that proc. Fix_Device_Bind() is only executed when there is an existing DeviceBind record with matching keys and an overlapping time period (tOn - tOff). |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idDeviceBind |
number |
Optional Parameter Description for Param2. |
| IN_idDeviceToBind |
number |
Optional Parameter Description for Param2. |
| IN_idSlotToBind |
number |
Optional Parameter Description for Param2. |
| IN_idContextDevice |
number |
Optional Parameter Description for Param2. |
| IN_tOff |
number |
Optional Parameter Description for Param2. |
| IN_tOn |
number |
Optional Parameter Description for Param2. |
| IN_bOverwrite |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_bind_device_to_slot.sql |
| Prototype: |
| Create_DeviceSlot( |
number OUT_RetCode, number OUT_idDeviceSlot, number IN_idSlotType, varchar2 IN_sSlotName); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_create_deviceslot.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown Error |
| -2 |
IN_idSlotType is NULL. IN_idSlotType must be a valid idSlotType. |
| -1X |
Error in Get_SlotType_Info(), where X indicates error returned by that procedure. |
| -2X |
Error in Create_Core_idKey(), where X indicates error returned by that procedure. |
| -3X |
Error in Create_ModuleTemplate(), where X indicates error returned by that procedure. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return code for the procedure. |
| OUT_idDeviceSlot |
number |
Optional Parameter Description for Param2. |
| IN_idSlotType |
number |
Optional Parameter Description for Param2. |
| IN_sSlotName |
varchar2 |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_create_deviceslot.sql |
| Prototype: |
| Create_DeviceType( |
number OUT_RetCode, number OUT_idDeviceType, number IN_idModule, varchar2 IN_sDeviceTypeName); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_create_devicetype.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
Null IN_idModule (NULL or 0) |
| -3 |
Foreign Key violation, idModule does not correspond to a matching Module record. |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idDeviceType |
number |
Optional Parameter Description for Param2. |
| IN_idModule |
number |
Optional Parameter Description for Param2. |
| IN_sDeviceTypeName |
varchar2 |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_create_devicetype.sql |
| Prototype: |
| Create_Module( |
number OUT_RetCode, number OUT_idModule, number IN_idSlotType, varchar2 IN_sModuleName); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_create_module.sql |
| Description: |
This function not only creates a module record, but creates IN_idSlotType.iNumOutputs ModuleEntry records with idSubDevSlot and iSubPlexor set to NULL. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
N_idSlotType is NULL. IN_idSlotType must be a valid idSlotType. |
| -1X |
Error in Get_SlotType_Info(). Where X indicates error returned by that proc. |
| -2X |
Error in Create_Core_idKey(). Where X indicates error returned by that proc. |
| -3X |
Error in Create_ModuleEntry(). Where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idModule |
number |
Optional Parameter Description for Param2. |
| IN_idSlotType |
number |
Optional Parameter Description for Param2. |
| IN_sModuleName |
varchar2 |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_create_module.sql |
| Prototype: |
| Create_ModuleEntry( |
number OUT_RetCode, number OUT_idModuleEntry, number IN_idModule, number IN_iPlexor, number IN_idSubDevSlot, number IN_iSubPlexor); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_create_moduleentry.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
NULL IN_idModule. IN_idModule must contain a valid idModule value. |
| -3 |
Invalid foreign key. Either IN_idModule, IN_idSubDevSlot, or the combo of IN_idSubDevSlot and IN_iSubPlexor did not contain valid values. |
| -4 |
ModuleEntry record already exists with duplicate IN_idModule, IN_iPlexor. |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idModuleEntry |
number |
Optional Parameter Description for Param2. |
| IN_idModule |
number |
Optional Parameter Description for Param2. |
| IN_iPlexor |
number |
Optional Parameter Description for Param2. |
| IN_idSubDevSlot |
number |
Optional Parameter Description for Param2. |
| IN_iSubPlexor |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_create_moduleentry.sql |
| Prototype: |
| Create_ModuleTemplate( |
number OUT_RetCode, number OUT_idModuleTemplate, number IN_idDeviceSlot, number IN_iPlexor, number IN_idNextDevSlot, number IN_iNextPlexor); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_create_moduletemplate.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
NULL IN_idDeviceSlot. IN_idDeviceSlot must contain a valid idDeviceSlot value. |
| -3 |
Invalid foreign key. Either IN_idDeviceSlot, IN_idNextDevSlot, or the combo of IN_idNextDevSlot and IN_iNextPlexor did not contain valid values. |
| -4 |
ModuleTemplate record already exists with duplicate IN_idDeviceSlot, IN_iPlexor. |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idModuleTemplate |
number |
Optional Parameter Description for Param2. |
| IN_idDeviceSlot |
number |
Optional Parameter Description for Param2. |
| IN_iPlexor |
number |
Optional Parameter Description for Param2. |
| IN_idNextDevSlot |
number |
Optional Parameter Description for Param2. |
| IN_iNextPlexor |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_create_moduletemplate.sql |
| Prototype: |
| Create_Or_Update_Device( |
number OUT_RetCode, number INOUT_idDevice, number IN_idDeviceModel, varchar2 IN_sDeviceName, number IN_idDeviceType, number IN_bIsGeneric, number IN_bIsRealizable); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_create_or_update_device.sql |
| Description: |
This function either attempts to create a new Device record or update an existing Device record. |
| Note: |
When INOUT_idDevice is 0 or NULL: The proc will attempt to create a new Device record using the params passed. If IN_bIsGeneric = 1 then it will also attempt to create a GenericDevice with matching idDevice and bIsRealizable set to IN_bIsRealizable; otherwise (IN_bisGeneric != 1) it will attempt to create an ActualDevice with matching idDevice. When INOUT_idDevice != 0 and NOT NULL: The proc will attempt to update the existing Device record with idDevice = INOUT_idDevice, using the params passed. If IN_bIsGeneric = 1 then the proc will attempt to update the GenericDevice record with matching idDevice. If a matching GenericDevice record does not exist, (meaning the Device was originally created as an ActualDevice not a GenericDevice) then GenericDevice will not be updated and the proc will still return success. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
INOUT_idDevice is non-NULL, but invalid. The caller must set INOUT_idDevice to NULL(0) before calling this proc to create a new device. |
| -3 |
Violated a Foreign Key constraint on idDeviceModel, idModule, or idDeviceType during insert of new Device record. |
| -4 |
Violated a Foreign Key constraint on idDeviceModel, idModule, or idDeviceType during update of Device record. |
| -5 |
Internal idDevice error. |
| -7 |
IN_idDeviceType is non-NULL, but invalid. |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| INOUT_idDevice |
number |
Optional Parameter Description for Param2. |
| IN_idDeviceModel |
number |
Optional Parameter Description for Param2. |
| IN_sDeviceName |
varchar2 |
Optional Parameter Description for Param2. |
| IN_idDeviceType |
number |
Optional Parameter Description for Param2. |
| IN_bIsGeneric |
number |
Optional Parameter Description for Param2. |
| IN_bIsRealizable |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_create_or_update_device.sql |
| Prototype: |
| Create_SlotType( |
number OUT_RetCode, number OUT_idSlotType, number IN_iNumInputs, number IN_iNumOutputs, varchar2 IN_sSlotTypeName); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_create_slottype.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
Invalid iNumInputs (must be > 0) |
| -3 |
Invalid iNumOutputs (must be > 0) |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idSlotType |
number |
Optional Parameter Description for Param2. |
| IN_iNumInputs |
number |
Optional Parameter Description for Param2. |
| IN_iNumOutputs |
number |
Optional Parameter Description for Param2. |
| IN_sSlotTypeName |
varchar2 |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_create_slottype.sql |
| Prototype: |
| Fix_Device_Bind( |
number OUT_RetCode, number IN_idDupDeviceBind, number IN_tOff, number IN_tOn); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_fix_device_bind.sql |
| Description: |
this function should modify neccessary reords so that DeviceBind.idDupDeviceBind is not valid over the time range of tOn - tOff. We expect that this means that we must split the record in half, with the first half occurring before tOn and the second half occurring after tOff |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
Error, an idChan and idCompT already exist for the given SCNL and time interval |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| IN_idDupDeviceBind |
number |
Optional Parameter Description for Param2. |
| IN_tOff |
number |
Optional Parameter Description for Param2. |
| IN_tOn |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_fix_device_bind.sql |
| Prototype: |
| Fix_Function_Bind( |
number OUT_RetCode, number IN_idDupFunctionBind, number IN_tOff, number IN_tOn); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_fix_function_bind.sql |
| Description: |
This function should modify neccessary reords so that FunctionBind.idDupFunctionBind is not valid over the time range of tOn - tOff. We expect that this means that we must split the record in half, with the first half occurring before tOn and the second half occurring after tOff. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
Error, an idChan and idCompT already exist for the given SCNL and time interval |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| IN_idDupFunctionBind |
number |
Optional Parameter Description for Param2. |
| IN_tOff |
number |
Optional Parameter Description for Param2. |
| IN_tOn |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_fix_function_bind.sql |
| Prototype: |
| Get_DeviceSlot_Info( |
number OUT_RetCode, number OUT_idSlotType, varchar2 OUT_sSlotName, number IN_idDeviceSlot); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_deviceslot_info.sql |
| Description: |
Retrieves the contents of the DeviceSlot table for a given idDeviceSlot. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching DeviceSlot record found |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idSlotType |
number |
Optional Parameter Description for Param2. |
| OUT_sSlotName |
varchar2 |
Optional Parameter Description for Param2. |
| IN_idDeviceSlot |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_deviceslot_info.sql |
| Prototype: |
| Get_DeviceType_Info( |
number OUT_RetCode, number OUT_idModule, varchar2 OUT_sDeviceTypeName, number IN_idDeviceType); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_devicetype_info.sql |
| Description: |
Retrieves the contents of the DeviceType table for a given idDeviceType. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching DeviceType record found |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idModule |
number |
Optional Parameter Description for Param2. |
| OUT_sDeviceTypeName |
varchar2 |
Optional Parameter Description for Param2. |
| IN_idDeviceType |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_devicetype_info.sql |
| Prototype: |
| Get_Device_Info( |
number OUT_RetCode, number OUT_idModule, varchar2 OUT_sDeviceName, number OUT_idDeviceModel, number OUT_idDeviceType, number OUT_bIsRealizable, number IN_idDevice, number IN_bWantRealizable); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_device_info.sql |
| Description: |
Retrieves the contents of the Device table for the given IN_idDevice. If IN_bWantRealizable = 1, then the procedure will attempt to check the GenericDevice.bIsRealizable value, copying -1 into OUT_bIsRealizable if there is no corresponding GenericDevice record. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching Device record found |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idModule |
number |
Optional Parameter Description for Param2. |
| OUT_sDeviceName |
varchar2 |
Optional Parameter Description for Param2. |
| OUT_idDeviceModel |
number |
Optional Parameter Description for Param2. |
| OUT_idDeviceType |
number |
Optional Parameter Description for Param2. |
| OUT_bIsRealizable |
number |
Optional Parameter Description for Param2. |
| IN_idDevice |
number |
Optional Parameter Description for Param2. |
| IN_bWantRealizable |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_device_info.sql |
| Prototype: |
| Get_ModuleEntry( |
number OUT_RetCode, number OUT_idSubDevSlot, number OUT_iSubPlexor, number IN_idModule, number IN_iPlexor); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_moduleentry.sql |
| Description: |
Retrieves the contents of the ModuleEntry table for a given idModule and iPlexor. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching ModuleEntry record found. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idSubDevSlot |
number |
Optional Parameter Description for Param2. |
| OUT_iSubPlexor |
number |
Optional Parameter Description for Param2. |
| IN_idModule |
number |
Optional Parameter Description for Param2. |
| IN_iPlexor |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_moduleentry.sql |
| Prototype: |
| Get_Module_Info( |
number OUT_RetCode, number OUT_idSlotType, varchar2 OUT_sModuleName, varchar2 OUT_sSlotTypeName, number OUT_iNumInputs, number OUT_iNumOutputs, number IN_idModule); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_module_info.sql |
| Description: |
Retrieves the contents of the Module table and associated SlotType table for the given IN_idModule. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching Module record found |
| -1X |
Get_SlotType_Info() failed returning -X. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idSlotType |
number |
Optional Parameter Description for Param2. |
| OUT_sModuleName |
varchar2 |
Optional Parameter Description for Param2. |
| OUT_sSlotTypeName |
varchar2 |
Optional Parameter Description for Param2. |
| OUT_iNumInputs |
number |
Optional Parameter Description for Param2. |
| OUT_iNumOutputs |
number |
Optional Parameter Description for Param2. |
| IN_idModule |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_module_info.sql |
| Prototype: |
| Get_Next_Plexor( |
number OUT_RetCode, number OUT_idNextDevSlot, number OUT_iNextPlexor, number IN_idDeviceSlot, number IN_iPlexor); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_next_plexor.sql |
| Description: |
Retrieves the idNextDeviceSlot and iNextPlexor from the ModuleTemplate table using the given IN_idDeviceSlot and IN_iPlexor |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching ModuleTemplate record found. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idNextDevSlot |
number |
Optional Parameter Description for Param2. |
| OUT_iNextPlexor |
number |
Optional Parameter Description for Param2. |
| IN_idDeviceSlot |
number |
Optional Parameter Description for Param2. |
| IN_iPlexor |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_next_plexor.sql |
| Prototype: |
| Get_Plexor_For_ChanT( |
number OUT_RetCode, number OUT_idDeviceSlot, number OUT_iPlexor, number IN_idChanT, number IN_idChan, number IN_tTime); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_plexor_for_chant.sql |
| Description: |
This funcntion looks in the ChanT table for the idDeviceSlot and iPlexor fields for a given idChanT. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching ChanT record found |
| -3 |
ChanT record has NULL DeviceSlot |
| -1X |
GetidChanT_From_idChan_and_T() failed, X is the return code from it. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_idDeviceSlot |
number |
Optional Parameter Description for Param2. |
| OUT_iPlexor |
number |
Optional Parameter Description for Param2. |
| IN_idChanT |
number |
Optional Parameter Description for Param2. |
| IN_idChan |
number |
Optional Parameter Description for Param2. |
| IN_tTime |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_plexor_for_chant.sql |
| Prototype: |
| Get_SlotType_Info( |
number OUT_RetCode, number OUT_iNumInputs, number OUT_iNumOutputs, varchar2 OUT_sSlotTypeName, number IN_idSlotType); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_get_slottype_info.sql |
| Description: |
This function retrieves the contents of the SlotType table for a given idSlotType. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
No matching SlotType record found |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| OUT_iNumInputs |
number |
Optional Parameter Description for Param2. |
| OUT_iNumOutputs |
number |
Optional Parameter Description for Param2. |
| OUT_sSlotTypeName |
varchar2 |
Optional Parameter Description for Param2. |
| IN_idSlotType |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_get_slottype_info.sql |
| Prototype: |
| Set_Device_Function( |
number OUT_RetCode, number INOUT_idFunctionBind, number IN_idDeviceToBind, number IN_idFunctionToBind, number IN_sFunctionType, number IN_tOff, number IN_tOn, number IN_bOverwrite, number IN_bOverridable); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_set_device_function.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
NULL IN_idDeviceToBind. IN_idDeviceToBind must contain a valid idDevice value. |
| -3 |
NULL IN_idFunctionToBind. IN_idFunctionToBind must contain a valid idFunction value. |
| -4 |
Invalid sFunctionType/idFunction |
| -5 |
Overlapping FunctionBind records exist, and IN_bOverwrite was not set to 1. |
| -6 |
Invalid foreign key. IN_idDeviceToBind, did not contain a valid value. |
| -7 |
Invalid idFunctionBind key. INOUT_idFunctionBind was non-null but did not contain a valid value. INOUT_idFunctionBind must correspond to an existing FunctionBind.idFunctionBind if it is not NULL. |
| -8 |
Invalid IN_sFunctionType. GetTI() was not able to lookup a table identifier for IN_sFunctionType. |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
| -2X |
Error in Fix_Function_Bind(), where X indicates error returned by that proc. Fix_Function_Bind() is only executed when there is an existing FunctionBind record with matching keys and an overlapping time period (tOn - tOff). |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| INOUT_idFunctionBind |
number |
Optional Parameter Description for Param2. |
| IN_idDeviceToBind |
number |
Optional Parameter Description for Param2. |
| IN_idFunctionToBind |
number |
Optional Parameter Description for Param2. |
| IN_sFunctionType |
number |
Optional Parameter Description for Param2. |
| IN_tOff |
number |
Optional Parameter Description for Param2. |
| IN_tOn |
number |
Optional Parameter Description for Param2. |
| IN_bOverwrite |
number |
Optional Parameter Description for Param2. |
| IN_bOverridable |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_set_device_function.sql |
| Prototype: |
| Set_Plexor_For_Channel( |
number OUT_RetCode, number INOUT_idChanT, number IN_idChan, number IN_idDeviceSlot, number IN_iPlexor, number IN_tOff, number IN_tOn); |
|
| Source File: |
./src/oracle/schema-working/sql_scripts/ewdb_set_plexor_for_channel.sql |
| Description: |
Optional Function Description ended by a blank line. |
RETURN CODE INFO |
| Return Type: |
NUMBER |
| Return Arg: |
1 |
| Return Value |
Description |
| 0 |
Success |
| -1 |
Unknown error |
| -2 |
NULL IN_idDeviceSlot. IN_idDeviceSlot must contain a valid idDeviceSlot value |
| -3 |
NULL IN_iPlexor. IN_iPlexor must contain a valid iPlexor value. |
| -4 |
Unknown Duplicate Index Value error. |
| -5 |
Internal error while processing Create_ChanT. |
| -6 |
Unknown Foreign Key error. |
| -7 |
idDeviceSlot/iPlexor is not valid FK to ModuleTemplate table. |
| -1X |
Error in Create_Core_idKey(), where X indicates error returned by that proc. |
| -2X |
Error in Update_ChanT(), where X indicates error returned by that proc. |
| -1XX |
Error in Create_ChanT(), where XX indicates error returned by that proc. |
| -2XX |
Error in Update_ChanTs_For_TimeRange(), where XX indicates error returned by that proc. |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| OUT_RetCode |
number |
This parameter holds the return value for the procedure. |
| INOUT_idChanT |
number |
Optional Parameter Description for Param2. |
| IN_idChan |
number |
Optional Parameter Description for Param2. |
| IN_idDeviceSlot |
number |
Optional Parameter Description for Param2. |
| IN_iPlexor |
number |
Optional Parameter Description for Param2. |
| IN_tOff |
number |
Optional Parameter Description for Param2. |
| IN_tOn |
number |
Optional Parameter Description for Param2. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
RAW_INFRASTRUCTURE-INTERNAL |
| Language: |
SQL |
| Location: |
./src/oracle/schema-working/sql_scripts/ewdb_set_plexor_for_channel.sql |