|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IVersionManager
Interface to manage content node versions in the content system.
Methods returning an ISortableFilterablePagedList
may perform sorting and filtering. See the documentation
in com.bea.content.paging
, VirtualNode
and Version
.
Note: new methods may be added to this interface periodically -- therefore, this is not a good CM extension point. The recommended extension point is at the Service Provider Interface, in package com.bea.content.spi
Method Summary | |
---|---|
void |
checkIn(ContentContext context,
ID nodeId,
VersionableContent content)
Checks in the the specified version of the node with the specified id. |
VirtualNode |
checkOut(ContentContext context,
ID nodeId,
String version)
Check out the specified version of a content node. |
ISortableFilterablePagedList<VirtualNode> |
getCheckedOutNodes(ContentContext context)
Return all the checked-out nodes for the user. |
VirtualNode |
getNode(ContentContext context,
ID nodeId)
Get the VirtualNode representing the Node. |
ISortableFilterablePagedList<VirtualNode> |
getOnlyAssignedNodes(ContentContext context)
Return all the assigned nodes for the user. |
InputStream |
getStream(ContentContext context,
ID nodeId,
ID versionedPropertyId)
Gets the property bytes of a given version. |
Version |
getVersion(ContentContext context,
ID nodeId,
String versionName)
Get the specified version for a given node. |
ISortableFilterablePagedList<Version> |
getVersions(ContentContext context,
ID nodeId)
Returns all the versions for a given node. |
ISortableFilterablePagedList<VirtualNode> |
getWorkingNodes(ContentContext context)
Return all the working nodes for the user. |
boolean |
isCheckedOut(ContentContext context,
ID nodeId)
Convenience method to help determine whether a node is checked out or not. |
void |
revert(ContentContext context,
ID nodeId)
Reverts a given checked out node. |
void |
save(ContentContext context,
ID nodeId,
VersionableContent versionableContent)
Updates the current version of the node with the specified data. |
ISortableFilterablePagedList<Version> |
search(ContentContext context,
Search search)
Perform a meta-data search on the versioning system |
Method Detail |
---|
VirtualNode getNode(ContentContext context, ID nodeId) throws AuthorizationException, NoSuchNodeException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node to get.
AuthorizationException
- Thrown if user is not authorized to perform action.
NoSuchNodeException
- Thrown if the node does not exist.
RepositoryException
- Thrown if an error occurs during this operation.VirtualNode checkOut(ContentContext context, ID nodeId, String version) throws AuthorizationException, NoSuchNodeException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node to check outversion
- The version to be checked out, null if the latest version is desired.
AuthorizationException
- Thrown if user is not authorized to perform action.
NoSuchNodeException
- Thrown if the node does not exist.
RepositoryException
- Thrown if an error occurs during this operation.void checkIn(ContentContext context, ID nodeId, VersionableContent content) throws AuthorizationException, NoSuchNodeException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node being checked in.content
- The content to be checked in. If null, the latest version will be checked in.
AuthorizationException
- Thrown if user is not authorized to perform action.
NoSuchNodeException
- Thrown if the node does not exist.
RepositoryException
- Thrown if an error occurs during this operation.Version getVersion(ContentContext context, ID nodeId, String versionName) throws AuthorizationException, NoSuchNodeException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node.versionName
- The version to be retrieved.
AuthorizationException
- Thrown if user is not authorized to perform action.
NoSuchNodeException
- Thrown if the node does not exist.
RepositoryException
- Thrown if an error occurs during this operation.ISortableFilterablePagedList<Version> getVersions(ContentContext context, ID nodeId) throws AuthorizationException, NoSuchNodeException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node.
AuthorizationException
- Thrown if user is not authorized to perform action.
NoSuchNodeException
- Thrown if the node does not exist.
RepositoryException
- Thrown if an error occurs during this operation.ISortableFilterablePagedList<VirtualNode> getWorkingNodes(ContentContext context) throws RepositoryException
context
- The content context object which contains the user profile information.
RepositoryException
- Thrown if an error occurs during this operation.ISortableFilterablePagedList<VirtualNode> getCheckedOutNodes(ContentContext context) throws RepositoryException
context
- The content context object which contains the user profile information.
RepositoryException
- Thrown if an error occurs during this operation.ISortableFilterablePagedList<VirtualNode> getOnlyAssignedNodes(ContentContext context) throws RepositoryException
context
- The content context object which contains the user profile information.
RepositoryException
- Thrown if an error occurs during this operation.void revert(ContentContext context, ID nodeId) throws AuthorizationException, NoSuchNodeException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node.
AuthorizationException
- Thrown if user is not authorized to perform action.
NoSuchNodeException
- Thrown if the node does not exist.
RepositoryException
- Thrown if an error occurs during this operation.boolean isCheckedOut(ContentContext context, ID nodeId) throws RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node.
RepositoryException
- Thrown if an error occurs during this operation.InputStream getStream(ContentContext context, ID nodeId, ID versionedPropertyId) throws AuthorizationException, NoSuchPropertyException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node.versionedPropertyId
- The ID of the versioned property. ID should contain a valid repositoryName and a UID.
AuthorizationException
- Thrown if user is not authorized to perform action.
NoSuchPropertyException
- Thrown if the property does not exist.
RepositoryException
- Thrown if an error occurs during this operation.void save(ContentContext context, ID nodeId, VersionableContent versionableContent) throws AuthorizationException, RepositoryException
context
- The content context object which contains the user profile information.nodeId
- The id of the node.versionableContent
- The data to save.
AuthorizationException
- Thrown if user is not authorized to perform action.
RepositoryException
- If the node is not checked out by the user, or if the repository
is non library service enabled, or if any other error occurs.ISortableFilterablePagedList<Version> search(ContentContext context, Search search) throws RepositoryException
context
- The content contextsearch
- The search object containing the query criteria
RepositoryException
- Thrown if the search fails.
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |