User:Kate Racaza/APIdraftspage

=Summary=  New Classes

New Enums
 * ResourceFilterEnum_Enumeration - part of SYN-I-4788
 * RestockOnEnum_Enumeration - part of SYN-I-4849

New Methods
 * Repository.Xfmea.GetItemInSystemHierarchy_Method - SYN-I-4795

New Properties
 * SYN-I-4974
 * CXfmeaControl_Class
 * cAction_Class

Edits to Existing Methods
 * SYN-I-4788 (not code breaking)
 * Repository.Model.GetAllModels
 * Repository.Model.GetAllModelsInfo
 * Repository.Action.GetAllActions
 * Repository.Action.GetAllActionsDictionary
 * Repository.Crew.GetAllCrews
 * Repository.Pool.GetAllPools
 * Repository.Task.GetAllScheduledTasks
 * Repository.Task.GetAllCorrectiveTasks
 * Repository.URD.GetAllURDs
 * Repository.Variable.GetAllVariables
 * Repository.Control.GetAllXfmeaControls
 * Repository.Control.GetAllXfmeaControlsDictionary


 * SYN-I-4864 (not code breaking)
 * Common_Class

Edits to Existing Properties
 * SYN-I-4849 (not code breaking)
 * CPool Class Restock On property

Deprecations
 * XfmeaItem_Class - removed Nr property because it is a duplicate of the PartNr property.
 * CXfmeaControl_Class and cAction_Class - removed Synthesis identifier fields (because not applicable).
 * CScheduledTask_Class - removed OnCondPerformTaskEvenIfItBringsSysDown property because not in use (obsolete).

=SYN-I-4788= Use this template:

Gets a list of models associated with a project. Returns a cModel object array that contains the models in that project.

Syntax
.Model.GetAllModels (Filter)

Parameters
Filter
 * Optional. A filter that returns a particular type of model resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local models only.

Example
Edit the comment:

'Get a list of all local models in project #1.

=SYN-I-4864= Remove the "VB.NET Only" parenthetical in the definition.

Then add the following example. Add note that in VBA, you'll need to instantiate the class.

VBA Lng cLanguage Lng.SetLanguage (Language_Portuguese) MyRepository Repository m cModel MyRepository.ConnectToAccessRepository m = MyRepository.Model.GetModel(47)

=SYN-I-4849= Update definition of RestockOn property:

Gets or sets a value from the RestockOnEnum enumeration, which specifies the pool's restock property (e.g. restock as needed, restock as scheduled, etc.).

=SYN-I-4974= Add the following properties to the class: {|
 * UT1||Gets or sets the text in the first user-defined text field. String.
 * UT2||Gets or sets the text in the second user-defined text field. String.
 * UT3||Gets or sets the text in the third user-defined text field. String.
 * UT4||Gets or sets the text in the fourth user-defined text field. String.
 * UT5||Gets or sets the text in the fifth user-defined text field. String.
 * UT3||Gets or sets the text in the third user-defined text field. String.
 * UT4||Gets or sets the text in the fourth user-defined text field. String.
 * UT5||Gets or sets the text in the fifth user-defined text field. String.
 * UT5||Gets or sets the text in the fifth user-defined text field. String.
 * UT5||Gets or sets the text in the fifth user-defined text field. String.