org.apache.wvcm.store
Interface ControllableResourceAccessor

All Superinterfaces:
Accessor, ResourceAccessor
All Known Subinterfaces:
ConfigurationAccessor, ControllableFolderAccessor, WorkspaceAccessor
All Known Implementing Classes:
ConfigurationWebdavAccessor, ControllableFolderWebdavAccessor, ControllableResourceWebdavAccessor, WorkspaceWebdavAccessor

public interface ControllableResourceAccessor
extends ResourceAccessor

Persistent controllable resource state accessor.

Version:
$Revision: 1.1.1.1.2.3 $

Method Summary
 void doAddLabel(java.lang.String label)
          Apply ControllableResource.doAddLabel(java.lang.String) to the CheckedIn version of this ControllableResource.
 void doCheckin(boolean keepCheckedOut, boolean forkOK)
          Changes the state of the resource identified by the associated ControllableResource to be checked-in.
 void doCheckout(boolean forkOK, java.util.List activityList, boolean newActivity, boolean unreserved)
          Checkout the associated resource so that its content can be modified.
 void doControl()
          Put the associated resource under (version) control.
 void doCreateResource()
          Create a new persistent controllable resource at the location of the associated resource.
 void doCreateVersionControlledResource(Version v)
          Create a new controlled resource at the location identified by the proxy.
 Version doReadLabelledVersionProperties(java.lang.String label, PropertyNameList wantedPropertyList)
          Apply ControllableResource.doReadLabelledVersionProperties(java.lang.String, javax.wvcm.PropertyNameList) to the version history of this ControllableResource.
 void doRemoveLabel(java.lang.String label)
          Apply ControllableResource.doRemoveLabel(java.lang.String) to the CheckedIn version of this ControllableResource.
 void doSetLabel(java.lang.String label)
          Apply ControllableResource.doSetLabel(java.lang.String) to the CheckedIn version of this ControllableResource.
 void doUncheckout()
          Cancels the checkout of a version-controlled resource, and restores its content to the state of its CheckedOut version.
 java.util.Iterator doUpdate(Version version, PropertyNameList wantedPropertyList)
          Update the state of the associated checked-in version-controlled ControllableResource to be the same as the specified version from the version history of the associated ControllableResource.
 
Methods inherited from interface org.apache.wvcm.store.ResourceAccessor
doCheckExists, doCopy, doDelete, doLock, doMove, doReadAccessControlList, doReadContent, doReadProperties, doSearch, doUnlock, doWriteAccessControlList, doWriteContent, doWriteProperties, resource
 
Methods inherited from interface org.apache.wvcm.store.Accessor
serverWorkspaceFolderList
 

Method Detail

doCreateResource

void doCreateResource()
                      throws WvcmException
Create a new persistent controllable resource at the location of the associated resource.

Throws:
WvcmException

doControl

void doControl()
               throws WvcmException
Put the associated resource under (version) control.

Throws:
WvcmException

doCheckout

void doCheckout(boolean forkOK,
                java.util.List activityList,
                boolean newActivity,
                boolean unreserved)
                throws WvcmException
Checkout the associated resource so that its content can be modified.

Parameters:
forkOK - Indicates whether to do the checkout even if the version already has a successor or a checkout.
activityList - A list of Activity objects that identify the activities to which the work on the checked-out resource will contribute.
newActivity - Indicates whether to create a new activity for the checkout.
unreserved - Indicates whether to do the checkout even if there already is a checkout from the currently selected version in one of the activities specified in the activityList.
Throws:
WvcmException

doCheckin

void doCheckin(boolean keepCheckedOut,
               boolean forkOK)
               throws WvcmException
Changes the state of the resource identified by the associated ControllableResource to be checked-in. If version history is being tracked for the resource, the current content of the resource is captured in a new version resource at a server-defined location.

Parameters:
keepCheckedOut - indicates whether to checkout the resource again immediately after checking it in. If keepCheckedOut is true, the ActivityList and Unreserved properties should not be changed by the checkout.
forkOK - indicates whether to fork even if forking is discouraged.
Throws:
WvcmException

doUncheckout

void doUncheckout()
                  throws WvcmException
Cancels the checkout of a version-controlled resource, and restores its content to the state of its CheckedOut version.

Throws:
WvcmException

doUpdate

java.util.Iterator doUpdate(Version version,
                            PropertyNameList wantedPropertyList)
                            throws WvcmException
Update the state of the associated checked-in version-controlled ControllableResource to be the same as the specified version from the version history of the associated ControllableResource.

Parameters:
version - The version specifying the new state of the resource
wantedPropertyList - The list of properties that will be available
Returns:
An iterator of ControllableResource objects that have been modified as a result of the doUpdate request. Each version-controlled resource contains a value for each of the properties specified in the WantedPropertyList.
Throws:
WvcmException

doCreateVersionControlledResource

void doCreateVersionControlledResource(Version v)
                                       throws WvcmException
Create a new controlled resource at the location identified by the proxy. The resource is associated with an existing version history, and is initialized with a specified version from that version history. The request will fail if a resource already exists at that location.

Parameters:
v - The version used to initialize the controlled resource.
Throws:
WvcmException

doAddLabel

void doAddLabel(java.lang.String label)
                throws WvcmException
Apply ControllableResource.doAddLabel(java.lang.String) to the CheckedIn version of this ControllableResource.

Throws:
WvcmException

doSetLabel

void doSetLabel(java.lang.String label)
                throws WvcmException
Apply ControllableResource.doSetLabel(java.lang.String) to the CheckedIn version of this ControllableResource.

Throws:
WvcmException

doRemoveLabel

void doRemoveLabel(java.lang.String label)
                   throws WvcmException
Apply ControllableResource.doRemoveLabel(java.lang.String) to the CheckedIn version of this ControllableResource.

Throws:
WvcmException

doReadLabelledVersionProperties

Version doReadLabelledVersionProperties(java.lang.String label,
                                        PropertyNameList wantedPropertyList)
                                        throws WvcmException
Apply ControllableResource.doReadLabelledVersionProperties(java.lang.String, javax.wvcm.PropertyNameList) to the version history of this ControllableResource.

Throws:
WvcmException


Copyright (c) 2003 - Apache Software Foundation