public class ReaderScope extends Object
The reading of each DOORS item (module, folder or project) can be configured here to
Below is a snippet illustrating the various configurations:
ReaderScope scope = new ReaderScope(); // request to read all data of a module scope.getItemScope("/MyFolder/MyModule").setMode(ItemScopeMode.COMPLETE); // request to exclude a folder scope.getItemScope("/MyFolder/FolderToExclude").setMode(ItemScopeMode.EXCLUDE); // when this module is read on-demand, load the specified baseline and not the current state of the module scope.getItemScope("/MyFolder/SecondModule").setBaseline(new BaselineDescriptor(3, 2)); Map<String, Object> options = new HashMap<String, Object>(); options.put(Common.OPTION_SCOPE, scope); myModel.read("Application", "", options).
This class is not intended to be subclassed by clients but may be instantiated.
Common.OPTION_SCOPE
,
DoorsReader
Constructor and Description |
---|
ReaderScope() |
Modifier and Type | Method and Description |
---|---|
ItemScope |
getItemScope(String itemId)
Returns a scope descriptor for the specified item.
|
Collection<ItemScope> |
getItemScopes()
Returns the collection of configured items.
|
public Collection<ItemScope> getItemScopes()
public ItemScope getItemScope(String itemId)
itemId
- the identifier of an item, which can either be its full path,
its DOORS unique ID or its DOORS URL.