@Exported public interface VersioningService extends Service
The Versioning Service is the interface providing services related to versioning of assets when revision tracking has been enabled for the asset type.
.Methods from this service will invoke operations like "Check out", "Check in" and "Undo Checkout". Once an asset is checked out by a user, it cannot be operated on by another user unless the check out is cleared by undoing the check out or by checking the asset in.
Modifier and Type | Method and Description |
---|---|
VersionBean |
checkin(AssetId assetId,
String comment,
boolean keepCheckedOut,
MessageCollectors.VersioningMessageCollector collector)
Commits changes to the specified asset and hence creates a new revision for it.
|
VersionBean |
checkout(AssetId assetId,
MessageCollectors.VersioningMessageCollector collector)
Checks out an asset for the logged in user and returns the current revision.
|
List<AssetId> |
getCheckedoutAssets()
Returns the list of assets checked out by the logged in user.
|
List<VersionBean> |
getCheckedoutAssetsWithDates()
Returns the list of assets along with check out dates, checked out by the logged in user.
|
VersionBean |
getCurrentRevision(AssetId assetId)
Returns metadata for the current revision for the specified asset.
|
boolean |
isTracked(String assetType)
Checks if revision tracking is enabled for the specified asset type.
|
VersionBean |
undoCheckout(AssetId assetId,
MessageCollectors.VersioningMessageCollector collector)
Reverts the changes made to the specified checked-out asset,
and reverts its state back to what it was before being checked out.
|
getManager, getResponse, setManager
VersionBean checkout(AssetId assetId, MessageCollectors.VersioningMessageCollector collector) throws ServiceException
null
.
In checking out the specified asset, this method assumes the currently logged in user
is performing the action.assetId
- The identifier for the asset to check out.collector
- The message collector for acquiring messages from this method.VersionBean
with the current revision status.ServiceException
- Wraps any exception underlying the service call.VersionBean undoCheckout(AssetId assetId, MessageCollectors.VersioningMessageCollector collector) throws ServiceException
null
.assetId
- The identifier for the asset being reverted.collector
- The message collector for acquiring messages logged by this method.VersionBean
with the revision status prior to check out.ServiceException
- Wraps any exception underlying the service call.VersionBean checkin(AssetId assetId, String comment, boolean keepCheckedOut, MessageCollectors.VersioningMessageCollector collector) throws ServiceException
assetId
- The identifier for the asset being reverted.comment
- The message associated with this check in.collector
- The message collector for acquiring messages logged by this method.keepCheckedOut
- Set to true
to keep the asset checked out even after checking in the new version.VersionBean
with the new revision.ServiceException
- Wraps any exception underlying the service call.List<AssetId> getCheckedoutAssets() throws ServiceException
ServiceException
- Wraps any exception underlying the service call.List<VersionBean> getCheckedoutAssetsWithDates() throws ServiceException
ServiceException
- Wraps any exception underlying the service call.boolean isTracked(String assetType) throws ServiceException
checkin()
, checkout()
and undoCheckout()
methods
will always return null
.assetType
- The asset type to check if revision tracking is enabled.true
if revision tracking is enabled for
The specified asset type, false
otherwise.ServiceException
- Wraps any exception underlying the service call.VersionBean getCurrentRevision(AssetId assetId) throws ServiceException
VersionBean
.assetId
- The identifier for the asset whose version is to be retrieved.ServiceException
- Wraps any exception underlying the service call.