Project: stp

javax.wvcm
Interface VersionHistory

All Superinterfaces:
Folder, Resource
All Known Subinterfaces:
CcComponent, CcDirectoryElement, CcElement, Component

public interface VersionHistory
extends Folder

A proxy for a version history resource. 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 is the version name of that version. When a version is removed as a bound member from its version history, it is also removed from any other folder that contains it as a bound member.

Since:
1.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.BindFlag, Folder.RebindFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<Version> ROOT_VERSION
          The root version of this VersionHistory.
 
Fields inherited from interface javax.wvcm.Folder
CHILD_LIST, CHILD_MAP
 
Fields inherited from interface javax.wvcm.Resource
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST
 
Method Summary
 Version doLatestActivityVersionReport(Activity activity, Feedback feedback)
          Get the latest Version for a given activity.
 Version getRootVersion()
          Get the ROOT_VERSION property.
 WorkspaceProvider workspaceProvider()
          Get the workspace provider of this resource.
 
Methods inherited from interface javax.wvcm.Folder
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
 
Methods inherited from interface javax.wvcm.Resource
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getDisplayName, getIsExecutable, getLastModified, getParentList, getPathnameLocation, getProperty, getProviderList, getResourceIdentifier, getWorkspaceFolderList, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setIsExecutable, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

ROOT_VERSION

static final PropertyNameList.PropertyName<Version> ROOT_VERSION
The root version of this VersionHistory. The root version has no predecessors, and every other version in this version history is a descendant of the root version.

Method Detail

doLatestActivityVersionReport

Version doLatestActivityVersionReport(Activity activity,
                                      Feedback feedback)
                                      throws WvcmException
Get the latest Version for a given activity.

Parameters:
activity - the activity whose latest product is to be returned.
feedback - the properties available in the returned proxies.
Returns:
the latest Version in this VersionHistory that is a product of the specified activity. May be null.
Throws:
WvcmException - ReasonCode:
  • WvcmException.ReasonCode.METHOD_NOT_SUPPORTED: This resource does not support this report.
  • WvcmException.ReasonCode.BAD_ARGUMENT_TYPE: The activity argument MUST identify an activity.

  • getRootVersion

    Version getRootVersion()
                           throws WvcmException
    Get the ROOT_VERSION property.

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

    workspaceProvider

    WorkspaceProvider workspaceProvider()
    Get the workspace provider of this resource.

    Returns:
    the WorkspaceProvider for this Resource.

    Generated Wed 28-Nov-2012 10:22 AM

    Copyright © IBM 2012. All rights reserved.