Project: stp

javax.wvcm
Interface Baseline

All Superinterfaces:
Resource, Version
All Known Subinterfaces:
CcBaseline

public interface Baseline
extends Version

A proxy for a baseline resource. A baseline resource is a version resource that captures the state of each version-controlled member of a configuration. New baselines of a configuration are created by checking out and then checking in the configuration.

Since:
1.0

Nested Class Summary
static interface Baseline.AddedActivity
          An activity whose versions were added by the new set of versions.
static interface Baseline.AddedVersion
          A version from a given version history that is in the new set of versions but no version from the version history of that version is in the old set.
static interface Baseline.ChangedActivity
          An activity whose versions were both added and removed by the new set of versions.
static interface Baseline.ChangedVersion
          A version from a given version history that is in the old set of versions where a different version from that version history is in the new set of versions.
static class Baseline.CompareFlag
          Boolean flags for the doCompareReport method
static interface Baseline.CompareReport
          A description of the difference between two sets of versions.
static interface Baseline.DeletedActivity
          An activity whose versions were deleted by the new baseline.
static interface Baseline.DeletedVersion
          A version from a given version history that is in the old set of versions but no version from that version history is in the new set of versions.
static interface Baseline.PartiallyAddedActivity
          An activity some of whose versions were added by the new set of versions.
static interface Baseline.PartiallyDeletedActivity
          An activity some of whose versions were deleted by the new set of versions.
 
Nested classes/interfaces inherited from interface javax.wvcm.Version
Version.Fork
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<ResourceList<Version>> VERSION_LIST
          A list of all the versions that make up this baseline.
 
Fields inherited from interface javax.wvcm.Version
ACTIVITY, CHECKIN_FORK, CHECKOUT_FORK, CHECKOUT_LIST, IN_BASELINE_LIST, IN_WORKSPACE_LIST, LABEL_NAME_LIST, PREDECESSOR_LIST, SUCCESSOR_LIST, VERSION_HISTORY, VERSION_NAME
 
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
 ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReport(Baseline baseline, Baseline.CompareFlag[] flags, Feedback feedback)
          Compare two baselines.
 ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReport(Stream stream, Baseline.CompareFlag[] flags, Feedback feedback)
          Compare this Baseline with a stream.
 ResourceList<Version> getVersionList()
          Get the VERSION_LIST property.
 
Methods inherited from interface javax.wvcm.Version
doAddLabel, doRemoveLabel, doSetLabel, getActivity, getCheckinFork, getCheckoutFork, getCheckoutList, getInBaselineList, getInWorkspaceList, getLabelNameList, getPredecessorList, getSuccessorList, getVersionHistory, getVersionName, setActivity, setCheckinFork, setCheckoutFork, workspaceProvider
 
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

VERSION_LIST

static final PropertyNameList.PropertyName<ResourceList<Version>> VERSION_LIST
A list of all the versions that make up this baseline. The list is created from all the ControllableResource.CHECKED_IN versions of all the version-controlled members of the Configuration.ROOT_FOLDER of the configuration at the time the baseline identified by this Baseline was created.

Method Detail

doCompareReport

ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReport(Baseline baseline,
                                                                      Baseline.CompareFlag[] flags,
                                                                      Feedback feedback)
                                                                      throws WvcmException
Compare two baselines.

Parameters:
baseline - the baseline being compared to this Baseline.
flags - boolean flags for the compare report.
feedback - the properties available in the returned proxies.
Returns:
a ResponseIterator of CompareReport objects, that enumerate the differences between the versions selected by this Baseline and the baseline argument.
Throws:
WvcmException - ReasonCode:
  • WvcmException.ReasonCode.BAD_ARGUMENT_TYPE: The resource identified by the baseline argument must be a baseline.

  • doCompareReport

    ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReport(Stream stream,
                                                                          Baseline.CompareFlag[] flags,
                                                                          Feedback feedback)
                                                                          throws WvcmException
    Compare this Baseline with a stream.

    Parameters:
    stream - the stream being compared to this Baseline.
    flags - boolean flags for the compare report.
    feedback - the properties available in the returned proxies.
    Returns:
    a ResponseIterator of CompareReport objects, that enumerate the differences between the versions selected by this Stream and the stream argument.
    Throws:
    WvcmException - ReasonCode:
  • WvcmException.ReasonCode.METHOD_NOT_SUPPORTED: This resource does not support this report.
  • WvcmException.ReasonCode.BAD_ARGUMENT_TYPE: The resource identified by the stream argument must be a stream.

  • getVersionList

    ResourceList<Version> getVersionList()
                                         throws WvcmException
    Get the VERSION_LIST property.

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

    Generated Wed 19-Nov-2014 10:09 AM

    Copyright © IBM 2014. All rights reserved.