Interface Id

All Superinterfaces:
Id, OsidPrimitive, OsidPrimitive, Serializable
public interface Id extends OsidPrimitive, Id

Id represents an identifier object. Ids are designated by the following elements:

  • identifier : a unique key or guid
  • namespace : the namespace of the identifier
  • authority : the issuer of the identifier

Two Ids are equal if their namespace, identifier and authority strings are equal. Only the identifier is case-sensitive. Persisting an Id means persisting the above components.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAuthority()
    Gets the authority of this Id .
    String
    getIdentifier()
    Gets the identifier of this Id .This method is used to compare one Id to another.
    String
    getIdentifierNamespace()
    Gets the namespace of the identifier.

    Methods inherited from interface Id

    equals, hashCode
    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Determines if the authority, namespace, and identfier of the given Id is equal to this one.
    int
    hashCode()
    Returns a hash code value for this Id based on the authority, namespace, and identifier of this Id.

    Methods inherited from interface OsidPrimitive

    toString
    Modifier and Type
    Method
    Description
    String
    toString()
    Returns a string representation of this OsidPrimitive.

  • Method Details

    • getAuthority

      String getAuthority()
      Gets the authority of this Id . The authority is a string used to ensure the uniqueness of this Id when using a non-federated identifier space. Generally, it is a service name identifying the provider of this Id . This method is used to compare one Id to another.
      Returns:
      the authority of this Id
      Compliance:
      mandatory - This method must be implemented.

    • getIdentifierNamespace

      String getIdentifierNamespace()
      Gets the namespace of the identifier. The namespace reflects the domain in which the identifier is unique. When using a global identifier schema, the namespace may indicate the name of the scheme. When using a local identification scheme, the namespace may be more specific, such as the name of a database or file in which the identifiers exist. Federating adapters may use a custom namespace to include information for routing. This method is used to compare one Id to another.
      Returns:
      the authority of this Id
      Compliance:
      mandatory - This method must be implemented.

    • getIdentifier

      String getIdentifier()
      Gets the identifier of this Id .This method is used to compare one Id to another.
      Returns:
      the identifier of this Id
      Compliance:
      mandatory - This method must be implemented.