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

Interface ISourceSet

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the source set.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildren() Returns the macro definition children.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildren(int sortingCriterion) Returns the macro definition children.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildren(java.lang.String sortingProperty) Returns the macro definition children.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildrenWithCategory(java.lang.String categoryID) Returns the macro definition children that belong to the specified category.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the macro definition children that belong to the specified category.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the macro definition children that belong to the specified category.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildrenWithDefaultCategory() Returns the macro definition children that belong to the default category.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildrenWithDefaultCategory(int sortingCriterion) Returns the macro definition children that belong to the default category.
java.util.List<? extends IMacroDefinition>	getMacroDefinitionChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the macro definition children that belong to the default category.
java.lang.String	getMacroDefinitionIDPrefix() Returns the id prefix for new macro definition child items.
java.lang.String	getName() Returns the name of the source set.
ISourceSet	getParentSourceSet() Returns the parent source set.
java.util.List<? extends IScript>	getScriptChildren() Returns the script children.
java.util.List<? extends IScript>	getScriptChildren(int sortingCriterion) Returns the script children.
java.util.List<? extends IScript>	getScriptChildren(java.lang.String sortingProperty) Returns the script children.
java.util.List<? extends IScript>	getScriptChildrenWithCategory(java.lang.String categoryID) Returns the script children that belong to the specified category.
java.util.List<? extends IScript>	getScriptChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the script children that belong to the specified category.
java.util.List<? extends IScript>	getScriptChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the script children that belong to the specified category.
java.util.List<? extends IScript>	getScriptChildrenWithDefaultCategory() Returns the script children that belong to the default category.
java.util.List<? extends IScript>	getScriptChildrenWithDefaultCategory(int sortingCriterion) Returns the script children that belong to the default category.
java.util.List<? extends IScript>	getScriptChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the script children that belong to the default category.
java.lang.String	getScriptIDPrefix() Returns the id prefix for new script child items.
java.util.List<? extends ISourceSet>	getSourceSetChildren() Returns the source set children.
java.util.List<? extends ISourceSet>	getSourceSetChildren(int sortingCriterion) Returns the source set children.
java.util.List<? extends ISourceSet>	getSourceSetChildren(java.lang.String sortingProperty) Returns the source set children.
java.util.List<? extends ISourceSet>	getSourceSetChildrenWithCategory(java.lang.String categoryID) Returns the source set children that belong to the specified category.
java.util.List<? extends ISourceSet>	getSourceSetChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the source set children that belong to the specified category.
java.util.List<? extends ISourceSet>	getSourceSetChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the source set children that belong to the specified category.
java.util.List<? extends ISourceSet>	getSourceSetChildrenWithDefaultCategory() Returns the source set children that belong to the default category.
java.util.List<? extends ISourceSet>	getSourceSetChildrenWithDefaultCategory(int sortingCriterion) Returns the source set children that belong to the default category.
java.util.List<? extends ISourceSet>	getSourceSetChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the source set children that belong to the default category.
boolean	hasMacroDefinitionChildren() Returns whether this source set has children of type macro definition.
boolean	hasScriptChildren() Returns whether this source set has children of type script.
boolean	hasSourceSetChildren() Returns whether this source set has children of type source set.
boolean	hasSourceSetParent() Returns whether this source set 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

getName

java.lang.String getName()

Returns the name of the source set.

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

Returns:

name of the source set (!= null)

getDescription

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

Returns the description of the source set.

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 source set (!= null)

getMacroDefinitionIDPrefix

java.lang.String getMacroDefinitionIDPrefix()

Returns the id prefix for new macro definition child items.

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

Returns:

the id prefix for new macro definition child items (!= null)

getScriptIDPrefix

java.lang.String getScriptIDPrefix()

Returns the id prefix for new script child items.

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

Returns:

the id prefix for new script child items (!= null)

hasSourceSetParent

boolean hasSourceSetParent()

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

Returns:

whether this source set has a parent of type source set

getParentSourceSet

ISourceSet getParentSourceSet()

Returns the parent source set.

Returns:

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

hasSourceSetChildren

boolean hasSourceSetChildren()

Returns whether this source set has children of type source set.

Returns:

whether this source set has children of type source set

getSourceSetChildren

java.util.List<? extends ISourceSet> getSourceSetChildren()

Returns the source set children.

The source set items are returned in their natural order.

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildren

java.util.List<? extends ISourceSet> getSourceSetChildren(int sortingCriterion)

