Project: stp

javax.wvcm
Interface ControllableFolder

All Superinterfaces:
ControllableResource, Folder, Resource
All Known Subinterfaces:
CcDirectory, CcSymlink, CcView, ControllableSymbolicLink, Workspace

public interface ControllableFolder
extends ControllableResource, Folder

A proxy for a controllable folder resource. A controllable folder resource is a folder that can be placed under control. When a controllable folder is placed under version control, a version of that folder only captures the named mappings to version controlled members of that folder. In order to version control the entire configuration rooted at a folder, the folder must be placed under "baseline control".

Since:
1.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.ControllableResource
ControllableResource.CheckinFlag, ControllableResource.CheckoutFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.BindFlag, Folder.RebindFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<Boolean> IS_BASELINE_CONTROLLABLE
          True if the folder can be put under baseline control with the doBaselineControl(javax.wvcm.Feedback) or doCreateBaselineControlledFolder(javax.wvcm.Baseline, javax.wvcm.Feedback) methods, otherwise false.
static PropertyNameList.PropertyName<Boolean> IS_BASELINE_CONTROLLED
          True if the folder has been baseline controlled.
static PropertyNameList.PropertyName<Configuration> ROOT_FOLDER_OF
          The configuration for which this is the root folder.
 
Fields inherited from interface javax.wvcm.ControllableResource
ACTIVITY, AUTO_MERGE_LIST, CHECKED_IN, CHECKED_OUT, CONFIGURATION, IS_CHECKED_OUT, IS_VERSION_CONTROLLABLE, IS_VERSION_CONTROLLED, MERGE_LIST, PREDECESSOR_LIST, RESERVED, VERSION_HISTORY, WORKSPACE
 
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
 
Fields inherited from interface javax.wvcm.Folder
CHILD_LIST, CHILD_MAP
 
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
 ControllableFolder doBaselineControl(Feedback feedback)
          Put this ControllableFolder under baseline control.
 ControllableFolder doCreateBaselineControlledFolder(Baseline baseline, Feedback feedback)
          Create a baseline-controlled controllable folder at this location, and initialize it with the contents of the specified baseline.
 boolean getIsBaselineControllable()
          Get the IS_BASELINE_CONTROLLABLE property.
 boolean getIsBaselineControlled()
          Get the IS_BASELINE_CONTROLLED property.
 Configuration getRootFolderOf()
          Get the ROOT_FOLDER_OF property.
 
Methods inherited from interface javax.wvcm.ControllableResource
doAddLabel, doCheckin, doCheckout, doCreateResource, doCreateVersionControlledResource, doReadLabelledVersionProperties, doRemoveLabel, doSetLabel, doUncheckout, doVersionControl, getActivity, getAutoMergeList, getCheckedIn, getCheckedOut, getConfiguration, getIsCheckedOut, getIsVersionControllable, getIsVersionControlled, getMergeList, getPredecessorList, getReserved, getVersionHistory, getWorkspace, setActivity, setAutoMergeList, setMergeList, setPredecessorList, setReserved, 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
 
Methods inherited from interface javax.wvcm.Folder
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
 
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

IS_BASELINE_CONTROLLABLE

static final PropertyNameList.PropertyName<Boolean> IS_BASELINE_CONTROLLABLE
True if the folder can be put under baseline control with the doBaselineControl(javax.wvcm.Feedback) or doCreateBaselineControlledFolder(javax.wvcm.Baseline, javax.wvcm.Feedback) methods, otherwise false.


IS_BASELINE_CONTROLLED

static final PropertyNameList.PropertyName<Boolean> IS_BASELINE_CONTROLLED
True if the folder has been baseline controlled. False if the folder has not been baseline controlled or is a child of a folder that has been baseline controlled.

See Also:
getIsBaselineControlled()

ROOT_FOLDER_OF

static final PropertyNameList.PropertyName<Configuration> ROOT_FOLDER_OF
The configuration for which this is the root folder. The ROOT_FOLDER_OF property is the computed inverse of the Configuration.ROOT_FOLDER property.

See Also:
getRootFolderOf()
Method Detail

doBaselineControl

ControllableFolder doBaselineControl(Feedback feedback)
                                     throws WvcmException
Put this ControllableFolder under baseline control. If no ControllableFolder exists at this location, create one under baseline control.

A configuration resource is associated with this ControllableFolder, which allows versions of the configuration rooted at this ControllableFolder to be created by checking out and checking in the configuration resource.

A version of a configuration is called a "baseline".

Postconditions:

  • (create-configuration): A new configuration is created, whose Configuration.ROOT_FOLDER property identifies this ControllableFolder. The ControllableResource.WORKSPACE property of the new configuration is the same as the ControllableResource.WORKSPACE property of the controllable folder identified by this ControllableFolder.
  • (reference-configuration): The ControllableResource.CONFIGURATION property of the folder and all its members identifies the new configuration. The ROOT_FOLDER_OF property of the folder identifies the new configuration.
  • (create-new-baseline): The request MUST have created a new baseline history at a server-defined location, and MUST have created a new baseline in that baseline history. The Baseline.VERSION_LIST of the new baseline MUST identify a list of the ControllableResource.CHECKED_IN versions of each version-controlled member of the request folder. The ControllableResource.CHECKED_IN property of the new configuration MUST identify the new baseline. The ControllableResource.VERSION_HISTORY property of the new configuration MUST identify the new baseline history.

    Parameters:
    feedback - Specifies optional feedback to the caller.
    Returns:
    A new proxy for this resource, whose properties are specified by feedback.
    Throws:
    WvcmException - ReasonCode:
  • WvcmException.ReasonCode.CONTROLLED_CONFIGURATION_ALREADY_EXISTS If there already is a Configuration that identifies this ControllableFolder in its Configuration.ROOT_FOLDER property, the request MUST fail.
  • WvcmException.ReasonCode.NO_CHECKED_OUT_BASELINE_CONTROLLED_FOLDER_MEMBERS: All version-controlled members of this folder MUST be checked-in.
  • WvcmException.ReasonCode.FORBIDDEN: The folder must be baseline controllable.

  • doCreateBaselineControlledFolder

    ControllableFolder doCreateBaselineControlledFolder(Baseline baseline,
                                                        Feedback feedback)
                                                        throws WvcmException
    Create a baseline-controlled controllable folder at this location, and initialize it with the contents of the specified baseline. If the specified baseline must be restored at a specific location, the new baseline-controlled folder is created at that specific location instead of this ControllableFolder. The request will fail if a resource already exists at that location.

    Postconditions:

  • (create-configuration): A new baseline-controlled folder is created, and a new configuration is created whose Configuration.ROOT_FOLDER property identifies the new folder.
  • (reference-configuration): The ControllableResource.CONFIGURATION property of the folder and all its members identifies the new configuration. The ROOT_FOLDER_OF property of the folder identifies the new configuration.
  • (select-existing-baseline): The ControllableResource.CHECKED_IN property of the new configuration MUST have been set to identify the specified baseline. A version-controlled member of the folder will be created for each version in the baseline, where the version-controlled member will have the content of that version, and will have the same name relative to the folder as the corresponding version-controlled resource had when the baseline was created. Any nested folders that are needed to provide the appropriate name for a version-controlled member will be created.

    Parameters:
    baseline - the baseline used to initialize the folder.
    feedback - Specifies optional feedback to the caller.
    Returns:
    A proxy for this new resource, whose properties are specified by feedback.
    Throws:
    WvcmException - ReasonCode:
  • WvcmException.ReasonCode.CANNOT_CREATE_AT_THIS_LOCATION: The location for the new baseline-controlled folder MUST be a valid location for a baseline-controlled folder.
  • WvcmException.ReasonCode.RESOURCE_ALREADY_EXISTS_AT_LOCATION: The location for the new baseline-controlled folder MUST NOT identify an existing resource.
  • WvcmException.ReasonCode.BAD_ARGUMENT_TYPE: The baseline argument MUST identify a baseline.
  • WvcmException.ReasonCode.CANNOT_HAVE_MULTIPLE_BASELINE_CONTROLLED_FOLDERS: There MUST NOT be another folder in the workspace of this ControllableFolder whose configuration property identifies a configuration for the baseline history of that baseline.

  • getIsBaselineControllable

    boolean getIsBaselineControllable()
                                      throws WvcmException
    Get the IS_BASELINE_CONTROLLABLE property.

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

    getIsBaselineControlled

    boolean getIsBaselineControlled()
                                    throws WvcmException
    Get the IS_BASELINE_CONTROLLED property.

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

    getRootFolderOf

    Configuration getRootFolderOf()
                                  throws WvcmException
    Get the ROOT_FOLDER_OF property.

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

    Generated Thu 18-Feb-2010 12:40 PM

    Copyright © IBM 2010. All rights reserved.