Project: stp

javax.wvcm
Interface Version

All Superinterfaces:
Resource
All Known Subinterfaces:
Baseline, CcBaseline, CcDirectoryVersion, CcVersion, FolderVersion, SymbolicLinkVersion

public interface Version
extends Resource

A proxy for a version resource. A version resource contains an immutable copy of the properties of a version-controlled resource. A version resource also contains mutable properties with metadata about that version.

Since:
1.0

Nested Class Summary
static class Version.Fork
          Valid values for the CHECKIN_FORK and CHECKOUT_FORK properties.
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<Activity> ACTIVITY
          The Activity object that identify the activity to which this version contributes.
static PropertyNameList.PropertyName<Version.Fork> CHECKIN_FORK
          An enumeration that determines whether this Version can be given more than one successor.
static PropertyNameList.PropertyName<Version.Fork> CHECKOUT_FORK
          An enumeration that determines whether a version-controlled resource selecting this Version can be checked out when it already has a successor version.
static PropertyNameList.PropertyName<ResourceList<ControllableResource>> CHECKOUT_LIST
          A list of all controllable resources that are checked out from this version.
static PropertyNameList.PropertyName<ResourceList<Baseline>> IN_BASELINE_LIST
          A list of all baselines that contain this version in their Baseline.VERSION_LIST property.
static PropertyNameList.PropertyName<ResourceList<Workspace>> IN_WORKSPACE_LIST
          A list of all workspaces that have a controllable resource that contains this version in its ControllableResource.CHECKED_IN or ControllableResource.CHECKED_OUT property.
static PropertyNameList.PropertyName<List<String>> LABEL_NAME_LIST
          A list of strings that identify the labels that currently select this Version.
static PropertyNameList.PropertyName<ResourceList<Version>> PREDECESSOR_LIST
          A list of all versions that are direct predecessors of this version.
static PropertyNameList.PropertyName<ResourceList<Version>> SUCCESSOR_LIST
          A list of all versions that are direct successors of this version.
static PropertyNameList.PropertyName<VersionHistory> VERSION_HISTORY
          The version history that contains this version.
static PropertyNameList.PropertyName<String> VERSION_NAME
          A server-defined string that is different for each version in the version history of this version.
 
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 doAddLabel(String label, Feedback feedback)
          Add the specified label to this version.
 Version doRemoveLabel(String label, Feedback feedback)
          Remove the specified label from this version.
 Version doSetLabel(String label, Feedback feedback)
          Set the specified label on this version.
 Activity getActivity()
          Get the ACTIVITY property.
 Version.Fork getCheckinFork()
          Get the CHECKIN_FORK property.
 Version.Fork getCheckoutFork()
          Get the CHECKOUT_FORK property.
 ResourceList<ControllableResource> getCheckoutList()
          Get the CHECKOUT_LIST property.
 ResourceList<Baseline> getInBaselineList()
          Get the IN_BASELINE_LIST property.
 ResourceList<Workspace> getInWorkspaceList()
          Get the IN_WORKSPACE_LIST property.
 List<String> getLabelNameList()
          Get the LABEL_NAME_LIST property.
 ResourceList<Version> getPredecessorList()
          Get the PREDECESSOR_LIST property.
 ResourceList<Version> getSuccessorList()
          Get the SUCCESSOR_LIST property.
 VersionHistory getVersionHistory()
          Get the VERSION_HISTORY property.
 String getVersionName()
          Get the VERSION_NAME property.
 void setActivity(Activity activity)
          Set the ACTIVITY property.
 void setCheckinFork(Version.Fork val)
          Set the CHECKIN_FORK property.
 void setCheckoutFork(Version.Fork val)
          Set the CHECKOUT_FORK property.
 WorkspaceProvider workspaceProvider()
          Get the workspace provider of this resource.
 
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

ACTIVITY

static final PropertyNameList.PropertyName<Activity> ACTIVITY
The Activity object that identify the activity to which this version contributes. A provider may refuse to allow the activity of a version to be modified. This version must be on the same line of descent as all other versions with this activity from the same version history. If the Activity.ACTIVITY_CHECKOUT_LIST of the activity identifies a controllable resource that is reserved and checks out a version in the version history of this version, then the checked-out version must be a successor of all other versions with this activity from the same version history.

