com.arcway.cockpit.genericmodule.reportdesignermodule.docgen.provider.interfaces

Interface IReportNote

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.docgen.provider.interfaces.IGraphic, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IReportNote
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

The IReportNote object allows to read attribute values of a report note as well as accessing child items and related items. Item type constant: "gm.reportdesignermodule.reportNote"

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNoteType() Returns the note-type of the report note.
IReport	getParentReport() Returns the parent report.
java.util.List<java.lang.String>	getText() Returns the text of the report note.
boolean	hasReportParent() Returns whether this report note has a parent of type report.

Methods inherited from interface com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

getAncestorObjects, getAttribute_asParagraphList, getAttribute_asSingleLine, getAttribute_asTimestamp_MilliSecondsSince_01_01_1970, getAttribute, getChildObjects, getChildObjects, getChildObjectsOfTypeRank, getChildObjectsWithCategory, getChildObjectsWithCategory, getChildObjectsWithDefaultCategory, getChildObjectsWithDefaultCategory, getChildrenIDPrefix, getLinkedModelElements, getObjectType, getParentObject, getRelatedLOObjects, getRelatedLOObjects, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedMDObjects, getRelatedMDObjects, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithDefaultCategory, getRelatedMDObjectsWithDefaultCategory, getUniqueIdentifier, isLinkedToAnyModelElement, toRecord

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic

getEMFFile, getImage, getPNGFile, getSVGFile, getWMFFile

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getNoteType

java.lang.String getNoteType()

Returns the note-type of the report note.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

note-type of the report note (!= null)

getText

java.util.List<java.lang.String> getText()

Returns the text of the report note.

If the text consists of multiple paragraphs (separated by carriage return) each paragraph is represented by a single element in the String list.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

text of the report note (!= null)

hasReportParent

boolean hasReportParent()

Returns whether this report note has a parent of type report.

Returns:

whether this report note has a parent of type report

getParentReport

IReport getParentReport()

Returns the parent report.

Returns:

the parent report (or null if this report note has no parent or a parent of a different type)