ItemRef

java.lang.Object
- com.sodius.mdw.metamodel.doors.io.commands.ItemRef

```
public abstract class ItemRef
extends Object
```
References to a DOORS item, which is either a module, a folder or a project.
Creating a reference instance does not execute anything on the DOORS client, it is just a way to get a pointer to an element on which commands are executed. The reference is only resolved to the actual element by the time the command is executed and may result in an element not being found.

Note that both FolderRef and ModuleRef instances can be converted to an ItemRef instance of using the toItem() method.

Below is a snippet illustrating how to use an item reference (see CommandRunner for a full snippet):
```
 ItemRef item = ItemRef.qualifiedName("/MyFolder/MyModule");
 DeleteItemCommand command = new DeleteItemCommand(item);
 myCommandRunner.run(command);
 
```
Since:

3.4.0

See Also:

CommandRunner, DeleteItemCommand, PurgeItemCommand, FolderRef.toItem(), ModuleRef.toItem()

Constructor Summary

Constructors
Constructor and Description

ItemRef()

Constructors
Constructor and Description
`ItemRef()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static ItemRef`	`defaultLinkModule(ItemRef sourceModule, ItemRef targetModule)` Returns a reference to the item which is the default link module of the specified source and target module pair.
`static ItemRef`	`name(FolderRef folder, String name)` Returns a reference to an item based on its parent folder and its name.
`static ItemRef`	`qualifiedName(String qualifiedName)` Returns a reference to an item based on its qualified name.
`abstract FolderRef`	`toFolder()` Converts this item reference to a folder reference.
`abstract ModuleRef`	`toModule()` Converts this item reference to a module reference.
`static ItemRef`	`uniqueID(String uniqueID)` Returns a reference to an item based on its DOORS unique ID.
`static ItemRef`	`url(String url)` Returns a reference to an item based on its DOORS URL.

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

- Constructor Detail
  - ItemRef
```
public ItemRef()
```
- Method Detail
  - qualifiedName
```
public static ItemRef qualifiedName(String qualifiedName)
```
    Returns a reference to an item based on its qualified name.
    Note that in case the item is actually a DOORS project, its qualified name is the name of the project prefixed by a '/' character (e.g. "/MyProject").
    
    Parameters:
    
    qualifiedName - the qualified name of the item.
    
    Returns:
    
    a reference to an item.
  - name
```
public static ItemRef name(FolderRef folder,
                           String name)
```
    Returns a reference to an item based on its parent folder and its name.
    
    Parameters:
    
    folder - a reference to the containing folder.
    
    name - the name of the item.
    
    Returns:
    
    a reference to an item.
    
    Since:
    
    3.5.0
  - url
```
public static ItemRef url(String url)
```
    Returns a reference to an item based on its DOORS URL.
    
    Parameters:
    
    url - the DOORS URL of the item.
    
    Returns:
    
    a reference to an item.
    
    Since:
    
    3.5.0
  - uniqueID
```
public static ItemRef uniqueID(String uniqueID)
```
    Returns a reference to an item based on its DOORS unique ID.
    
    Parameters:
    
    uniqueID - the DOORS unique ID of the item.
    
    Returns:
    
    a reference to an item.
    
    Since:
    
    3.5.0
  - defaultLinkModule
```
public static ItemRef defaultLinkModule(ItemRef sourceModule,
                                        ItemRef targetModule)
```
    Returns a reference to the item which is the default link module of the specified source and target module pair. The default link module is configurable in the DOORS client.
    
    Parameters:
    
    sourceModule - the source module
    
    targetModule - the target module
    
    Returns:
    
    a reference to the default module for the specified module pair.
    
    Since:
    
    3.6.0
  - toModule
```
public abstract ModuleRef toModule()
```
    Converts this item reference to a module reference.
    
    Returns:
    
    a module reference to this item.
    
    Since:
    
    3.5.0
  - toFolder
```
public abstract FolderRef toFolder()
```
    Converts this item reference to a folder reference.
    
    Returns:
    
    a folder reference to this item.
    
    Since:
    
    3.5.0

Class ItemRef

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ItemRef

Method Detail

qualifiedName

name

url

uniqueID

defaultLinkModule

toModule

toFolder