Package org.incenp.obofoundry.idrange

Interface IIDRangePolicy

public interface IIDRangePolicy
Represents an ID range policy, assigning ID ranges to users.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getPrefix()
    Gets the prefix of IDs generated by this policy.
    String
    getPrefixName()
    Gets the short name of the policy's prefix.
    IDRange
    getRange(String name)
    Gets the ID range allocated to the specified user.
    int
    getWidth()
    Gets the number of digits (padded with leading zeros) in the numerical part of IDs generated with this policy.

  • Method Details

    • getPrefix

      String getPrefix()
      Gets the prefix of IDs generated by this policy.
      Returns:
      The prefix associated with this policy.

    • getPrefixName

      String getPrefixName()
      Gets the short name of the policy's prefix.
      Returns:
      The prefix name.

    • getWidth

      int getWidth()
      Gets the number of digits (padded with leading zeros) in the numerical part of IDs generated with this policy.
      Returns:
      The number of digits for this policy.

    • getRange

      IDRange getRange(String name)
      Gets the ID range allocated to the specified user.
      Parameters:
      name - The name of the user for which to retrieve the ID range.
      Returns:
      The range allocated to the user, or null if the policy has no range for that user.