See Also:
setActivity(javax.wvcm.Activity), getActivity()

CHECKIN_FORK

static final PropertyNameList.PropertyName<Version.Fork> CHECKIN_FORK
An enumeration that determines whether this Version can be given more than one successor. If CHECKIN_FORK is Version.Fork.DISCOURAGED, a doCheckin request MUST fail unless forkOk is specified in the doCheckin request. If the CHECKIN_FORK of a version is Version.Fork.FORBIDDEN, a doCheckin request MUST fail if it would result in that version appearing in the PREDECESSOR_LIST of more than one version. A server MAY reject attempts to modify the CHECKIN_FORK of a version.

See Also:
setCheckinFork(javax.wvcm.Version.Fork), getCheckinFork()

CHECKOUT_FORK

static final PropertyNameList.PropertyName<Version.Fork> CHECKOUT_FORK
An enumeration that determines whether a version-controlled resource selecting this Version can be checked out when it already has a successor version. If CHECKOUT_FORK is Version.Fork.DISCOURAGED, a doCheckout request MUST fail unless forkOk is specified in the doCheckout request. If the CHECKOUT_FORK of a version is Version.Fork.FORBIDDEN, a doCheckout request will fail if it would result in that version appearing in the PREDECESSOR_LIST or ControllableResource.CHECKED_OUT property of more than one version or checked-out resource. A server MAY reject attempts to modify the CHECKOUT_FORK of a version.

See Also:
setCheckoutFork(javax.wvcm.Version.Fork), getCheckoutFork()

CHECKOUT_LIST

static final PropertyNameList.PropertyName<ResourceList<ControllableResource>> CHECKOUT_LIST
A list of all controllable resources that are checked out from this version. This is the computed inverse of the ControllableResource.CHECKED_OUT property.

See Also:
getCheckoutList()

IN_BASELINE_LIST

static final PropertyNameList.PropertyName<ResourceList<Baseline>> IN_BASELINE_LIST
A list of all baselines that contain this version in their Baseline.VERSION_LIST property. This is the computed inverse of the Baseline.VERSION_LIST property. Because there can be many baselines that contain a given version, this property is most commonly used in a Resource.doFind(javax.wvcm.Feedback) request.

See Also:
getInBaselineList()

IN_WORKSPACE_LIST

static final PropertyNameList.PropertyName<ResourceList<Workspace>> IN_WORKSPACE_LIST
A list of all workspaces that have a controllable resource that contains this version in its ControllableResource.CHECKED_IN or ControllableResource.CHECKED_OUT property. Because there can be many workspaces that contain a given version, this property is most commonly used in a Resource.doFind(javax.wvcm.Feedback) request.

See Also:
getInWorkspaceList()

LABEL_NAME_LIST

static final PropertyNameList.PropertyName<List<String>> LABEL_NAME_LIST
A list of strings that identify the labels that currently select this Version.

See Also:
getLabelNameList()

PREDECESSOR_LIST

static final PropertyNameList.PropertyName<ResourceList<Version>> PREDECESSOR_LIST
A list of all versions that are direct predecessors of this version.

See Also:
getPredecessorList()

SUCCESSOR_LIST

static final PropertyNameList.PropertyName<ResourceList<Version>> SUCCESSOR_LIST
A list of all versions that are direct successors of this version. The SUCCESSOR_LIST property is the computed inverse of the PREDECESSOR_LIST property.

See Also:
getSuccessorList()

VERSION_HISTORY

static final PropertyNameList.PropertyName<VersionHistory> VERSION_HISTORY
The version history that contains this version.

See Also:
getVersionHistory()

VERSION_NAME

static final PropertyNameList.PropertyName<String> VERSION_NAME
A server-defined string that is different for each version in the version history of this version. This string is intended for display to a user, unlike the location of a version, which is normally only used by a client and not displayed to a user.

See Also:
getVersionName()
Method Detail

doAddLabel

Version doAddLabel(String label,
                   Feedback feedback)
                   throws WvcmException
Add the specified label to this version.