Returns the source set children.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildren

java.util.List<? extends ISourceSet> getSourceSetChildren(java.lang.String sortingProperty)

Returns the source set children.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildrenWithCategory

java.util.List<? extends ISourceSet> getSourceSetChildrenWithCategory(java.lang.String categoryID)

Returns the source set children that belong to the specified category.

The source set items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildrenWithCategory

java.util.List<? extends ISourceSet> getSourceSetChildrenWithCategory(java.lang.String categoryID,
                                                                      int sortingCriterion)

Returns the source set children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildrenWithCategory

java.util.List<? extends ISourceSet> getSourceSetChildrenWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)

Returns the source set children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildrenWithDefaultCategory

java.util.List<? extends ISourceSet> getSourceSetChildrenWithDefaultCategory()

Returns the source set children that belong to the default category.

The source set items are returned in their natural order.

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildrenWithDefaultCategory

java.util.List<? extends ISourceSet> getSourceSetChildrenWithDefaultCategory(int sortingCriterion)

Returns the source set children that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of ISourceSet objects (!= null)

getSourceSetChildrenWithDefaultCategory

java.util.List<? extends ISourceSet> getSourceSetChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the source set children that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of ISourceSet objects (!= null)

hasMacroDefinitionChildren

boolean hasMacroDefinitionChildren()

Returns whether this source set has children of type macro definition.

Returns:

whether this source set has children of type macro definition

getMacroDefinitionChildren

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildren()

Returns the macro definition children.

The macro definition items are returned in their natural order.

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildren

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildren(int sortingCriterion)

Returns the macro definition children.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildren

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildren(java.lang.String sortingProperty)

Returns the macro definition children.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildrenWithCategory

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildrenWithCategory(java.lang.String categoryID)

Returns the macro definition children that belong to the specified category.

The macro definition items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildrenWithCategory

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildrenWithCategory(java.lang.String categoryID,
                                                                                  int sortingCriterion)

Returns the macro definition children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildrenWithCategory

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildrenWithCategory(java.lang.String categoryID,
                                                                                  java.lang.String sortingProperty)

Returns the macro definition children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildrenWithDefaultCategory

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildrenWithDefaultCategory()

Returns the macro definition children that belong to the default category.

The macro definition items are returned in their natural order.

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildrenWithDefaultCategory

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildrenWithDefaultCategory(int sortingCriterion)

Returns the macro definition children that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IMacroDefinition objects (!= null)

getMacroDefinitionChildrenWithDefaultCategory

java.util.List<? extends IMacroDefinition> getMacroDefinitionChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the macro definition children that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IMacroDefinition objects (!= null)

hasScriptChildren

boolean hasScriptChildren()

Returns whether this source set has children of type script.

Returns:

whether this source set has children of type script

getScriptChildren

java.util.List<? extends IScript> getScriptChildren()

Returns the script children.

The script items are returned in their natural order.

Returns:

list of IScript objects (!= null)

getScriptChildren

java.util.List<? extends IScript> getScriptChildren(int sortingCriterion)

Returns the script children.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IScript objects (!= null)

getScriptChildren

java.util.List<? extends IScript> getScriptChildren(java.lang.String sortingProperty)

Returns the script children.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IScript objects (!= null)

getScriptChildrenWithCategory

java.util.List<? extends IScript> getScriptChildrenWithCategory(java.lang.String categoryID)

Returns the script children that belong to the specified category.

The script items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IScript objects (!= null)

getScriptChildrenWithCategory

java.util.List<? extends IScript> getScriptChildrenWithCategory(java.lang.String categoryID,
                                                                int sortingCriterion)

Returns the script children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IScript objects (!= null)

getScriptChildrenWithCategory

java.util.List<? extends IScript> getScriptChildrenWithCategory(java.lang.String categoryID,
                                                                java.lang.String sortingProperty)

Returns the script children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IScript objects (!= null)

getScriptChildrenWithDefaultCategory

java.util.List<? extends IScript> getScriptChildrenWithDefaultCategory()

Returns the script children that belong to the default category.

The script items are returned in their natural order.

Returns:

list of IScript objects (!= null)

getScriptChildrenWithDefaultCategory

java.util.List<? extends IScript> getScriptChildrenWithDefaultCategory(int sortingCriterion)

Returns the script children that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IScript objects (!= null)

getScriptChildrenWithDefaultCategory

java.util.List<? extends IScript> getScriptChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the script children that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IScript objects (!= null)