Project: stp

javax.wvcm
Interface Configuration

All Superinterfaces:
ControllableResource, Resource

public interface Configuration
extends ControllableResource

A proxy for a configuration resource. A configuration resource is a controlled resource that is associated with a folder (called the "root folder") and that represents all controlled members of the root folder.

A configuration is associated with a baseline-controlled folder, and is used to create and access baselines of that folder.

When a folder is both version-controlled and baseline-controlled, a client can create a new version of the folder by checking out and checking in that folder, and it can create a new baseline of that folder by checking out and checking in the configuration of that folder.

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
 
Field Summary
static PropertyNameList.PropertyName<ControllableFolder> ROOT_FOLDER
          The root folder for this configuration.
 
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
 
Method Summary
 ControllableFolder getRootFolder()
          Get the ROOT_FOLDER 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
 

Field Detail

ROOT_FOLDER

static final PropertyNameList.PropertyName<ControllableFolder> ROOT_FOLDER
The root folder for this configuration. The ControllableFolder.ROOT_FOLDER_OF property of the root folder of a configuration MUST identify that configuration. The root ControllableResource.CONFIGURATION property of a member of the root folder of a configuration must all identify that configuration.

Method Detail

getRootFolder

ControllableFolder getRootFolder()
                                 throws WvcmException
Get the ROOT_FOLDER property.

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

Generated Sun 26-Oct-2008 10:17 AM

Copyright © IBM 2008. All rights reserved.