Parameters:
label - the label to be added to this version
feedback - Specifies optional feedback to the caller.
Returns:
A new proxy for this resource, whose properties are specified by feedback.
Throws:
WvcmException -
  • WvcmException.ReasonCode.ADD_MUST_BE_NEW_LABEL: The label MUST NOT already identify a version in the version history of this version.

  • doRemoveLabel

    Version doRemoveLabel(String label,
                          Feedback feedback)
                          throws WvcmException
    Remove the specified label from this version.

    Parameters:
    label - the label to be removed from this version.
    feedback - Specifies optional feedback to the caller.
    Returns:
    A new proxy for this resource, whose properties are specified by feedback.
    Throws:
    WvcmException - ReasonCode:
  • WvcmException.ReasonCode.CANNOT_REMOVE_LABEL_DOES_NOT_EXIST: The label must be on this version.

  • doSetLabel

    Version doSetLabel(String label,
                       Feedback feedback)
                       throws WvcmException
    Set the specified label on this version.

    Parameters:
    label - The label to be set on this version
    feedback - Specifies optional feedback to the caller.
    Returns:
    A new proxy for this resource, whose properties are specified by feedback.
    Throws:
    WvcmException - if label cannot be set

    getActivity

    Activity getActivity()
                         throws WvcmException
    Get the ACTIVITY property.

    Returns:
    the ACTIVITY property.
    Throws:
    WvcmException - if this property was not set and this Version was not created with ACTIVITY as a wanted property.
    See Also:
    setActivity(javax.wvcm.Activity)

    getCheckinFork

    Version.Fork getCheckinFork()
                                throws WvcmException
    Get the CHECKIN_FORK property.

    Returns:
    the CHECKIN_FORK property.
    Throws:
    WvcmException - if this property was not set and this Version was not created with CHECKIN_FORK as a wanted property.
    See Also:
    setCheckinFork(javax.wvcm.Version.Fork)

    getCheckoutFork

    Version.Fork getCheckoutFork()
                                 throws WvcmException
    Get the CHECKOUT_FORK property.

    Returns:
    the CHECKOUT_FORK property.
    Throws:
    WvcmException - if this property was not set and this Version was not created with CHECKOUT_FORK as a wanted property.
    See Also:
    setCheckoutFork(javax.wvcm.Version.Fork)

    getCheckoutList

    ResourceList<ControllableResource> getCheckoutList()
                                                       throws WvcmException
    Get the CHECKOUT_LIST property.

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

    getInBaselineList

    ResourceList<Baseline> getInBaselineList()
                                             throws WvcmException
    Get the IN_BASELINE_LIST property.

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

    getInWorkspaceList

    ResourceList<Workspace> getInWorkspaceList()
                                               throws WvcmException
    Get the IN_WORKSPACE_LIST property.

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

    getLabelNameList

    List<String> getLabelNameList()
                                  throws WvcmException
    Get the LABEL_NAME_LIST property.

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

    getPredecessorList

    ResourceList<Version> getPredecessorList()
                                             throws WvcmException
    Get the PREDECESSOR_LIST property.

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

    getSuccessorList

    ResourceList<Version> getSuccessorList()
                                           throws WvcmException
    Get the SUCCESSOR_LIST property.

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

    getVersionHistory

    VersionHistory getVersionHistory()
                                     throws WvcmException
    Get the VERSION_HISTORY property.

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

    getVersionName

    String getVersionName()
                          throws WvcmException
    Get the VERSION_NAME property.

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

    setActivity

    void setActivity(Activity activity)
    Set the ACTIVITY property.

    Parameters:
    activity - an Activity object that specifies the new ACTIVITY property for this Version.
    See Also:
    getActivity()

    setCheckinFork

    void setCheckinFork(Version.Fork val)
    Set the CHECKIN_FORK property.

    Parameters:
    val - the new CHECKIN_FORK value for this Version.
    See Also:
    getCheckinFork()

    setCheckoutFork

    void setCheckoutFork(Version.Fork val)
    Set the CHECKOUT_FORK property.

    Parameters:
    val - the new CHECKOUT_FORK value for this Version.
    See Also:
    getCheckoutFork()

    workspaceProvider

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

    Returns:
    the WorkspaceProvider for this Resource.

    Generated Fri 30-Jul-2010 12:52 AM

    Copyright © IBM 2010. All rights reserved.