org.ucworkbench.model
Interface IFolderElement

All Superinterfaces:
IUCElement
All Known Subinterfaces:
IRequirementsFolder, IScreenFolder, ITemplate, ITestsFolder

public interface IFolderElement
extends IUCElement

This is a general interface for all folder elements (e.g.


Method Summary
 boolean contains(IResource resource)
          Returns true if a resource given as the parameter is a child of this folder.
 IFile getFile(java.lang.String relativePath)
          Returns a file relative to the current folder.
 IModelFileElement getFileByID(java.lang.String relativePathAndID)
          Returns a file from its ID and relative path
 IPath getFolderRelativePath(IFile file)
          Returns path of the file relative to this folder.
 IFolder getIFolder()
          Returns IFolder corresponding to IFolderElement.
 java.util.Collection<IUCElement> getSubElementsByType(org.ucworkbench.model.UCElementType type)
          Returns a collection of all childs (not only direct childs) of current folder of the given type.
 IFolderElement getSubFolderElement(java.lang.String relativePath)
          Returns folder element relative to the current folder element.
 
Methods inherited from interface org.ucworkbench.model.IUCElement
accept, childrenAccept, exists, getAncestor, getChildren, getCorrespondingResource, getElementName, getElementType, getParent, getPath, getUCProject, getUnderlyingResource
 

Method Detail

getIFolder

IFolder getIFolder()
Returns IFolder corresponding to IFolderElement.

Returns:

getSubFolderElement

IFolderElement getSubFolderElement(java.lang.String relativePath)
Returns folder element relative to the current folder element. E.g. current folder element corresponds to path /Requirements, getSubFolderElement("/module1") returns folder element for /Requirements/module1

Returns:

getFileByID

IModelFileElement getFileByID(java.lang.String relativePathAndID)
Returns a file from its ID and relative path

Returns:

getSubElementsByType

java.util.Collection<IUCElement> getSubElementsByType(org.ucworkbench.model.UCElementType type)
Returns a collection of all childs (not only direct childs) of current folder of the given type.

Parameters:
type -
Returns:

getFile

IFile getFile(java.lang.String relativePath)
Returns a file relative to the current folder.

Parameters:
relativePath -
Returns:

contains

boolean contains(IResource resource)
Returns true if a resource given as the parameter is a child of this folder.

Parameters:
resource -
Returns:

getFolderRelativePath

IPath getFolderRelativePath(IFile file)
Returns path of the file relative to this folder.

Parameters:
file -
Returns: