com.fatwire.services.beans.asset
Class VersionBean

java.lang.Object
  com.fatwire.services.beans.BaseBean
      com.fatwire.services.beans.asset.VersionBean

All Implemented Interfaces:

java.io.Serializable

public class VersionBean
extends BaseBean

The VersionBean is the value object for services handling revision tracking of assets. For every version bean, there is an associated asset in an associated state in the versioning life cycle of an asset. For the purposes of revision tracking, there are the following associated properties:

• version - the current version number in the revision history of the asset
• comment - a comment from the user committing a new revision
• checkedOut - a flag which is set to true if the asset is checked out by a user for changes; it should be set to false once the user commits his changes
• checkedOutDate - the date when the asset was last checked out
• lockedBy - the user who is currently locking the asset

See Also:

Serialized Form

Field Summary

protected java.util.Date	checkedOutDate Date when this asset was checked out.
protected UserBean	lockedBy User who is locking #asset.

Constructor Summary

VersionBean()

Method Summary

AssetId	getAsset() Returns the asset whose version life cycle is being tracked.
java.util.Date	getCheckedOutDate() Returns the date when the associated asset was last checked out.
java.lang.String	getComment() Returns the comment from the user describing changes to a new version.
UserBean	getLockedBy() Returns the user who is locking the associated asset.
int	getVersion() Returns the current version of the associated asset from its revision history..
boolean	isCheckedOut() Returns true if the associated asset is checked out by a user.
void	setAsset(AssetId asset) Sets the asset whose version life cycle is to be tracked.
void	setCheckedOutDate(java.util.Date checkedOutDate) Sets the date when the associated asset was last checked out.
void	setComment(java.lang.String comment) Sets the comment from the user describing changes to a new version.
void	setLockedBy(UserBean lockedBy) Sets the user who is currently locking the associated asset.
void	setVersion(int version) Sets the current version number for the associated asset in its revision history..

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

checkedOutDate

protected java.util.Date checkedOutDate

Date when this asset was checked out.

lockedBy

protected UserBean lockedBy

User who is locking #asset.

Constructor Detail

VersionBean

public VersionBean()

Method Detail

getAsset

public AssetId getAsset()

Returns the asset whose version life cycle is being tracked.

Returns:

the asset.

setAsset

public void setAsset(AssetId asset)

Sets the asset whose version life cycle is to be tracked.

Parameters:

asset - the asset to set.

getComment

public java.lang.String getComment()

Returns the comment from the user describing changes to a new version.

Returns:

the comment describing the changes.

setComment

public void setComment(java.lang.String comment)

Sets the comment from the user describing changes to a new version.

Parameters:

comment - the comment to set for describing the changes.

isCheckedOut

public boolean isCheckedOut()

Returns true if the associated asset is checked out by a user.

Returns:

true if the associated asset is checked out by a user, false otherwise.

getCheckedOutDate

public final java.util.Date getCheckedOutDate()

Returns the date when the associated asset was last checked out.

Returns null if the asset was never checked out, or the type of this asset is not revision tracked.

Returns:

the date when the associated asset was last checked out.

setCheckedOutDate

public final void setCheckedOutDate(java.util.Date checkedOutDate)

Sets the date when the associated asset was last checked out.

This setter is ineffective if the type of the associated asset is not tracked.

Parameters:

checkedOutDate - the date to set.

getVersion

public final int getVersion()

Returns the current version of the associated asset from its revision history..

Returns null if the type of the associated asset is not revision tracked.

Returns:

the version of the associated asset from its revision history..

setVersion

public final void setVersion(int version)

Sets the current version number for the associated asset in its revision history..

This setter is ineffective if the type of the associated asset is not tracked.

Parameters:

version - the version to set for the associated asset in its revision history..

getLockedBy

public final UserBean getLockedBy()

Returns the user who is locking the associated asset.

Returns:

the user who is currently locking the associated asset.

setLockedBy

public final void setLockedBy(UserBean lockedBy)

Sets the user who is currently locking the associated asset.

Parameters:

lockedBy - the user to set, who is currently locking the associated asset.