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

Interface IReportSet

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the report set.
java.lang.String	getName() Returns the name of the report set.
IReportSet	getParentReportSet() Returns the parent report set.
java.util.List<? extends IReport>	getReportChildren() Returns the report children.
java.util.List<? extends IReport>	getReportChildren(int sortingCriterion) Returns the report children.
java.util.List<? extends IReport>	getReportChildren(java.lang.String sortingProperty) Returns the report children.
java.util.List<? extends IReport>	getReportChildrenWithCategory(java.lang.String categoryID) Returns the report children that belong to the specified category.
java.util.List<? extends IReport>	getReportChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the report children that belong to the specified category.
java.util.List<? extends IReport>	getReportChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the report children that belong to the specified category.
java.util.List<? extends IReport>	getReportChildrenWithDefaultCategory() Returns the report children that belong to the default category.
java.util.List<? extends IReport>	getReportChildrenWithDefaultCategory(int sortingCriterion) Returns the report children that belong to the default category.
java.util.List<? extends IReport>	getReportChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the report children that belong to the default category.
java.lang.String	getReportIDPrefix() Returns the id prefix for new report child items.
java.util.List<? extends IReportSet>	getReportSetChildren() Returns the report set children.
java.util.List<? extends IReportSet>	getReportSetChildren(int sortingCriterion) Returns the report set children.
java.util.List<? extends IReportSet>	getReportSetChildren(java.lang.String sortingProperty) Returns the report set children.
java.util.List<? extends IReportSet>	getReportSetChildrenWithCategory(java.lang.String categoryID) Returns the report set children that belong to the specified category.
java.util.List<? extends IReportSet>	getReportSetChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the report set children that belong to the specified category.
java.util.List<? extends IReportSet>	getReportSetChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the report set children that belong to the specified category.
java.util.List<? extends IReportSet>	getReportSetChildrenWithDefaultCategory() Returns the report set children that belong to the default category.
java.util.List<? extends IReportSet>	getReportSetChildrenWithDefaultCategory(int sortingCriterion) Returns the report set children that belong to the default category.
java.util.List<? extends IReportSet>	getReportSetChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the report set children that belong to the default category.
boolean	hasReportChildren() Returns whether this report set has children of type report.
boolean	hasReportSetChildren() Returns whether this report set has children of type report set.
boolean	hasReportSetParent() Returns whether this report set has a parent of type report 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 report 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 report set (!= null)

getDescription

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

Returns the description of the report 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 report set (!= null)

getReportIDPrefix

java.lang.String getReportIDPrefix()

Returns the id prefix for new report 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 report child items (!= null)

hasReportSetParent

boolean hasReportSetParent()

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

Returns:

whether this report set has a parent of type report set

getParentReportSet

IReportSet getParentReportSet()

Returns the parent report set.

Returns:

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

hasReportSetChildren

boolean hasReportSetChildren()

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

Returns:

whether this report set has children of type report set

getReportSetChildren

java.util.List<? extends IReportSet> getReportSetChildren()

Returns the report set children.

The report set items are returned in their natural order.

Returns:

list of IReportSet objects (!= null)

getReportSetChildren

java.util.List<? extends IReportSet> getReportSetChildren(int sortingCriterion)

Returns the report set children.

Parameters:

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

Returns:

list of IReportSet objects (!= null)

getReportSetChildren

java.util.List<? extends IReportSet> getReportSetChildren(java.lang.String sortingProperty)

Returns the report set children.

Parameters:

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

Returns:

list of IReportSet objects (!= null)

getReportSetChildrenWithCategory

java.util.List<? extends IReportSet> getReportSetChildrenWithCategory(java.lang.String categoryID)

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

The report set items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IReportSet objects (!= null)

getReportSetChildrenWithCategory

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

Returns the report 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 IReportSet objects (!= null)

getReportSetChildrenWithCategory

java.util.List<? extends IReportSet> getReportSetChildrenWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)

Returns the report 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 IReportSet objects (!= null)

getReportSetChildrenWithDefaultCategory

java.util.List<? extends IReportSet> getReportSetChildrenWithDefaultCategory()

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

The report set items are returned in their natural order.

Returns:

list of IReportSet objects (!= null)

getReportSetChildrenWithDefaultCategory

java.util.List<? extends IReportSet> getReportSetChildrenWithDefaultCategory(int sortingCriterion)

Returns the report 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 IReportSet objects (!= null)

getReportSetChildrenWithDefaultCategory

java.util.List<? extends IReportSet> getReportSetChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the report 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 IReportSet objects (!= null)

hasReportChildren

boolean hasReportChildren()

Returns whether this report set has children of type report.

Returns:

whether this report set has children of type report

getReportChildren

java.util.List<? extends IReport> getReportChildren()

Returns the report children.

The report items are returned in their natural order.

Returns:

list of IReport objects (!= null)

getReportChildren

java.util.List<? extends IReport> getReportChildren(int sortingCriterion)

Returns the report children.

Parameters:

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

Returns:

list of IReport objects (!= null)

getReportChildren

java.util.List<? extends IReport> getReportChildren(java.lang.String sortingProperty)

Returns the report children.

Parameters:

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

Returns:

list of IReport objects (!= null)

getReportChildrenWithCategory

java.util.List<? extends IReport> getReportChildrenWithCategory(java.lang.String categoryID)

Returns the report children that belong to the specified category.

The report items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IReport objects (!= null)

getReportChildrenWithCategory

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

Returns the report 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 IReport objects (!= null)

getReportChildrenWithCategory

java.util.List<? extends IReport> getReportChildrenWithCategory(java.lang.String categoryID,
                                                                java.lang.String sortingProperty)

Returns the report 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 IReport objects (!= null)

getReportChildrenWithDefaultCategory

java.util.List<? extends IReport> getReportChildrenWithDefaultCategory()

Returns the report children that belong to the default category.

The report items are returned in their natural order.

Returns:

list of IReport objects (!= null)

getReportChildrenWithDefaultCategory

java.util.List<? extends IReport> getReportChildrenWithDefaultCategory(int sortingCriterion)

Returns the report 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 IReport objects (!= null)

getReportChildrenWithDefaultCategory

java.util.List<? extends IReport> getReportChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the report 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 IReport objects (!= null)