|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersioningDao
The Versioning Data Access Object provides access to asset revision data.
The versioning service depends on the VersioningDao
to provide the access it requires to pull up this data.
Method Summary | |
---|---|
VersionBean |
checkin(AssetId assetId, java.lang.String userId, java.lang.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, java.lang.String userId, MessageCollectors.VersioningMessageCollector collector) Checks out an asset for the logged in user and returns the current revision. |
java.util.List<AssetId> |
getCheckedoutAssets(java.lang.String userId, long siteId) Returns the list of assets checked out by the specified user in the specified site. |
VersionBean |
getCurrentRevision(AssetId assetId) Returns metadata for the current revision for the specified asset. |
boolean |
isTracked(java.lang.String assetType) Checks if revision tracking is enabled for the specified asset type. |
VersionBean |
undoCheckout(AssetId assetId, java.lang.String userId, 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. |
Methods inherited from interface com.fatwire.services.dao.DataAccessObject |
---|
getResponse, getService, setService |
Method Detail |
---|
VersionBean checkout(AssetId assetId, java.lang.String userId, MessageCollectors.VersioningMessageCollector collector) throws DataAccessException
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.userId
- the id of the user who is checking out the asset.collector
- the message collector for acquiring messages from this method.VersionBean
with the current revision status.DataAccessException
- wraps any underlying exception caused during data access.VersionBean undoCheckout(AssetId assetId, java.lang.String userId, MessageCollectors.VersioningMessageCollector collector) throws DataAccessException
null
.assetId
- the identifier for the asset being reverted.userId
- the id of the user who is undoing the check out on the asset.collector
- the message collector for acquiring messages logged by this method.VersionBean
with the revision status prior to check out.DataAccessException
- wraps any underlying exception caused during data access.VersionBean checkin(AssetId assetId, java.lang.String userId, java.lang.String comment, boolean keepCheckedOut, MessageCollectors.VersioningMessageCollector collector) throws DataAccessException
null
.assetId
- the identifier for the asset being reverted.userId
- the id of the user who is checking in the asset.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.DataAccessException
- wraps any underlying exception caused during data access.java.util.List<AssetId> getCheckedoutAssets(java.lang.String userId, long siteId) throws DataAccessException
userId
- the id of the user by whom the assets are checked out.siteId
- the id of the site in which the assets are checked out.DataAccessException
- wraps any underlying exception caused during data access.boolean isTracked(java.lang.String assetType) throws DataAccessException
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.DataAccessException
- wraps any underlying exception caused during data access.VersionBean getCurrentRevision(AssetId assetId) throws DataAccessException
VersionBean
.assetId
- the identifier for the asset whose version is to be retrieved.DataAccessException
- wraps any underlying exception caused during data access.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.