javax.wvcm
Interface Version

All Superinterfaces:
Resource
All Known Subinterfaces:
Baseline, FolderVersion
All Known Implementing Classes:
BaselineImpl, FolderVersionImpl, VersionImpl

public interface Version
extends Resource

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.
 
Methods inherited from interface javax.wvcm.Resource
doBind, doCopy, doLock, doLock, doReadAccessControlList, doReadContent, doReadProperties, doRebind, doSearch, doUnbind, doUnlock, doUnlock, doWriteAccessControlList, doWriteContent, doWriteProperties, getAttribute, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreationUser, getCreatorDisplayName, getDisplayName, getLastModified, getLockTokens, getModificationDate, getModificationUser, getOwner, getParentBindingList, getPrincipalFolderList, getPrivilegeFolderList, getProperty, getPropertyNameList, getProviderList, getResourceIdentifier, getSupportedPrivilegeList, getUpdatedPropertyList, getWorkspaceFolderList, location, removeAttribute, setAttribute, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setProperty
 

Method Detail

getActivityList

java.util.List getActivityList()
                               throws WvcmException
Return a list of Activity objects that identify the activities to which this Version contributes, and on which lines of descent this version appears.

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

setActivityList

void setActivityList(java.util.List activityList)
Set the ActivityList property. A server MAY restrict the ActivityList to identify a single activity. A server MAY refuse to allow the value of the ActivityList property of a version to be modified.

Parameters:
activityList - A list of Activity objects that specify the new ActivityList property for this Version.

getCheckinFork

int getCheckinFork()
                   throws WvcmException
Return the CheckinFork property, which determines whether this 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.

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

setCheckinFork

void setCheckinFork(int val)
Set the CheckinFork property. A server MAY reject attempts to modify the CheckinFork of a version.

Parameters:
val - The new CheckinFork value for this Version.

getCheckoutFork

int getCheckoutFork()
                    throws WvcmException
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. 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.

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

setCheckoutFork

void setCheckoutFork(int val)
Set the CheckoutFork property. A server MAY reject attempts to modify the CheckoutFork of a version.

Parameters:
val - The new CheckoutFork value for this Version.

getCheckoutList

java.util.List getCheckoutList()
                               throws WvcmException
Return a list of ControllableResource objects that identify the checked-out version-controlled resources that refer to this Version in their CheckedOut property.

Throws:
WvcmException - if this Version was not created with CHECKOUT_LIST as a wanted property.
See Also:
ControllableResource.getCheckedOut

getLabelNameList

java.util.List getLabelNameList()
                                throws WvcmException
Return a list of String objects that identify labels that currently select this Version.

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

getPredecessorList

java.util.List getPredecessorList()
                                  throws WvcmException
Return a list of Version objects that identify the predecessors of this Version.

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

getSuccessorList

java.util.List getSuccessorList()
                                throws WvcmException
Return a list of Version objects that identify the versions that are the successors of this Version.

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

getVersionHistory

VersionHistory getVersionHistory()
                                 throws WvcmException
Return the version history resource that contains this Version.

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

getVersionName

java.lang.String getVersionName()
                                throws WvcmException
Return the version name of this 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.

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


Copyright (c) 2003 - Apache Software Foundation