Deprecated and Removed Members: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{InProgress}}{{Template:API}}{{Template:APIUpgradesNavBox}}
{{Template:API}}{{Template:APIUpgradesNavBox}}
This page provides a summary of the changes in the Synthesis API since its earlier version. The status of an object member may be any of the following:


:*'''Modified''' - The syntax of the member has changed.
Below is a summary of what has been changed, removed and deprecated in the Synthesis API since its previous version. The status of an object member may be any of the following:
:*'''Deprecated''' - The member is obsolete and may be removed in future versions of the API. Do not use it in new applications.
:*'''Removed''' - The member has been removed from the object model.


*'''Changed''' - The syntax of the member has changed.
*'''Deprecated''' - The member is obsolete and may be removed in future versions of the API. Do not use it in new applications.
*'''Removed''' - The member has been removed from the object model.


==Changes since Synthesis API Version 10==
==Revisions since 19.0.1==
===[[Repository Class]]===
*'''<span style="color:#FCF8F8; background-color:#1D572F">&nbsp; Major &nbsp;</span>''' Removed the following depracated properties from the [[Repository Class|Repository]] class. The methods with the same names exist in the relevant sub-sections (for example instead of Repository.GetAllProjects, use Repository.Project.GetAllProjects).
All members of the Repository class have been organized into fields named after the object type they apply to. For example, the <code>Repository.GetAllModels()</code> method, which returns a cModel object, has been renamed to <code>Repository.Model.GetAllModels()</code>; similarly, the <code>Repository.ImportBlockSimXMLFile</code> method has been renamed to <code>Repository.BlockSim.ImportBlockSimXMLFile</code>, etc. The Version 9 methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.
:*GetAllProjects
:*GetCurrentProjects
:*SetCurrentProject
:*GetAllUnits
:*GetDefaultUnitID
:*GetAllModelsInfo
:*GetModel
:*GetAllModels
:*AddModel
:*UpdateModel
:*GetAllURDs
:*AddURD
:*UpdateURD
:*GetAllVariables
:*AddVariable
:*UpdateVariable
:*GetAllCorrectiveTasks
:*AddCorrectiveTask
:*UpdateCorrectiveTask
:*GetAllScheduledTasks
:*AddScheduledTask
:*UpdateScheduledTask
:*GetAllTaskTypes
:*GetAllCrews
:*AddCrew
:*UpdateCrew
:*GetAllPools
:*AddPool
:*UpdatePool
:*GetAllActions
:*AddAction
:*UpdateAction
:*ImportBlockSimXMLFile
:*ExportBlockSimXMLFile
:*SaveRawDataSet
:*GetAllXfracasEntities
:*ImportXfracasXmlFile
:*ImportXfracasXmlString
:*ImportXfracasXml
:*SerializeXMLObjectToByteArray
:*ProcessXfracasImports
:*WriteToDiagnosticsLog
:*WriteToDiagnosticsLog


In addition, the [[Repository.Model.GetAllModelsInfo|Model.GetAllModelsInfo]] method is also deprecated.
*Removed the following obsolete methods and properties from [[CCorrectiveTask Class|cCorrectiveTask]] class:
:*[[CCorrectiveTask.GetCrewIDs_Method|GetCrewIDs]]
:*[[CCorrectiveTask.SetCrewIDs_Method|SetCrewIDs]]
:*CrewIDs
:*PoolID


*Removed the following obsolete methods and properties from [[CScheduledTask Class|cScheduledTask]] class:
:*[[CScheduledTask.GetCrewIDs_Method|GetCrewIDs]]
:*[[CScheduledTask.SetCrewIDs_Method|SetCrewIDs]]
:*PoolID
:*OnCondCrewIDs
:*OnCondPoolID


===[[CAction Class|cAction Class]]===
==Revisions since 11.0.1==
====Properties====
*Removed the obsolete [[ALTAStressProfile_Class|ALTAStressProfile]] class. Use the [[CProfile Class|cProfile]] class going forward.
{| {{APITableDeprecated}}
*Removed the obsolete [[ALTASegment Class|ALTASegment]] class. Use the [[ProfileSegment Class|ProfileSegment]] class going forward.
|-
| style="width: 200px;"|AppAndRevBy||Removed
|-
|AppDate||Removed
|-
|AppUserID||Removed
|-
|CompDate||Removed
|-
|DueDate||Removed
|-
|Duration||Removed
|-
|EstCost||Removed
|-
|PersonResp||Removed
|-
|RespUserID||Removed
|-
|ShortDsc||Removed
|-
|StartDate||Removed
|-
|StatusFlag||Removed
|}


==Revisions since 10.1.1==
*Removed the obsolete <code>Nr</code> property in [[XfmeaItem Class|XfmeaItem]] class. Use the <code>PartNr</code> property going forward.
*Removed the obsolete <code>OnCondPerformTaskEvenIfItBringsSysDown</code> property in [[CScheduledTask_Class|cScheduledTask]] class.
*Non-breaking changes were made to the following methods. An optional <code>Filter</code> parameter has been added to give the ability to get global or reference resources. The filter's default value is 0, which returns local resources.
:*[[Repository.Action.GetAllActions]]
:*[[Repository.Control.GetAllXfmeaControls]] 
:*[[Repository.Model.GetAllModels]]
:*[[Repository.Model.GetAllModelsInfo]]
:*[[Repository.Crew.GetAllCrews]]
:*[[Repository.Pool.GetAllPools]]
:*[[Repository.Task.GetAllScheduledTasks]]
:*[[Repository.Task.GetAllCorrectiveTasks]]
:*[[Repository.URD.GetAllURDs]]
:*[[Repository.Variable.GetAllVariables]]


===[[CScheduledTask_Class|cScheduledTask Class]]===
==Revisions since 10.0.3==
====Properties====
*'''<span style="color:#FCF8F8; background-color:#1D572F">&nbsp; Major &nbsp;</span>''' The [[Repository Class|Repository]] class has been restructured. All of its members are now organized into fields named after the object type they apply to. For example, the <code>Repository.GetAllModels()</code> method, which returns a cModel object, has been renamed to <code>Repository.Model.GetAllModels()</code>; similarly, the <code>Repository.ImportBlockSimXMLFile</code> method has been renamed to <code>Repository.BlockSim.ImportBlockSimXMLFile</code>, etc. The previous versions of the methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.
{| {{APITableDeprecated}}
* Deprecated the [[Repository.Model.GetAllModelsInfo|Repository.Model.GetAllModelsInfo()]] method.
|-
* Removed the following obsolete properties in [[CAction Class|cAction]] class:
| style="width: 200px;"|TaskFrequencyIDOrig||Deprecated
:*AppDate
|-
:*AppUserID
|TaskFrequencyUnitIDOrig||Deprecated
:*CompDate
|-
:*DueDate
|TaskFrequencyValueOrig||Deprecated
:*Duration
|-
:*EstCost
|TaskFreqValueVariableIDOrig||Deprecated
:*PersonResp
|}
:*RespUserID
:*ShortDsc
:*StartDate
:*StatusFlag
*Removed the following obsolete properties in [[CScheduledTask_Class|cScheduledTask]] class:
:*TaskFrequencyIDOrig
:*TaskFrequencyUnitIDOrig
:*TaskFrequencyValueOrig
:*TaskFreqValueVariableIDOrig

Latest revision as of 17:32, 14 March 2019

APIWiki.png


<< Back to API Main Page

API Changelog

API Reference Documentation

Below is a summary of what has been changed, removed and deprecated in the Synthesis API since its previous version. The status of an object member may be any of the following:

  • Changed - The syntax of the member has changed.
  • Deprecated - The member is obsolete and may be removed in future versions of the API. Do not use it in new applications.
  • Removed - The member has been removed from the object model.

Revisions since 19.0.1

  •   Major   Removed the following depracated properties from the Repository class. The methods with the same names exist in the relevant sub-sections (for example instead of Repository.GetAllProjects, use Repository.Project.GetAllProjects).
  • GetAllProjects
  • GetCurrentProjects
  • SetCurrentProject
  • GetAllUnits
  • GetDefaultUnitID
  • GetAllModelsInfo
  • GetModel
  • GetAllModels
  • AddModel
  • UpdateModel
  • GetAllURDs
  • AddURD
  • UpdateURD
  • GetAllVariables
  • AddVariable
  • UpdateVariable
  • GetAllCorrectiveTasks
  • AddCorrectiveTask
  • UpdateCorrectiveTask
  • GetAllScheduledTasks
  • AddScheduledTask
  • UpdateScheduledTask
  • GetAllTaskTypes
  • GetAllCrews
  • AddCrew
  • UpdateCrew
  • GetAllPools
  • AddPool
  • UpdatePool
  • GetAllActions
  • AddAction
  • UpdateAction
  • ImportBlockSimXMLFile
  • ExportBlockSimXMLFile
  • SaveRawDataSet
  • GetAllXfracasEntities
  • ImportXfracasXmlFile
  • ImportXfracasXmlString
  • ImportXfracasXml
  • SerializeXMLObjectToByteArray
  • ProcessXfracasImports
  • WriteToDiagnosticsLog
  • WriteToDiagnosticsLog
  • Removed the following obsolete methods and properties from cCorrectiveTask class:
  • Removed the following obsolete methods and properties from cScheduledTask class:

Revisions since 11.0.1

Revisions since 10.1.1

  • Removed the obsolete Nr property in XfmeaItem class. Use the PartNr property going forward.
  • Removed the obsolete OnCondPerformTaskEvenIfItBringsSysDown property in cScheduledTask class.
  • Non-breaking changes were made to the following methods. An optional Filter parameter has been added to give the ability to get global or reference resources. The filter's default value is 0, which returns local resources.

Revisions since 10.0.3

  •   Major   The Repository class has been restructured. All of its members are now organized into fields named after the object type they apply to. For example, the Repository.GetAllModels() method, which returns a cModel object, has been renamed to Repository.Model.GetAllModels(); similarly, the Repository.ImportBlockSimXMLFile method has been renamed to Repository.BlockSim.ImportBlockSimXMLFile, etc. The previous versions of the methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.
  • Deprecated the Repository.Model.GetAllModelsInfo() method.
  • Removed the following obsolete properties in cAction class:
  • AppDate
  • AppUserID
  • CompDate
  • DueDate
  • Duration
  • EstCost
  • PersonResp
  • RespUserID
  • ShortDsc
  • StartDate
  • StatusFlag
  • TaskFrequencyIDOrig
  • TaskFrequencyUnitIDOrig
  • TaskFrequencyValueOrig
  • TaskFreqValueVariableIDOrig
Retrieved from "https://www.reliawiki.com/index.php?title=Deprecated_and_Removed_Members&oldid=65516"