ItemScope

java.lang.Object
- com.sodius.mdw.metamodel.doors.connectors.dxl.ItemScope

```
public final class ItemScope
extends Object
```
Describes the strategy to read an item (either a module, a folder or a project).
An instance of ItemScope is obtained using ReaderScope.getItemScope(String) on a specific item.

This descriptor can be used to:
- Exclude an item, as if it just did not exist in the DOORS database.
- Force to read all item content completely at once. For example if absolutely all data of a module should be read in a certain use case, configure to read it completely at once can improve performance.
- Request to read a baseline of a module rather than the current state.
- Request to use a specific view when reading a module content rather than the default view.
- Request to use additional filtering criteria when reading visible objects in the module current view.
Below is a snippet illustrating the various configurations:
```
 ReaderScope scope = new ReaderScope();

 // request to read all data of a module at once
 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));

 // use "myView" when reading this module
 scope.getItemScope("/MyFolder/ThirdModule").setViewName("myView");

 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. Use ReaderScope.getItemScope(String) to get an instance
See Also:

ReaderScope.getItemScope(String), DoorsReader

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BaselineDescriptor`	`getBaseline()` Returns the baseline descriptor, if any.
`Filter`	`getFilter()` Returns the filter associated with this module, if any.
`String`	`getId()` Returns the identifier of the item, which can either be its full path, its DOORS unique ID or its DOORS URL.
`ItemScopeMode`	`getMode()` Returns the mode used to read the item data.
`String`	`getViewName()` Returns the name of the view which must be used when reading a module content, if any.
`void`	`setBaseline(BaselineDescriptor baseline)` Changes the baseline descriptor.
`void`	`setFilter(Filter filter)` Assigns a new dynamic filter to this formal module.
`void`	`setMode(ItemScopeMode mode)` Changes the mode used to read the item data.
`void`	`setViewName(String viewName)` Changes the view which must be used when reading a module content.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getId
```
public String getId()
```
    Returns the identifier of the item, which can either be its full path, its DOORS unique ID or its DOORS URL.
    
    Returns:
    
    the identifier of the item.
  - getMode
```
public ItemScopeMode getMode()
```
    Returns the mode used to read the item data. Default value is ItemScopeMode.ONDEMAND.
    
    Returns:
    
    the mode used to read the item data.
  - setMode
```
public void setMode(ItemScopeMode mode)
```
    Changes the mode used to read the item data.
    
    Parameters:
    
    mode - the new mode.
  - getViewName
```
public String getViewName()
```
    Returns the name of the view which must be used when reading a module content, if any.
    
    Returns:
    
    the name of the view which must be used when reading a module content, or null if not set.
    
    Since:
    
    3.5.0
  - setViewName
```
public void setViewName(String viewName)
```
    Changes the view which must be used when reading a module content.
    Important note: a specific view cannot be used when reading a baseline.
    
    Parameters:
    
    viewName - the name of the view which must be used when reading a module content (can also be "" or "Standard view").
    
    Since:
    
    3.5.0
  - getBaseline
```
public BaselineDescriptor getBaseline()
```
    Returns the baseline descriptor, if any.
    
    Returns:
    
    the baseline descriptor, or null if not set.
  - setBaseline
```
public void setBaseline(BaselineDescriptor baseline)
```
    Changes the baseline descriptor.
    Important note: a specific view cannot be used when reading a baseline.
    
    Parameters:
    
    baseline - the new descriptor.
  - getFilter
```
public Filter getFilter()
```
    Returns the filter associated with this module, if any. A Filter instance introduces additional filtering on top on the one provided by the current view.
    
    Returns:
    
    the filter associated with this module, null if none.
    
    Since:
    
    3.7.0
    
    See Also:
    
    setFilter(Filter)
  - setFilter
```
public void setFilter(Filter filter)
```
    Assigns a new dynamic filter to this formal module. A Filter instance introduces additional filtering on top on the one provided by the current view.
    
    Parameters:
    
    filter - the new dynamic filter assigned to this module.
    
    Since:
    
    3.7.0

Class ItemScope

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

getMode

setMode

getViewName

setViewName

getBaseline

setBaseline

getFilter

setFilter