|
Project: stp | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Version
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.
| 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 |
| Field Detail |
|---|
static final PropertyNameList.PropertyName<Activity> ACTIVITY
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.
setActivity(javax.wvcm.Activity),
getActivity()static final PropertyNameList.PropertyName<Version.Fork> CHECKIN_FORK
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.
setCheckinFork(javax.wvcm.Version.Fork),
getCheckinFork()static final PropertyNameList.PropertyName<Version.Fork> CHECKOUT_FORK
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.
setCheckoutFork(javax.wvcm.Version.Fork),
getCheckoutFork()static final PropertyNameList.PropertyName<ResourceList<ControllableResource>> CHECKOUT_LIST
ControllableResource.CHECKED_OUT property.
getCheckoutList()static final PropertyNameList.PropertyName<ResourceList<Baseline>> IN_BASELINE_LIST
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.
getInBaselineList()static final PropertyNameList.PropertyName<ResourceList<Workspace>> IN_WORKSPACE_LIST
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.
getInWorkspaceList()static final PropertyNameList.PropertyName<List<String>> LABEL_NAME_LIST
getLabelNameList()static final PropertyNameList.PropertyName<ResourceList<Version>> PREDECESSOR_LIST
getPredecessorList()static final PropertyNameList.PropertyName<ResourceList<Version>> SUCCESSOR_LIST
SUCCESSOR_LIST property is the computed inverse of the
PREDECESSOR_LIST property.
getSuccessorList()static final PropertyNameList.PropertyName<VersionHistory> VERSION_HISTORY
getVersionHistory()static final PropertyNameList.PropertyName<String> VERSION_NAME
getVersionName()| Method Detail |
|---|
Version doAddLabel(String label,
Feedback feedback)
throws WvcmException
label - the label to be added to this versionfeedback - Specifies optional feedback to the caller.
WvcmException - WvcmException.ReasonCode.ADD_MUST_BE_NEW_LABEL:
The label MUST NOT already identify a version in the version history of this version.
Version doRemoveLabel(String label,
Feedback feedback)
throws WvcmException
label - the label to be removed from this version.feedback - Specifies optional feedback to the caller.
WvcmException - ReasonCode:
WvcmException.ReasonCode.CANNOT_REMOVE_LABEL_DOES_NOT_EXIST:
The label must be on this version.
Version doSetLabel(String label,
Feedback feedback)
throws WvcmException
label - The label to be set on this versionfeedback - Specifies optional feedback to the caller.
WvcmException - if label cannot be set
Activity getActivity()
throws WvcmException
ACTIVITY property.
ACTIVITY property.
WvcmException - if this property was not set and
this Version was not created with
ACTIVITY as a wanted property.setActivity(javax.wvcm.Activity)
Version.Fork getCheckinFork()
throws WvcmException
CHECKIN_FORK property.
CHECKIN_FORK property.
WvcmException - if this property was not set and
this Version was not created with
CHECKIN_FORK as a wanted property.setCheckinFork(javax.wvcm.Version.Fork)
Version.Fork getCheckoutFork()
throws WvcmException
CHECKOUT_FORK property.
CHECKOUT_FORK property.
WvcmException - if this property was not set and
this Version was not created with
CHECKOUT_FORK as a wanted property.setCheckoutFork(javax.wvcm.Version.Fork)
ResourceList<ControllableResource> getCheckoutList()
throws WvcmException
CHECKOUT_LIST property.
CHECKOUT_LIST property.
WvcmException - if this Version was not created with
CHECKOUT_LIST as a wanted property.
ResourceList<Baseline> getInBaselineList()
throws WvcmException
IN_BASELINE_LIST property.
IN_BASELINE_LIST property.
WvcmException - if this Version was not created with
IN_BASELINE_LIST as a wanted property.
ResourceList<Workspace> getInWorkspaceList()
throws WvcmException
IN_WORKSPACE_LIST property.
IN_WORKSPACE_LIST property.
WvcmException - if this Version was not created with
IN_WORKSPACE_LIST as a wanted property.
List<String> getLabelNameList()
throws WvcmException
LABEL_NAME_LIST property.
LABEL_NAME_LIST property.
WvcmException - if this Version was not created with
LABEL_NAME_LIST as a wanted property.
ResourceList<Version> getPredecessorList()
throws WvcmException
PREDECESSOR_LIST property.
PREDECESSOR_LIST property.
WvcmException - if this Version was not created with
PREDECESSOR_LIST as a wanted property.
ResourceList<Version> getSuccessorList()
throws WvcmException
SUCCESSOR_LIST property.
SUCCESSOR_LIST property.
WvcmException - if this Version was not created with
SUCCESSOR_LIST as a wanted property.
VersionHistory getVersionHistory()
throws WvcmException
VERSION_HISTORY property.
VERSION_HISTORY property.
WvcmException - if this Version was not created with
VERSION_HISTORY as a wanted property.
String getVersionName()
throws WvcmException
VERSION_NAME property.
VERSION_NAME property.
WvcmException - if this Version was not created with
VERSION_NAME as a wanted property.void setActivity(Activity activity)
ACTIVITY property.
activity - an Activity object that specifies
the new ACTIVITY property for this Version.getActivity()void setCheckinFork(Version.Fork val)
CHECKIN_FORK property.
val - the new CHECKIN_FORK value for this Version.getCheckinFork()void setCheckoutFork(Version.Fork val)
CHECKOUT_FORK property.
val - the new CHECKOUT_FORK value for this Version.getCheckoutFork()WorkspaceProvider workspaceProvider()
WorkspaceProvider for this Resource.
|
Generated Thu 15-Aug-2013 02:30 AM | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||