com.fatwire.assetapi.data
Interface RevisionTrackingManager

public interface RevisionTrackingManager

This interface acts as accessor for Revision tracking functionality.

Method Summary

void	checkIn(java.util.List<AssetId> ids) Checks in a given collection of AssetIds
void	checkIn(java.util.List<AssetId> ids, java.lang.String checkinMsg) Checks in a given collection of AssetIds
void	checkOut(java.util.List<AssetId> ids) Checks out a collection of AssetIds
AssetData	get(AssetId id, int versionNnmber) Returns AssetData for a given asset and version number.
java.util.List<AssetData>	getAll(AssetId id) Returns all revision tracked data for a given asset
java.util.List<java.lang.Integer>	getVersions(AssetId id) Returns all available version numbers of tracked assets given an asset id.

Method Detail

checkOut

void checkOut(java.util.List<AssetId> ids)
              throws AssetAccessException

Checks out a collection of AssetIds

Parameters:

ids - ids to be checked out

Throws:

AssetAccessException - if the underlying operation fails

checkIn

void checkIn(java.util.List<AssetId> ids)
             throws AssetAccessException

Checks in a given collection of AssetIds

Parameters:

ids - ids to be checked in

Throws:

AssetAccessException - if the underlying operation fails

checkIn

void checkIn(java.util.List<AssetId> ids,
             java.lang.String checkinMsg)
             throws AssetAccessException

Checks in a given collection of AssetIds

Parameters:

ids - ids to be checked in

checkinMsg - the message for checkin

Throws:

AssetAccessException - if the underlying operation fails

getAll

java.util.List<AssetData> getAll(AssetId id)
                                 throws AssetAccessException

Returns all revision tracked data for a given asset

Parameters:

id - AssetId

Returns:

List of AssetData corresponding to all revision tracked data

Throws:

AssetAccessException - if the underlying operation fails

getVersions

java.util.List<java.lang.Integer> getVersions(AssetId id)
                                              throws AssetAccessException

Returns all available version numbers of tracked assets given an asset id.

Parameters:

id - AssetId

Returns:

List of available version numbers

Throws:

AssetAccessException - if the underlying operation fails

get

AssetData get(AssetId id,
              int versionNnmber)
              throws AssetAccessException

Returns AssetData for a given asset and version number.

Parameters:

id - AssetId

versionNnmber - a valid version number

Returns:

AssetData corresponding to the version number.

Throws:

AssetAccessException - if the underlying operation fails