TaskTypeInfo Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumbClass}}
Used with the [[Repository.GetAllTaskTypes]] to get information about all the tasks in a repository.


== Properties ==
*ID (as ''integer'') {{APIComment|Gets or sets a numerical ID.}}
*Name (as ''string'') {{APIComment|Gets or sets a Name.}}
*Classification (as ''[[TaskClassEnum Enumeration|TaskClassEnum]]'') {{APIComment|Gets or sets a task class (e.g., preventive).}}
*Abbreviation (as ''string'') {{APIComment|Gets or sets an abbreviation for a task type.}}


== Usage Example ==
<onlyinclude>Stores the properties of an RCM task type.</onlyinclude>
{{APIComment|'Declare a new repository connection object.}}
 
  Dim MyRepository As New Repository
== Properties  ==
 
{| {{APITable}}
{{APIComment|'Connect to the Synthesis repository.}}
|-
  Dim Success As Boolean = False
| style="width: 130px;"|ID||Gets or sets the numerical ID of the task type. '''Integer'''.
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
|-
 
|Name||Gets or sets the name of the task type. '''String'''.
{{APIComment|'Get the list of task types in the connected repository from the current project.}}
|-
  Dim ListOfTaskTypes() As TaskTypeInfo
|Classification||Gets or sets a value from the '''[[TaskClassEnum Enumeration|TaskClassEnum]]''' enumeration, which specifies the task's class (e.g., preventive, inspection or on condition inspection).
  ListOfTaskTypes = MyRepository.GetAllTaskTypes()
|-
|Abbreviation||Gets or sets the abbreviation for the task type. '''String'''.
|}

Revision as of 18:02, 7 August 2015

APIWiki.png


Member of: SynthesisAPI


Stores the properties of an RCM task type.

Properties

Name Description
ID Gets or sets the numerical ID of the task type. Integer.
Name Gets or sets the name of the task type. String.
Classification Gets or sets a value from the TaskClassEnum enumeration, which specifies the task's class (e.g., preventive, inspection or on condition inspection).
Abbreviation Gets or sets the abbreviation for the task type. String.