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

Interface IReport

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the report.
java.lang.String	getID() Returns the id of the report.
java.lang.String	getIDandTitle() Returns the id and title of the report.
IReportSet	getParentReportSet() Returns the parent report set.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildren() Returns the report configuration children.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildren(int sortingCriterion) Returns the report configuration children.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildren(java.lang.String sortingProperty) Returns the report configuration children.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildrenWithCategory(java.lang.String categoryID) Returns the report configuration children that belong to the specified category.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the report configuration children that belong to the specified category.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the report configuration children that belong to the specified category.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildrenWithDefaultCategory() Returns the report configuration children that belong to the default category.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildrenWithDefaultCategory(int sortingCriterion) Returns the report configuration children that belong to the default category.
java.util.List<? extends IReportConfiguration>	getReportConfigurationChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the report configuration children that belong to the default category.
java.lang.String	getTitle() Returns the title of the report.
boolean	hasReportConfigurationChildren() Returns whether this report has children of type report configuration.
boolean	hasReportSetParent() Returns whether this report 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

getID

java.lang.String getID()

Returns the id of the report.

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

Returns:

id of the report (!= null)

getTitle

java.lang.String getTitle()

Returns the title of the report.

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

Returns:

title of the report (!= null)

getDescription

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

Returns the description of the report.

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

getIDandTitle

java.lang.String getIDandTitle()

Returns the id and title of the report.

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

hasReportSetParent

boolean hasReportSetParent()

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

Returns:

whether this report 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 has no parent or a parent of a different type)

hasReportConfigurationChildren

boolean hasReportConfigurationChildren()

Returns whether this report has children of type report configuration.

Returns:

whether this report has children of type report configuration

getReportConfigurationChildren

java.util.List<? extends IReportConfiguration> getReportConfigurationChildren()

Returns the report configuration children.

The report configuration items are returned in their natural order.

Returns:

list of IReportConfiguration objects (!= null)

getReportConfigurationChildren

java.util.List<? extends IReportConfiguration> getReportConfigurationChildren(int sortingCriterion)

Returns the report configuration children.

Parameters:

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

Returns:

list of IReportConfiguration objects (!= null)

getReportConfigurationChildren

java.util.List<? extends IReportConfiguration> getReportConfigurationChildren(java.lang.String sortingProperty)

Returns the report configuration children.

Parameters:

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

Returns:

list of IReportConfiguration objects (!= null)

getReportConfigurationChildrenWithCategory

java.util.List<? extends IReportConfiguration> getReportConfigurationChildrenWithCategory(java.lang.String categoryID)

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

The report configuration items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IReportConfiguration objects (!= null)

getReportConfigurationChildrenWithCategory

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

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

getReportConfigurationChildrenWithCategory

java.util.List<? extends IReportConfiguration> getReportConfigurationChildrenWithCategory(java.lang.String categoryID,
                                                                                          java.lang.String sortingProperty)

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

getReportConfigurationChildrenWithDefaultCategory

java.util.List<? extends IReportConfiguration> getReportConfigurationChildrenWithDefaultCategory()

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

The report configuration items are returned in their natural order.

Returns:

list of IReportConfiguration objects (!= null)

getReportConfigurationChildrenWithDefaultCategory

java.util.List<? extends IReportConfiguration> getReportConfigurationChildrenWithDefaultCategory(int sortingCriterion)

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

getReportConfigurationChildrenWithDefaultCategory

java.util.List<? extends IReportConfiguration> getReportConfigurationChildrenWithDefaultCategory(java.lang.String sortingProperty)

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