Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.RuntimeCollective.webapps.bean
Interface Versioned  view Versioned download Versioned.java

All Superinterfaces:
Duplicable, EntityBean, java.io.Serializable
All Known Implementing Classes:
VersionedExtension

public interface Versioned
extends Duplicable

Interface to implement if you want an EntityBean to be duplicable, that is, to make it possible to duplicate a bean into a new one, with the same properties, but a new id.

Version:
$Id: Versioned.java,v 1.6 2003/09/30 15:13:10 joe Exp $

Field Summary
static java.lang.String ARCHIVED_TAG
          The tag for the Archived version of objects (in case you need one).
static java.lang.String DATABASE_TABLE
          Not sure we need this, but EBS complains otherwise
static java.lang.String LIVE_TAG
          The tag for the Live version of objects (one per object - like all other tags).
static java.lang.String TRUNK_TAG
          The tag for the TRUNK, reference version.
 
Fields inherited from interface com.RuntimeCollective.webapps.bean.EntityBean
INTERFACE_BEAN, NULL_ID
 
Method Summary
 Versioned createOrReplaceVersion(java.lang.String referenceVersionTag, java.lang.String newVersionTag)
          Create and save a new version of this object based on a existing one, and tag it with the specified tag.
 Versioned getVersion(java.lang.String versionTag)
          Get an existing version of this object.
 int getVersionReference()
          Get the Reference of this Version, that is, the id of the first object in the family of versions.
 java.lang.String getVersionTag()
          Get the Tag of this Version.
 java.util.List getVersionTagList()
          Get a List of all the existing version's tags.
 void setVersionReference(int reference)
          Set the Reference of this Version, that is, the id of the first object in the family of versions.
 void setVersionTag(java.lang.String tag)
          Set the Tag of this Version.
 
Methods inherited from interface com.RuntimeCollective.webapps.bean.Duplicable
customiseDuplicate, makeDuplicate, makeDuplicate
 
Methods inherited from interface com.RuntimeCollective.webapps.bean.EntityBean
delete, getId, save, setId
 

Field Detail

DATABASE_TABLE

public static final java.lang.String DATABASE_TABLE
Not sure we need this, but EBS complains otherwise

See Also:
Constant Field Values

TRUNK_TAG

public static final java.lang.String TRUNK_TAG
The tag for the TRUNK, reference version. This will be used for the version being currently edited.

See Also:
Constant Field Values

LIVE_TAG

public static final java.lang.String LIVE_TAG
The tag for the Live version of objects (one per object - like all other tags).

See Also:
Constant Field Values

ARCHIVED_TAG

public static final java.lang.String ARCHIVED_TAG
The tag for the Archived version of objects (in case you need one).

See Also:
Constant Field Values
Method Detail

setVersionReference

public void setVersionReference(int reference)
Set the Reference of this Version, that is, the id of the first object in the family of versions.

This should not really be called directly.

This Reference version should *not* be deleted, otherwise all other versions will get scattered.


getVersionReference

public int getVersionReference()
Get the Reference of this Version, that is, the id of the first object in the family of versions.


setVersionTag

public void setVersionTag(java.lang.String tag)
Set the Tag of this Version.

This should not really be called directly.


getVersionTag

public java.lang.String getVersionTag()
Get the Tag of this Version.


getVersionTagList

public java.util.List getVersionTagList()
Get a List of all the existing version's tags.


createOrReplaceVersion

public Versioned createOrReplaceVersion(java.lang.String referenceVersionTag,
                                        java.lang.String newVersionTag)
Create and save a new version of this object based on a existing one, and tag it with the specified tag. If a version with the newVersionTag already exists, it will be overwritten - ie its id will be reused.

The reference version should already exist, otherwise this method will do nothing and return "null".
A version with the newVersionTag may or may not exist: if it doesn't, it will be created - if it does, it will be overwritten.


getVersion

public Versioned getVersion(java.lang.String versionTag)
Get an existing version of this object.

The version should already exist. It is doesn't, this method will do nothing and return "null".