ICockpitData

All Known Subinterfaces:

ICustomPropertiesAccess, IFolder, IGraphic, IModelElement, IPlan, IProject, IStakeholder, IStakeholderRole
```
public interface ICockpitData
```
ICockpitData is the base interface for all Cockpit data objects. It contains the functions that are supported by all Cockpit data objects.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCommitVersion()` Returns the version ID of the commit when the object has been changed teh last time.
`java.lang.Long`	`getCreationDate_MilliSecondsSince_01_01_1970()` Returns the date of the creation date in milli senconds since 01/01/1970.
`java.lang.String`	`getCreationDate()` Returns the creation date.
`java.lang.String`	`getCreator()` Returns the creator's name.
`java.lang.Long`	`getDateOfLastModification_MilliSecondsSince_01_01_1970()` Returns the date of the last modification in milli senconds since 01/01/1970.
`java.lang.String`	`getDateOfLastModification()` Returns the date of the last modification.
`java.lang.String`	`getDisplayName()` Returns the display name of the item, i.e. a label representing the item.
`java.lang.String`	`getLastModifier()` Returns the last modifier's name.
`java.lang.String`	`getLinkForShow()` Creates a link to show an object in ARCWAY COCKPIT.
`java.lang.String`	`getModificationCount()` Returns the modification count (i.e. the number of times the item has been changed so far).
`java.lang.String`	`getProjectUniqueIdentifier()` Returns a unique identifier that uniquely identifies the COCKPIT project that contains this object.
`java.lang.String`	`getTypeID()` Returns the id of the data type of the item.
`java.lang.String`	`getTypeName()` Returns the name of the data type of the item.
`java.lang.String`	`getUniqueIdentifier()` Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
`IRecord`	`toRecord()` Converts this cockpit project data into a record.
`IRecord`	`toRecord(java.util.Set<java.lang.String> keyWhiteList)` Like `toRecord()` while only properties are filled into the record of which the keys are contained in keyWhiteList.

- Method Detail
  - getUniqueIdentifier
```
java.lang.String getUniqueIdentifier()
```
    Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
    
    Example from report template:
    
    #set($plan_uid = ${plan.getUniqueIdentifier()})
    
    Returns:
    
    unique identifier
  - getProjectUniqueIdentifier
```
java.lang.String getProjectUniqueIdentifier()
```
    Returns a unique identifier that uniquely identifies the COCKPIT project that contains this object.
    
    Example from report template:
    
    #set($project_uid_of_plan = ${plan.getProjectUniqueIdentifier()})
    
    Returns:
    
    unique identifier
  - getDisplayName
```
java.lang.String getDisplayName()
```
    Returns the display name of the item, i.e. a label representing the item.
    
    Returns:
    
    the display name
  - getTypeName
```
java.lang.String getTypeName()
```
    Returns the name of the data type of the item.
    
    Returns:
    
    the type name
  - getTypeID
```
java.lang.String getTypeID()
```
    Returns the id of the data type of the item.
    
    Returns:
    
    the type id
  - getCommitVersion
```
java.lang.String getCommitVersion()
```
    Returns the version ID of the commit when the object has been changed teh last time.
    
    Returns:
    
    Commit Version ID
  - getDateOfLastModification
```
java.lang.String getDateOfLastModification()
```
    Returns the date of the last modification.
    
    Returns:
    
    HTML encoded reprensentaion of the date of the last modification (!= null)
  - getDateOfLastModification_MilliSecondsSince_01_01_1970
```
java.lang.Long getDateOfLastModification_MilliSecondsSince_01_01_1970()
```
    Returns the date of the last modification in milli senconds since 01/01/1970.
    
    Returns:
    
    date of the last modification in milli secnonds since 01/01/1970 (!= null)
  - getLastModifier
```
java.lang.String getLastModifier()
```
    Returns the last modifier's name.
    
    Returns:
    
    HTML encoded reprensentaion of the last modifier's name (!= null)
  - getCreationDate
```
java.lang.String getCreationDate()
```
    Returns the creation date.
    
    Returns:
    
    HTML encoded reprensentaion of the creation date (!= null)
  - getCreationDate_MilliSecondsSince_01_01_1970
```
java.lang.Long getCreationDate_MilliSecondsSince_01_01_1970()
```
    Returns the date of the creation date in milli senconds since 01/01/1970.
    
    Returns:
    
    date of the creation date in milli secnonds since 01/01/1970 (!= null)
  - getCreator
```
java.lang.String getCreator()
```
    Returns the creator's name.
    
    Returns:
    
    HTML encoded reprensentaion of the creator's name (!= null)
  - getModificationCount
```
java.lang.String getModificationCount()
```
    Returns the modification count (i.e. the number of times the item has been changed so far).
    
    Precondition: Will only return values different from 0 in the client-server-version.
    
    Returns:
    
    the modification count (!= null)
  - getLinkForShow
```
java.lang.String getLinkForShow()
```
    Creates a link to show an object in ARCWAY COCKPIT.
    What "to show" means, may depend on the concrete object type.
    plan: will be openend/topped
    unique element: will be highlightet in the first plan where this element is *not* (!) refined (if there is no such plan, open some plan with this element)
    all objects: the details view should show this object
    This link may not be supported by all output types.
    
    Returns:
    
    the created link (HTML encoded, never null)
  - toRecord
```
IRecord toRecord()
```
    Converts this cockpit project data into a record.
    In the created record, the following fields are filled accoring to the wrapped cockpit data:
    Concrete types may fill in further fields (see there).
    Returns:
    
    converted cockpit project data
  - toRecord
```
IRecord toRecord(java.util.Set<java.lang.String> keyWhiteList)
```
    Like toRecord() while only properties are filled into the record of which the keys are contained in keyWhiteList.
    
    Parameters:
    
    keyWhiteList - key white list (empty to include no property, null to include all properities)
    
    Returns:
    
    converted cockpit project data

Interface ICockpitData

Method Summary

Method Detail

getUniqueIdentifier

getProjectUniqueIdentifier

getDisplayName

getTypeName

getTypeID

getCommitVersion

getDateOfLastModification

getDateOfLastModification_MilliSecondsSince_01_01_1970

getLastModifier

getCreationDate

getCreationDate_MilliSecondsSince_01_01_1970

getCreator

getModificationCount

getLinkForShow

toRecord

toRecord