NameIdPair 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:APIClass|Repository Class|Repository}}  
This class represents the name and ID of a project.
Stores the name and ID of an element (e.g., project) for the "GetAll" or "GetCurrent" methods in the [[Repository_Class|Repository]] class.
== Constructors ==
== Constructors ==
*NameIdPair( Integer, String ) {{APIComment|Represents an element (e.g., project, model) with the specified numerical ID and name. (Automatically called via the "GetAll" and "GetCurrent" methods in the Repository class.)}}
*NameIdPair( Integer, String ) {{APIComment|Creates a new NameIdPair object. This is automatically done when a "GetAll" or "GetCurrent" method is called.)}}


== Methods ==
== Methods ==
*'''[[NameIdPair.ToString|ToString]]''' {{APIComment|Overridable function that returns the Name.}}
*'''[[NameIdPair.ToString|ToString]]''' {{APIComment|Returns the value of the Name property.}}
 
== Properties  ==
== Properties  ==
*Name (as ''string'') {{APIComment|Gets or set the name.}}
*Name (as ''string'') {{APIComment|Gets or set the name.}}
*ID (as ''integer'') {{APIComment|Gets or set the ID number.}}
*ID (as ''integer'') {{APIComment|Gets or set the ID number.}}

Revision as of 15:38, 3 March 2014


Stores the name and ID of an element (e.g., project) for the "GetAll" or "GetCurrent" methods in the Repository class.

Constructors

  • NameIdPair( Integer, String ) Creates a new NameIdPair object. This is automatically done when a "GetAll" or "GetCurrent" method is called.)

Methods

  • ToString Returns the value of the Name property.

Properties

  • Name (as string) Gets or set the name.
  • ID (as integer) Gets or set the ID number.