IBookmarkFolder

All Superinterfaces:

IHasChildrenBaseModelElement, IModelElement, IModelElementParent
```
public interface IBookmarkFolder
extends IHasChildrenBaseModelElement
```

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PROP_BOOKMARKS

static java.lang.String PROP_QUALITY_REASON

static java.lang.String PROP_QUALITY_SCORE
- Fields inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement
  PROP_BACKLOG_ACTIVITY_ID, PROP_COMMENTS, PROP_DOCUMENTATION, PROP_GENERIC_VALUES, PROP_PM_AUTHOR, PROP_PM_CREATE_DATE_TIME, PROP_PM_DIFFICULTY, PROP_PM_DISCIPLINE, PROP_PM_ITERATION, PROP_PM_LAST_MODIFIED, PROP_PM_PHASE, PROP_PM_PRIORITY, PROP_PM_STATUS, PROP_PM_VERSION, PROP_REFERENCED_BY_DIAGRAM_IDS, PROP_REFERENCED_BY_MODEL_ADDRESSES, PROP_REFERENCES, PROP_TRANSIT_FROM, PROP_TRANSIT_TO, PROP_USER_ID, PROP_USER_ID_LAST_NUMERIC_VALUE, PROP_USER_ID_PARENT, PROP_VOICES
