|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Version
A version is an immutable copy of a particular state of a version-controlled resource.
Nested Class Summary | |
---|---|
static class |
Version.Fork
Valid values for the CheckinFork and CheckoutFork properties. |
Nested classes/interfaces inherited from interface javax.wvcm.Resource |
---|
Resource.GenericResourceImpl |
Method Summary | |
---|---|
java.util.List |
getActivityList()
Return a list of Activity objects that identify the
activities to which this Version contributes, and on which
lines of descent this version appears. |
int |
getCheckinFork()
Return the CheckinFork property, which determines whether this Version can be given more than one successor. |
int |
getCheckoutFork()
Return the CheckoutFork property, which determines whether a version-controlled resource selecting this Version
can be checked out when it already has a successor version. |
java.util.List |
getCheckoutList()
Return a list of ControllableResource objects
that identify the checked-out version-controlled
resources that refer to this Version in their CheckedOut property. |
java.util.List |
getLabelNameList()
Return a list of String objects that identify labels that currently select this Version . |
java.util.List |
getPredecessorList()
Return a list of Version objects that identify
the predecessors of this Version . |
java.util.List |
getSuccessorList()
Return a list of Version objects that identify
the versions that are the successors of this Version . |
VersionHistory |
getVersionHistory()
Return the version history resource that contains this Version . |
java.lang.String |
getVersionName()
Return the version name of this Version . |
void |
setActivityList(java.util.List activityList)
Set the ActivityList property. |
void |
setCheckinFork(int val)
Set the CheckinFork property. |
void |
setCheckoutFork(int val)
Set the CheckoutFork property. |
Method Detail |
---|
java.util.List getActivityList() throws WvcmException
Activity
objects that identify the
activities to which this Version
contributes, and on which
lines of descent this version appears.
WvcmException
- if this Version
was not created with
ACTIVITY_LIST
as a wanted property.void setActivityList(java.util.List activityList)
activityList
- A list of Activity
objects that specify
the new ActivityList property for this Version
.int getCheckinFork() throws WvcmException
Version
can be given more than one successor.
If the CheckinFork of a version is FORBIDDEN, a doCheckin request MUST fail
if it would result in that version appearing in the PredecessorList of more than one version.
If CheckinFork is DISCOURAGED, such a doCheckin request MUST fail unless forkOk is specified
in the doCheckin request.
WvcmException
- if this Version
was not created with
CHECKIN_FORK
as a wanted property.void setCheckinFork(int val)
val
- The new CheckinFork value for this Version
.int getCheckoutFork() throws WvcmException
Version
can be checked out when it already has a successor version.
If the CheckoutFork of a version is FORBIDDEN, a doCheckout request MUST fail
if it would result in that version appearing in the PredecessorList or CheckedOut property
of more than one version or checked-out resource.
If CheckoutFork is DISCOURAGED, such a doCheckout request MUST fail unless forkOk is specified
in the doCheckout request.
WvcmException
- if this Version
was not created with
CHECKOUT_FORK
as a wanted property.void setCheckoutFork(int val)
val
- The new CheckoutFork value for this Version
.java.util.List getCheckoutList() throws WvcmException
ControllableResource
objects
that identify the checked-out version-controlled
resources that refer to this Version
in their CheckedOut property.
WvcmException
- if this Version
was not created with
CHECKOUT_LIST
as a wanted property.ControllableResource.getCheckedOut
java.util.List getLabelNameList() throws WvcmException
Version
.
WvcmException
- if this Version
was not created with
LABEL_NAME_LIST
as a wanted property.java.util.List getPredecessorList() throws WvcmException
Version
objects that identify
the predecessors of this Version
.
WvcmException
- if this Version
was not created with
PREDECESSOR_LIST
as a wanted property.java.util.List getSuccessorList() throws WvcmException
Version
objects that identify
the versions that are the successors of this Version
.
WvcmException
- if this Version
was not created with
SUCCESSOR_LIST
as a wanted property.VersionHistory getVersionHistory() throws WvcmException
Version
.
WvcmException
- if this Version
was not created with
VERSION_HISTORY
as a wanted property.java.lang.String getVersionName() throws WvcmException
Version
.
This property contains a server-defined string that is different for each version
in a given version history. 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.
WvcmException
- if this Version
was not created with
VERSION_NAME
as a wanted property.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |