CCorrectiveTask Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
No edit summary |
||
(12 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:cCorrectiveTask Class}}{{Template:API}}{{Template: | {{DISPLAYTITLE:cCorrectiveTask Class}}{{Template:API}}{{Template:APIBreadcrumb}} | ||
Line 16: | Line 16: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
|style="width: 240px;"|[[CCorrectiveTask. | |style="width: 240px;"|[[CCorrectiveTask.GetPools_Method|GetPools]]||{{:CCorrectiveTask.GetPools_Method}} | ||
|- | |- | ||
|[[CCorrectiveTask. | |[[CCorrectiveTask.SetPools_Method|SetPools]]||{{:CCorrectiveTask.SetPools_Method}} | ||
|- | |||
|[[CCorrectiveTask.GetTeams_Method|GetTeams]]||{{:CCorrectiveTask.GetTeams_Method}} | |||
|- | |||
|[[CCorrectiveTask.SetTeams_Method|SetTeams]]||{{:CCorrectiveTask.SetTeams_Method}} | |||
|} | |} | ||
Line 25: | Line 30: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: 240px;"|BringItemDown||Indicates whether the task will bring the item down. '''Boolean'''. | | style="width: 240px;"|BringItemDown||Indicates whether the task will bring the item down. '''Boolean'''. Default value = True. | ||
|- | |- | ||
|BringSystemDown||Indicates whether the task will bring the system down. '''Boolean'''. | |BringSystemDown||Indicates whether the task will bring the system down. '''Boolean'''. Default value = False. | ||
|- | |- | ||
|DurationModelID||Gets or sets the numeric ID of the duration model assigned to the task. '''Integer'''. | |DurationModelID||Gets or sets the numeric ID of the duration model assigned to the task. '''Integer'''. | ||
Line 43: | Line 46: | ||
|Name||Gets or sets the name of the task. '''String'''. | |Name||Gets or sets the name of the task. '''String'''. | ||
|- | |- | ||
|PerformTaskEvenIfItBringsSysDown||Indicates whether the task should be performed if bringing the item down causes the system to go down. '''Boolean'''. | |PerformTaskEvenIfItBringsSysDown||Indicates whether the task should be performed if bringing the item down causes the system to go down. '''Boolean'''. Default value = True. | ||
|- | |- | ||
|ProjectID||Gets the numeric ID of the project the task belongs to. '''Integer'''. | |ProjectID||Gets the numeric ID of the project the task belongs to. '''Integer'''. | ||
|- | |- | ||
|ResFactorType||Gets or sets a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''', which specifies the effect of the restoration ( | |ResFactorType||Gets or sets a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''', which specifies the effect of the restoration. Default value = 1 (restores all accumulated damage). | ||
|- | |- | ||
|ResFactorValue||Gets or sets the restoration amount (0.9 = 90% restoration). A value = 1 indicates an as good as new condition, a value = 0 indicates an as bad as old condition. A values greater than zero but less than 1 indicates a partial restoration. '''Double'''. | |ResFactorValue||Gets or sets the restoration amount (0.9 = 90% restoration). A value = 1 indicates an as good as new condition, a value = 0 indicates an as bad as old condition. A values greater than zero but less than 1 indicates a partial restoration. '''Double'''. | ||
|- | |- | ||
|TaskFrequencyID||Gets or sets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies the frequency at which the task is performed. | |TaskFrequencyID||Gets or sets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies the frequency at which the task is performed. Default value = 8 (task is performed upon item failure). | ||
|- | |||
|Teams||Returns a '''{{APIPrefix|List}}(Of [[TeamInfo Class|TeamInfo]])''' containing teams assigned for the task (in the order of priority). (.NET Only) | |||
|} | |} | ||
Latest revision as of 17:31, 14 March 2019
Member of: SynthesisAPI
Represents a corrective task resource.
Constructors
Name | Description |
---|---|
CCorrectiveTask | Creates an instance of the cCorrectiveTask class. |
cCorrectiveTask() | A parameterized constructor for the cCorrectiveTask class. (.NET only) |
Methods
Name | Description |
---|---|
GetPools | Returns an array of the Pool IDs and number of parts for all pools required for the task. |
SetPools | Sets the Pool IDs and number of parts for all pools required for the task. |
GetTeams | Returns an array teams required for the task. |
SetTeams | Sets the teams required for the task. |
Properties
Name | Description |
---|---|
BringItemDown | Indicates whether the task will bring the item down. Boolean. Default value = True. |
BringSystemDown | Indicates whether the task will bring the system down. Boolean. Default value = False. |
DurationModelID | Gets or sets the numeric ID of the duration model assigned to the task. Integer. |
ID | Gets the numeric ID of the task. Integer |
ItemApplication | Gets or sets the item's application. (Synthesis identifier) String |
ItemCategoryID | Gets or sets the category ID. (Synthesis identifier) Integer |
ItemComments | Gets or sets the comments. (Synthesis identifier) String |
ItemDescription | Gets or sets the description. (Synthesis identifier) String |
ItemKeywords | Gets or sets the keywords. (Synthesis identifier) String |
ItemPartNumber | Gets or sets the part number. (Synthesis identifier) String |
ItemSupplier | Gets or sets the supplier name. (Synthesis identifier) String |
ItemVersion | Gets or sets the version number. (Synthesis identifier) String |
MiscCostModelID | Gets or sets the numeric ID of the model that represents the cost per task. Integer. |
MiscCostPerTimeModelID | Gets or sets the numeric ID of the model that represents the downtime rate. Integer. |
Name | Gets or sets the name of the task. String. |
PerformTaskEvenIfItBringsSysDown | Indicates whether the task should be performed if bringing the item down causes the system to go down. Boolean. Default value = True. |
ProjectID | Gets the numeric ID of the project the task belongs to. Integer. |
ResFactorType | Gets or sets a value from the TaskRestorationTypeEnum, which specifies the effect of the restoration. Default value = 1 (restores all accumulated damage). |
ResFactorValue | Gets or sets the restoration amount (0.9 = 90% restoration). A value = 1 indicates an as good as new condition, a value = 0 indicates an as bad as old condition. A values greater than zero but less than 1 indicates a partial restoration. Double. |
TaskFrequencyID | Gets or sets a value from the TaskFrequencyEnum, which specifies the frequency at which the task is performed. Default value = 8 (task is performed upon item failure). |
Teams | Returns a List(Of TeamInfo) containing teams assigned for the task (in the order of priority). (.NET Only) |