Detailed Transmittal Access API (TA API) SCR Changes

This section summarizes the major changes to the Transmittal Access API technology component. For detailed changes on Transmittal Access API related SCRs see Migration Guide - Transmittal Access API SCRs. For detailed information on Transmittal Access API changes see Migration Guide - Transmittal Access API.

The Relevant SEDRIS Change Requests (SCR) applied to this release are discussed below.

1. CORE-184 - Status Code Simplification

   • Simplified status codes in API by creating a new enumerated SEDRIS data type called SE_Return_Code and modifying all API function calls to return this type.
   • Replaced SE_GetErrorDescription with SE_GetLastFunctionStatus, which provides a user of the SEDRIS API with additional status information for the last function called by that user prior to the invocation of this function.

2. CORE-185 - Object ID simplification

   • The opaque type SE_Object_ID has been eliminated; object IDs are now provided directly in the form of strings.
   • Removed the API function SE_ObjectIDsSupported() and the data type SE_ID_Implementation_Level.
   • Removed the API data type SE_ObjectID.
   • Removed the following API functions:
     • SE_StringToObjectID()
     • SE_CompareObjectIDs()
     • SE_ObjectIDToString()
     • SE_FreeObjectID()
     • SE_GetTransmittalFromID()
   • Renamed SE_GetObjectForID() to SE_GetObjectFromIDString().
   • Added the status code SE_STAT_CODE_DELETED_OBJECT to SE_Status_Code.
   • Renamed SE_GetIDForObject() to SE_GetObjectIDString().

3. CORE-186 - Data Table API Simplification

   • The <Data Table> API has been modified so that instead of providing a variety of "get" and "put" functions, there are fewer functions involved, and those that exist use a new data structure.
   • Removed the following functions:
     • SE_GetDataTable()
     • SE_GetElementOfDataTable()
     • SE_GetPackedDataTable()
     • SE_PutDataTable()
     • SE_PutDataTableSubExtent()
     • SE_PutElementOfDataTable()
     • SE_PutElementOfDataTableSubExtent()
     • SE_PuttPackedDataTable()
     • SE_PutPackedDataTableSubExtent()
   • Removed the data type SE_Property_Data_Value_Ptr.
   • Added a new data type named SE_Data_Table_Data.
   • Added the new enumerant SE_Data_Table_Data_Value_Type.
   • Changed the type of the value_type field of <Table_Property_Description> from SE_Property_Data_Value_Type to SE_Data_Table_Data_Value_Type.
   • Added the function SE_GetDataTableData.
   • Added the function SE_PutDataTableData.
   • Removed the Level 1 functions SE_AllocElementOfDataTableData, and SE_AllocPackedDataTableData.

4. CORE-187 - Get RelationCounts Simplification

   • Modified SE_GetRelationCounts() to handle ITR and removed the following functions:
     • SE_HasAggregate()
     • SE_HasAssociate()
     • SE_HasComponent()
   • Removed the return condition for status code SE_MULTIPLE_OBJECTS from SE_GetAggregate(), SE_GetAssociate(), & SE_GetComponent() in order to make these functions more consistent with their names.

5. CORE-188 - Clarifying API names and definitions

   • Renamed SE_IdentifyObject to SE_GetDRMClass.
   • Rename SE_SetCallbackForOneFunctionOneStatusCode to SE_SetSpecificCallBack.

6. CORE-189 - DRM Compliance checking in the API

   • SE_PutFields() now checks that the field values supplied are syntactically valid before committing them to the target transmittal.
   • Fixed the Write API so that it will not allow illegal DRM relationships and the fields of objects will be validated.

7. CORE-190 - Publishable Objects Constraint

   • SE_PublishObject() now checks that the object in question is one of those permitted for publication under the <<Publishable Object>> constraint.
   • Added the constraint <<Publishable_Object>> and updated the behaviour of SE_PublishObject() in the Transmittal Access Level 0 API accordingly.
   • Added <<Publishable_Object>> as a constraint to <SEDRIS_Abstract_Base>, whence it will be inherited by all other classes, where it will be inherited by every other class. The constraint applies to every class, because it specifies whether instances of any given class may be published or not.
   • Any published objects that did not belong to one of the permitted classes, and were referenced by other transmittals would require duplication in the referencing transmittal (or other steps to be taken on the part of the data provider).

8. SAIC-165 - Reference Symbol Mechanism

   • Eliminated the Reference Symbol mechanism from the Transmittal Access 0 API.
     • Removed the following functions:
       1. SE_AddSymbolicAssociate
       2. SE_AddSymbolicComponent
       3. SE_AssignReferenceSymbolToObject
       4. SE_CreateReferenceSymbol
       5. SE_CreateReferenceSymbolFromIntegerUnsigned
       6. SE_CreateReferenceSymbolFromString
       7. SE_CreateReferenceSymbolFromUserData
       8. SE_FreeReferenceSymbol
       9. SE_GetReferenceSymbol
     • Removed the following datatypes:
       1. SE_AddSymbolicAssociate
       2. SE_AddSymbolicComponent
       3. SE_AssignReferenceSymbolToObject
       4. SE_CreateReferenceSymbol
       5. SE_CreateReferenceSymbolFromIntegerUnsigned
       6. SE_CreateReferenceSymbolFromString
       7. SE_CreateReferenceSymbolFromUserData
       8. SE_FreeReferenceSymbol
       9. SE_GetReferenceSymbol
     • Removed the following status codes:
       1. SE_STAT_CODE_DUPLICATE_REFERENCE_SYMBOL
       2. SE_STAT_CODE_REFERENCE_SYMBOL_HAS_ASSIGNED_OBJECT
       3. SE_STAT_CODE_INVALID_OR_NULL_REFERENCE_SYMBOL
   • If usage was being made of the reference symbol mechanism, an alternate mechanism exists via object IDs.

9. SAIC-172 - Remove SE_GetSortKey() from SEDRIS API

   • The SE_GetSortKey() function has been removed from the Transmittal Access Level 0 API; it has been determined to provide no significant value that cannot now be supplied through the use of object IDs.