Module com.genologics.ri
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
      The id referencing the external system.

    • uri

      protected URI uri
      The URI within the external system.

  • Constructor Details

    • ExternalId

      public ExternalId()
      Default constructor.

    • ExternalId

      public ExternalId(URI id)
      Constructor with id.
      Parameters:
      id - The external id.

    • ExternalId

      public ExternalId(URI id, URI uri)
      Constructor with id and URI.
      Parameters:
      id - The external id.
      uri - The URI within the external system.

  • Method Details

    • getId

      public URI getId()
      Gets the external id.
      Returns:
      The external id.

    • setId

      public void setId(URI id)
      Sets the external id.
      Parameters:
      id - The external id.

    • getUri

      public URI getUri()
      Gets the URI within the external system.
      Specified by:
      getUri in interface Locatable
      Returns:
      The URI.

    • setUri

      public void setUri(URI uri)
      Sets the URI within the external system.
      Specified by:
      setUri in interface Locatable
      Parameters:
      uri - The URI.