CCorrectiveTask Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:cCorrectiveTask Class}}
{{DISPLAYTITLE:cCorrectiveTask Class}}{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:APIClass|Resource Classes|Resource Classes}}  
 
{{CCorrectiveTask Class.Cmt}}  
 
<onlyinclude>Represents a corrective task resource.</onlyinclude>
 
==Constructors==
{| {{APITable}}
|-
| style="width: 240px;"|CCorrectiveTask||Creates an instance of the cCorrectiveTask class.
|-
|[[CCorrectiveTask Constructors|cCorrectiveTask()]]||{{:CCorrectiveTask Constructors}}
|}
 
 
==Methods==
{| {{APITable}}
|-
|style="width: 240px;"|[[CCorrectiveTask.GetPools_Method|GetPools]]||{{:CCorrectiveTask.GetPools_Method}}
|-
|[[CCorrectiveTask.SetPools_Method|SetPools]]||{{:CCorrectiveTask.SetPools_Method}}
|-
|[[CCorrectiveTask.GetTeams_Method|GetTeams]]||{{:CCorrectiveTask.GetTeams_Method}}
|-
|[[CCorrectiveTask.SetTeams_Method|SetTeams]]||{{:CCorrectiveTask.SetTeams_Method}}
|}
 


== Constructors ==
*cCorrectiveTask {{APIComment|Creates a new corrective task.}}


== Properties  ==
== Properties  ==
'''General'''
{| {{APITable}}
*Name (as ''string'') {{APIComment|Gets or sets the name of the task.}}
|-
*ID (as ''integer'') {{APIComment|Gets the numerical ID of the resource.}}
| style="width: 240px;"|BringItemDown||Indicates whether the task will bring the item down. '''Boolean'''. Default value = True.
*ProjectID (as ''integer'') {{APIComment|Gets the numerical ID of the project the task belongs to.}}
|-
|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'''
|-
|{{Template:API_TxtIdentifiers}}
|-
|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 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'''.
|-
|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)
|}


'''Task Scheduling'''
*TaskFrequencyID (as ''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]'') {{APIComment|Gets the frequency with which the task is performed.}}


'''Basic Repair Properties'''
*DurationModelID (as ''integer'') {{APIComment|Gets the ID of the task duration model the resource belongs to.}}
*CrewIDs (as ''integer()'') {{APIComment|Gets the IDs of the crews assigned that the resource belongs to.}}
*PoolID (as ''integer'') {{APIComment|Gets the ID of the pools assigned that the resource belongs to.}}


'''Task Consequences'''
*BringSystemDown (as ''boolean'') {{APIComment|Gets or sets whether this task will bring the system down.}}
*BringItemDown (as ''boolean'') {{APIComment|Gets or sets whether this task will bring the item down.}}
*PerformTaskEvenIfItBringsSysDown (as ''boolean'') {{APIComment|Gets or sets whether the task should be performed if bringing the item down causes the system to go down.}}


'''Restoration'''
*ResFactorValue (as ''double'') {{APIComment|Gets or sets the corrective task's Restoration Amount (0.9 &#61; 90% restoration).}}
*ResFactorType (as ''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]'') {{APIComment|Gets or sets the enumeration for the damage the restoration applies to (i.e., all damage or only damage since last repair.)}}


'''Additional Costs to Consider'''
==See Also==
*MiscCostModelID (as ''integer'') {{APIComment|Gets the numerical ID model that represents the task's Cost Per Task.}}
*[[Repository.Task.AddCorrectiveTask|Repository.Task.AddCorrectiveTask Method]]
*MiscCostPerTimeModelID (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the task's Downtime Rate.}}
*[[Repository.Task.GetAllCorrectiveTasks|Repository.Task.GetAllCorrectiveTasks Method]]
*[[Repository.Task.GetCorrectiveTask|Repository.Task.GetCorrectiveTask Method]]
*[[Repository.Task.UpdateCorrectiveTask|Repository.Task.UpdateCorrectiveTask Method]]

Latest revision as of 17:31, 14 March 2019

APIWiki.png


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)



See Also

Retrieved from "https://www.reliawiki.com/index.php?title=CCorrectiveTask_Class&oldid=65514"