com.fatwire.services
Interface VersioningService

All Superinterfaces:

Service

public interface VersioningService
extends Service

The Versioning Service is the interface providing services related to revision tracking of assets.

Method Summary

void	checkin(VersionBean version, boolean keepCheckedOut) Commits the changes by the user from the session in a new revision for an asset.
void	checkout(AssetId assetId) Checks out an asset by the user from the session.
java.util.List<AssetId>	getCheckedoutAssets() Gets the list of assets checked out by the user from the session.
VersionBean	getRevision(AssetId assetId) Returns revision tracking information for an asset.
java.lang.Boolean	isTracked(java.lang.String assetType) Returns true if the specified asset type is tracked.
void	undoCheckout(AssetId assetId, boolean explicitUndoCheckout) Reverts the changes made to the checked-out asset by the user from the session and sets its state back to what it was before being checked out.

Methods inherited from interface com.fatwire.services.Service

getManager, getResponse, setManager

Method Detail

checkout

void checkout(AssetId assetId)
              throws ServiceException

Checks out an asset by the user from the session.

Parameters:

assetId - the identifier for the asset to checkout.

Throws:

ServiceException - wraps any exception underlying the service call.

undoCheckout

void undoCheckout(AssetId assetId,
                  boolean explicitUndoCheckout)
                  throws ServiceException

Reverts the changes made to the checked-out asset by the user from the session and sets its state back to what it was before being checked out.

Parameters:

assetId - the identifier for the asset being reverted.

explicitUndoCheckout -

Throws:

ServiceException - wraps any exception underlying the service call.

checkin

void checkin(VersionBean version,
             boolean keepCheckedOut)
             throws ServiceException

Commits the changes by the user from the session in a new revision for an asset.

The method also accepts a switch to keep the asset checked out once the changes are committed. However, a new revision number will be associated as if the asset was again checked out after the commit.

Parameters:

version - the revision to commit.

keepCheckedOut - switch to keep the asset checked out even after committing the changes.

Throws:

ServiceException - wraps any exception underlying the service call.

getCheckedoutAssets

java.util.List<AssetId> getCheckedoutAssets()
                                            throws ServiceException

Gets the list of assets checked out by the user from the session.

Returns:

a list of assets which are currently checked out.

Throws:

ServiceException - wraps any exception underlying the service call.

getRevision

VersionBean getRevision(AssetId assetId)
                        throws ServiceException

Returns revision tracking information for an asset.

Parameters:

assetId - the identifier for the asset whose revision tracking information is to be retrieved.

Returns:

the revision tracking information associated with the specified asset.

Throws:

ServiceException - wraps any exception underlying the service call.

isTracked

java.lang.Boolean isTracked(java.lang.String assetType)
                            throws ServiceException

Returns true if the specified asset type is tracked.

Parameters:

type - the asset type to check for revision tracking.

Returns:

true if the specified asset type is tracked, false otherwise.

Throws:

ServiceException - wraps any exception underlying the service call.