Uploaded image for project: 'OASIS Energy Interoperation TC'
  1. OASIS Energy Interoperation TC
  2. ENERGYINTEROP-299

Need better consistency in the notion of an ID versus a name (line 892)

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: wd25
    • Component/s: None
    • Labels:
      None
    • Resolution:
      Hide

      Ensure that the definition and use of ID and name (that includes the intended purpose of the attribute and possibly specifies other characteristics such as uniqueness etc.) is uniformly applied through the document.

      After that definition is established we may find that we have to add other name attributes to some of our classes so that there is both a name and an ID much like we have done with the EiProgram:programName and EiProgram:programID to ensure consistency.

      Show
      Ensure that the definition and use of ID and name (that includes the intended purpose of the attribute and possibly specifies other characteristics such as uniqueness etc.) is uniformly applied through the document. After that definition is established we may find that we have to add other name attributes to some of our classes so that there is both a name and an ID much like we have done with the EiProgram:programName and EiProgram:programID to ensure consistency.

      Description

      Within the EiEvent class, the EiConstaint class, and the EiOptout class there are names and ID attributes. The presumption is that an ID is some sort of object reference and a name is some sort of human readable representation. In some cases such as EiProgram:programID and EiProgram:programName we use both. It is unclear where a name versus an ID is required and perhaps in some cases where both should be there.

        Attachments

          Activity

            People

            • Assignee:
              william.cox William Cox (Inactive)
              Reporter:
              ed.koch Ed Koch (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: