TaskTypeInfo Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 3: Line 3:


== Properties ==
== Properties ==
*ID (as ''integer'') {{APIComment|Sets or returns the Task type ID}}
*ID (as ''integer'') {{APIComment|Gets or sets task's numerical ID.}}
*Name (as ''string'') {{APIComment|Sets or returns the Task Type Name}}
*Name (as ''string'') {{APIComment|Gets or sets the task's Name.}}
*Classification (as ''[[TaskClassEnum Enumeration|TaskClassEnum]]'') {{APIComment|Sets or returns the Task Type classification}}
*Classification (as ''[[TaskClassEnum Enumeration|TaskClassEnum]]'') {{APIComment|Gets or sets the task's class (e.g., restorative).}}
*Abbreviation (as ''string'') {{APIComment|Sets or returns the abbreviation for the task type}}
*Abbreviation (as ''string'') {{APIComment|Gets or sets the abbreviation for the task type.}}


== Usage Example ==
== Usage Example ==

Revision as of 22:45, 12 March 2014


Used with the Repository.GetAllTaskTypes to get information about all the tasks in a repository.

Properties

  • ID (as integer) Gets or sets task's numerical ID.
  • Name (as string) Gets or sets the task's Name.
  • Classification (as TaskClassEnum) Gets or sets the task's class (e.g., restorative).
  • Abbreviation (as string) Gets or sets the abbreviation for the task type.

Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of task types in the connected repository from the current project.

       Dim ListOfTaskTypes() As TaskTypeInfo
       ListOfTaskTypes = MyRepository.GetAllTaskTypes()