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

Interface IScript

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 IScript
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the script.
java.lang.String	getID() Returns the id of the script.
java.lang.String	getIDandTitle() Returns the id and title of the script.
ISourceSet	getParentSourceSet() Returns the parent source set.
java.lang.String	getTitle() Returns the title of the script.
boolean	hasSourceSetParent() Returns whether this script has a parent of type source set.

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

getID

java.lang.String getID()

Returns the id of the script.

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

Returns:

id of the script (!= null)

getTitle

java.lang.String getTitle()

Returns the title of the script.

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

Returns:

title of the script (!= null)

getDescription

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

Returns the description of the script.

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:

description of the script (!= null)

getIDandTitle

java.lang.String getIDandTitle()

Returns the id and title of the script.

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

Returns:

id and title of the script (!= null)

hasSourceSetParent

boolean hasSourceSetParent()

Returns whether this script has a parent of type source set.

Returns:

whether this script has a parent of type source set

getParentSourceSet

ISourceSet getParentSourceSet()

Returns the parent source set.

Returns:

the parent source set (or null if this script has no parent or a parent of a different type)