- Fields inherited from interface com.vp.plugin.model.IModelElement
  MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_NAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_BOOKMARKS`
`static java.lang.String`	`PROP_QUALITY_REASON`
`static java.lang.String`	`PROP_QUALITY_SCORE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBookmark(IBookmark bookmark)`
`void`	`addBookmarkFolder(IBookmarkFolder child)`
`int`	`bookmarkCount()`
`int`	`bookmarkFolderCount()`
`java.util.Iterator`	`bookmarkFolderIterator()`
`java.util.Iterator`	`bookmarkIterator()` Returns an iterator over the model elements `IBookmark`.
`IBookmarkFolder`	`createBookmarkFolder()`
`IBookmark`	`getBookmarkByIndex(int index)`
`IBookmarkFolder`	`getBookmarkFolderByIndex(int index)`
`IBookmarkFolder`	`getBookmarkFolderByName(java.lang.String name)`
`java.lang.String`	`getQualityReason()` Quality reason, it is non-readable value for human
`int`	`getQualityScore()` Quality score, it is non-readable value for human
`void`	`removeBookmark(IBookmark bookmark)`
`void`	`removeBookmarkByIndex(int index)`
`void`	`removeBookmarkFolder(IBookmarkFolder child)`
`void`	`removeBookmarkFolderByIndex(int index)`
`void`	`reorderBookmarkFolder(IBookmarkFolder[] childs)`
`void`	`setQualityReason(java.lang.String qualityReason)`
`void`	`setQualityScore(int qualityScore)`
`IBookmark[]`	`toBookmarkArray()`
`IBookmarkFolder[]`	`toBookmarkFolderArray()`

Methods inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement
addComment, addGenericValue, addReference, addVoice, commentCount, commentIterator, genericValueCount, genericValueIterator, getBacklogActivityId, getCommentByIndex, getDescription, getGenericValueByIndex, getHTMLDescription, getHTMLDescription, getPmAuthor, getPmCreateDateTime, getPmDifficulty, getPmDiscipline, getPmIteration, getPmLastModified, getPmPhase, getPmPriority, getPmStatus, getPmVersion, getReferenceByIndex, getReferencedByDiagramIds, getReferencedByModelAddresses, getTransitFrom, getTransitTo, getUserID, getUserIDLastNumericValue, getUserIDParent, getVoiceByIndex, referenceCount, referenceIterator, removeComment, removeCommentByIndex, removeGenericValue, removeGenericValueByIndex, removeReference, removeReferenceByIndex, removeVoice, removeVoiceByIndex, setBacklogActivityId, setDescription, setHTMLDescription, setPmAuthor, setPmCreateDateTime, setPmDifficulty, setPmDiscipline, setPmIteration, setPmLastModified, setPmPhase, setPmPriority, setPmStatus, setPmVersion, setReferencedByDiagramIds, setReferencedByModelAddresses, setTransitFrom, setTransitTo, setUserID, setUserIDLastNumericValue, setUserIDParent, toCommentArray, toGenericValueArray, toReferenceArray, toVoiceArray, voiceCount, voiceIterator

Methods inherited from interface com.vp.plugin.model.IModelElement
addChild, addPropertyChangeListener, addStereotype, addStereotype, addSubDiagram, canModify, childCount, childCount, childCount, childIterator, childIterator, childIterator, constraintsIterator, createChild, delete, disposeTransientModel, duplicate, fromChartRelationshipCount, fromChartRelationshipIterator, fromRelationshipCount, fromRelationshipEndCount, fromRelationshipEndIterator, fromRelationshipIterator, getAddress, getChildById, getChildByIndex, getChildByIndex, getChildByName, getChildByName, getDescriptionWithReferenceModels, getDiagramElements, getDisplayQualityScore, getDocumentation, getDocumentationWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDocumentation, getHTMLDocumentation, getHTMLDocumentationWithReferenceModels, getHTMLDocumentationWithReferenceModels, getId, getMasterView, getMirrorSource, getModelPropertyByName, getModelQualityDetails, getModelType, getName, getNickDescription, getNickDescriptionWithReferenceModels, getNickDocumentation, getNickDocumentationWithReferenceModels, getNickHTMLDescription, getNickHTMLDescription, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDocumentation, getNickHTMLDocumentation, getNickHTMLDocumentationWithReferenceModels, getNickHTMLDocumentationWithReferenceModels, getNickname, getNickPropertyValue, getParent, getProject, getReferencedBys, getReferencingModels, getSubDiagramAt, getTaggedValues, hasStereotype, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeStereotype, removeStereotype, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, setTaggedValues, stereotypeCount, stereotypeModelIterator, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toFromRelationshipArray, toFromRelationshipEndArray, toModelPropertyArray, toPropertiesString, toRelationshipCount, toRelationshipEndCount, toRelationshipEndIterator, toRelationshipIterator, toStereotypeModelArray, toSubDiagramArray, toToChartRelationshipArray, toToRelationshipArray, toToRelationshipEndArray

Field Detail
- PROP_QUALITY_SCORE
```
static final java.lang.String PROP_QUALITY_SCORE
```
  See Also:
  
  Constant Field Values
- PROP_QUALITY_REASON
```
static final java.lang.String PROP_QUALITY_REASON
```
  See Also:
  
  Constant Field Values
- PROP_BOOKMARKS
```
static final java.lang.String PROP_BOOKMARKS
```
  See Also:
  
  Constant Field Values

Method Detail

addBookmarkFolder

void addBookmarkFolder(IBookmarkFolder child)

removeBookmarkFolder

void removeBookmarkFolder(IBookmarkFolder child)

getBookmarkFolderByIndex

IBookmarkFolder getBookmarkFolderByIndex(int index)

removeBookmarkFolderByIndex

void removeBookmarkFolderByIndex(int index)

reorderBookmarkFolder

void reorderBookmarkFolder(IBookmarkFolder[] childs)

bookmarkFolderCount
```
int bookmarkFolderCount()
```

bookmarkFolderIterator

java.util.Iterator bookmarkFolderIterator()

toBookmarkFolderArray

IBookmarkFolder[] toBookmarkFolderArray()

createBookmarkFolder
```
IBookmarkFolder createBookmarkFolder()
```

getBookmarkFolderByName

IBookmarkFolder getBookmarkFolderByName(java.lang.String name)

setQualityScore

void setQualityScore(int qualityScore)

getQualityScore
```
int getQualityScore()
```
Description copied from interface: IModelElement

Quality score, it is non-readable value for human

Specified by:

getQualityScore in interface IModelElement

setQualityReason

void setQualityReason(java.lang.String qualityReason)

getQualityReason
```
java.lang.String getQualityReason()
```
Description copied from interface: IModelElement

Quality reason, it is non-readable value for human

Specified by:

getQualityReason in interface IModelElement

addBookmark
```
void addBookmark(IBookmark bookmark)
```

removeBookmark

void removeBookmark(IBookmark bookmark)

getBookmarkByIndex

IBookmark getBookmarkByIndex(int index)

removeBookmarkByIndex
```
void removeBookmarkByIndex(int index)
```

bookmarkCount
```
int bookmarkCount()
```

bookmarkIterator
```
java.util.Iterator bookmarkIterator()
```
Returns an iterator over the model elements IBookmark.

toBookmarkArray
```
IBookmark[] toBookmarkArray()
```

Interface IBookmarkFolder

Field Summary

Fields inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement

Fields inherited from interface com.vp.plugin.model.IModelElement

Method Summary

Methods inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement

Methods inherited from interface com.vp.plugin.model.IModelElement

Field Detail

PROP_QUALITY_SCORE

PROP_QUALITY_REASON

PROP_BOOKMARKS

Method Detail

addBookmarkFolder

removeBookmarkFolder

getBookmarkFolderByIndex

removeBookmarkFolderByIndex

reorderBookmarkFolder

bookmarkFolderCount

bookmarkFolderIterator

toBookmarkFolderArray

createBookmarkFolder

getBookmarkFolderByName

setQualityScore

getQualityScore

setQualityReason

getQualityReason

addBookmark

removeBookmark

getBookmarkByIndex

removeBookmarkByIndex

bookmarkCount

bookmarkIterator

toBookmarkArray