Package wt.vc

Class VersionIdentifier

java.lang.Object
wt.vc._VersionIdentifier
wt.vc.VersionIdentifier
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable
@GenAsObjectMappable(versions=-4288274760220598776L,properties={@GeneratedProperty(name="versionId",type=java.lang.String.class,javaDoc="An identifier that uniquely labels a version. This attribute seems to be duplicative with the \"value\" attribute within the \"identifier\" attribute but is required since the identifier is typed as an abstract class that can\'t be correctly generated for externalization (i.e., the abstract class is all that\'s known at the time of generation to apply as the class for constructing a new instance). <P> For this [duplicative] declaration to work the \"identifier\" must be specified as not persistent. Its accessors must handle the translations between it and this id. And there must be no accessors generated for this id. </P>",accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(upperLimit=60)),@GeneratedProperty(name="versionLevel",type=java.lang.Integer.class,initialValue="new Integer( 0 )",javaDoc="A value that identifies what level the version id is at. This attribute seems to be duplicative with the \"level\" attribute within the \"identifier\" attribute but is required since the identifier is typed as an abstract class that can\'t be correctly generated for externalization (i.e., the abstract class is all that\'s known at the time of generation to apply as the class for constructing a new instance). <P> For this [duplicative] declaration to work the \"identifier\" must be specified as not persistent. Its accessors must handle the translations between it and this id. And there must be no accessors generated for this level. </P>",accessors=@PropertyAccessors(getAccess=PRIVATE)),@GeneratedProperty(name="versionSortId",type=java.lang.String.class,javaDoc="An identifier that allows the database to sort based on revision.",accessors=@PropertyAccessors(getAccess=PRIVATE)),@GeneratedProperty(name="series",type=MultilevelSeries.class,accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(persistent=false))}) public class VersionIdentifier extends wt.vc._VersionIdentifier
An identifier that uniquely labels a version.

Use the newVersionIdentifier static factory method(s), not the VersionIdentifier constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Method Details

    • newVersionIdentifier

      public static VersionIdentifier newVersionIdentifier() throws WTException
      Construct a VersionIdentifier.

      Supported API: true
      Returns:
      VersionIdentifier
      Throws:
      WTException

    • newVersionIdentifier

      public static VersionIdentifier newVersionIdentifier(MultilevelSeries value) throws WTException
      Construct a VersionIdentifier using a series.

      Supported API: true
      Parameters:
      value -
      Returns:
      VersionIdentifier
      Throws:
      WTException

    • getSeries

      public MultilevelSeries getSeries() throws VersionControlException
      Gets the series.
      Returns:
      MultilevelSeries
      Throws:
      VersionControlException

    • getValue

      public String getValue()
      Gets the aggregated series' value and returns it as a string.
      Returns:
      String

    • initialize

      protected void initialize() throws WTException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Throws:
      WTException

    • initialize

      protected void initialize(MultilevelSeries value) throws WTException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      value -
      Throws:
      WTException

    • getVersionSortId

      public String getVersionSortId()
      This API should be used very rarely. The preferred method for sorting is to use a comparator. Either a variation of the VcComparator or by getting the object's Series and using it's greaterThan() or lessThan() APIs.

      Supported API: true
      Returns: