Module org.cruk.clarity.api
Package com.genologics.ri

Class ExternalId

java.lang.Object
com.genologics.ri.ExternalId
All Implemented Interfaces:
Locatable, Serializable
public class ExternalId extends Object implements Locatable, Serializable
An external id is a reference to an identifier in an external system that contains additional information about a representation within the API.

External id is supported on representations that contain links back to external systems.

External id consists of two different URI type elements: id and URI. ID is the URI referencing the external system, and provides context and identification of the representation within that system. URI is the URI within the system, and provides a means of looking up the representation that the external id is associated with.

See Also:

  • Field Details

    • id

      protected URI id

    • uri

      protected URI uri

  • Constructor Details

    • ExternalId

      public ExternalId()

    • ExternalId

      public ExternalId(URI id)

    • ExternalId

      public ExternalId(URI id, URI uri)

  • Method Details

    • getId

      public URI getId()

    • setId

      public void setId(URI id)

    • getUri

      public URI getUri()
      Description copied from interface: Locatable
      Get the URI of this object.
      Specified by:
      getUri in interface Locatable
      Returns:
      The URI.

    • setUri

      public void setUri(URI uri)
      Description copied from interface: Locatable
      Set the URI of this object.
      Specified by:
      setUri in interface Locatable
      Parameters:
      uri - The new URI.