javax.wvcm
Interface VersionHistory

All Superinterfaces:
Folder, Resource
All Known Implementing Classes:
VersionHistoryImpl

public interface VersionHistory
extends Folder

A version history resource contains all versions of a version-controlled resource as the bound members of the version history. The binding name of a version in a version history the version name of that version.


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.Binding
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.GenericResourceImpl
 
Method Summary
 Version doLatestActivityVersionReport(Activity activity, PropertyNameList wantedPropertyList)
          Return latest version in this VersionHistory that is a product of the specified activity.
 Version getRootVersion()
          Return the root version of this VersionHistory.
 Folder getVersionByLabelFolder()
          Return the Folder that contains a bound member for each label that selects a version of this VersionHistory, where the label is the binding name of the member, and the labelled version is the bound resource.
 
Methods inherited from interface javax.wvcm.Folder
doReadMemberList, getBindingList
 
Methods inherited from interface javax.wvcm.Resource
doBind, doCopy, doLock, doLock, doReadAccessControlList, doReadContent, doReadProperties, doRebind, doSearch, doUnbind, doUnlock, doUnlock, doWriteAccessControlList, doWriteContent, doWriteProperties, getAttribute, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreationUser, getCreatorDisplayName, getDisplayName, getLastModified, getLockTokens, getModificationDate, getModificationUser, getOwner, getParentBindingList, getPrincipalFolderList, getPrivilegeFolderList, getProperty, getPropertyNameList, getProviderList, getResourceIdentifier, getSupportedPrivilegeList, getUpdatedPropertyList, getWorkspaceFolderList, location, removeAttribute, setAttribute, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setProperty
 

Method Detail

getRootVersion

Version getRootVersion()
                       throws WvcmException
Return the root version of this VersionHistory. The root version has no predecessors, and each other versions in this VersionHistory is a descendant of the root version.

Throws:
WvcmException - if this VersionHistory was not created with ROOT_VERSION as a wanted property.

getVersionByLabelFolder

Folder getVersionByLabelFolder()
                               throws WvcmException
Return the Folder that contains a bound member for each label that selects a version of this VersionHistory, where the label is the binding name of the member, and the labelled version is the bound resource.

Throws:
WvcmException - if this VersionHistory was not created with PropertyNameList.PropertyName.VERSION_BY_LABEL_FOLDER as a wanted property.

doLatestActivityVersionReport

Version doLatestActivityVersionReport(Activity activity,
                                      PropertyNameList wantedPropertyList)
                                      throws WvcmException
Return latest version in this VersionHistory that is a product of the specified activity.

Parameters:
activity - The activity whose latest product is to be returned.
wantedPropertyList - The properties available in the returned proxies.
Throws:
WvcmException


Copyright (c) 2003 - Apache Software Foundation