Project: stp

com.ibm.rational.wvcm.stp.cc
Interface CcProjectFolder

All Superinterfaces:
CcResource, CcVobResource, Resource, StpResource

public interface CcProjectFolder
extends CcVobResource

A proxy for a ClearCase UCM project folder.

Project folders are used to organize the projects in a project VOB. A project folder may contain both UCM projects and project subfolders.

A project VOB has one distinguished root folder.

For more project folder information, see the ClearCase "Guide to Developing Software with UCM" manual, and the cleartool man page "mkfolder".


Nested Class Summary
 
Nested classes/interfaces inherited from interface CcVobResource
CcVobResource.ApplyAttributeFlag
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource
StpResource.UnsupportedProperty
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<Boolean> IS_ROOT
          Is this the root folder of its project VOB?
static PropertyNameList.PropertyName<CcProjectFolder> PARENT_FOLDER
          This folder's parent folder.
static PropertyNameList.PropertyName<ResourceList<CcProject>> PROJECT_LIST
          This folder's projects.
static PropertyNameList.PropertyName<ResourceList<CcProjectFolder>> SUBFOLDER_LIST
          This folder's subfolders.
 
Fields inherited from interface CcVobResource
ATTRIBUTE_LIST, CC_MASTER_REPLICA, CURRENT_REPLICA, HAS_LOCAL_MASTERSHIP, HYPERLINK_LIST, LOCK_INFO, PERMISSIONS, VOB
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
 
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
 CcProjectFolder doCreateCcProjectFolder(Feedback feedback)
           Create a new UCM project folder at the location specified by this proxy.
 boolean getIsRoot()
          Get the value of this proxy's IS_ROOT property.
 CcProjectFolder getParentFolder()
          Get the value of this proxy's PARENT_FOLDER property.
 ResourceList<CcProject> getProjectList()
          Get the value of this proxy's PROJECT_LIST property.
 ResourceList<CcProjectFolder> getSubfolderList()
          Get the value of this proxy's SUBFOLDER_LISTproperty.
 void setParentFolder(CcProjectFolder parentFolder)
          Set the value of this proxy's PARENT_FOLDER property.
 
Methods inherited from interface CcVobResource
doApplyAttribute, doRemoveAttribute, doRequestForMastership, getAttributeList, getCurrentReplica, getHasLocalMastership, getHyperlinkList, getLockInfo, getMasterReplica, getPermissions, getVob, setLockInfo, setPermissions
 
Methods inherited from interface CcResource
ccProvider, doResolve, hasSupportedProperties, isResolved
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCreatorGroupName, getCreatorLoginName, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
 
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, getWorkspaceFolderList, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setIsExecutable, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

IS_ROOT

static final PropertyNameList.PropertyName<Boolean> IS_ROOT
Is this the root folder of its project VOB?


PARENT_FOLDER

static final PropertyNameList.PropertyName<CcProjectFolder> PARENT_FOLDER
This folder's parent folder. Will be null if this is the root folder.


PROJECT_LIST

static final PropertyNameList.PropertyName<ResourceList<CcProject>> PROJECT_LIST
This folder's projects.


SUBFOLDER_LIST

static final PropertyNameList.PropertyName<ResourceList<CcProjectFolder>> SUBFOLDER_LIST
This folder's subfolders.

Method Detail

doCreateCcProjectFolder

CcProjectFolder doCreateCcProjectFolder(Feedback feedback)
                                        throws WvcmException

Create a new UCM project folder at the location specified by this proxy. The location should be an object name selector specifying the folder's name and the repository (project VOB) in which to create it.

Must specify the new project folder's parent folder by setting the folder's PARENT_FOLDER property.

Throws:
WvcmException

getIsRoot

boolean getIsRoot()
                  throws WvcmException
Get the value of this proxy's IS_ROOT property.

Returns:
true if this is the root project folder, else false.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getParentFolder

CcProjectFolder getParentFolder()
                                throws WvcmException
Get the value of this proxy's PARENT_FOLDER property.

Returns:
a client proxy for this folder's parent, or null if this is the root folder
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getProjectList

ResourceList<CcProject> getProjectList()
                                       throws WvcmException
Get the value of this proxy's PROJECT_LIST property.

Returns:
a list of client proxies for this folder's projects
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getSubfolderList

ResourceList<CcProjectFolder> getSubfolderList()
                                               throws WvcmException
Get the value of this proxy's SUBFOLDER_LISTproperty.

Returns:
a list of client proxies for this folder's subfolders
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setParentFolder

void setParentFolder(CcProjectFolder parentFolder)
Set the value of this proxy's PARENT_FOLDER property.

Parameters:
parentFolder - this folder's new parent folder; cannot be null.

Generated Tue 24-Jan-2012 10:05 AM

Copyright © IBM 2012. All rights reserved.