# Uses of Interface
org.eclipse.birt.report.model.api.core.IStructure

Packages that use IStructure
Package
Description
org.eclipse.birt.report.model.api
Tool-writer's interface for the BIRT design model (also known as the "Design Engine.")
org.eclipse.birt.report.model.api.command
Provides events when some command operations modify the state of the Design Engine.
org.eclipse.birt.report.model.api.core
Represents the fundamental data structures of the user-defined property and the interface of UI listener.
org.eclipse.birt.report.model.api.elements.structures
Defines the structure types in Model system.
org.eclipse.birt.report.model.api.simpleapi
Report element representations in the BIRT simple API environment.
org.eclipse.birt.report.model.api.validators
Provides the validation classes for semantic check on multiple properties.
org.eclipse.birt.report.model.core
Represents the fundamental data structures of the Design Engine.

## Uses of IStructure in org.eclipse.birt.report.model.api

Methods in org.eclipse.birt.report.model.api that return IStructure
Modifier and Type
Method
Description
`IStructure`
StructureHandle.`getStructure()`
Returns the structure.
Methods in org.eclipse.birt.report.model.api with parameters of type IStructure
Modifier and Type
Method
Description
`StructureHandle`
SimpleValueHandle.`addItem(IStructure item)`
Adds an item to the end of a list property or member.
`StructureHandle`
SimpleValueHandle.`insertItem(IStructure item, int posn)`
Inserts a new item into a list property or member at the given position.
`void`
SimpleValueHandle.`replaceItem(IStructure oldItem, IStructure newItem)`
Replaces an old structure with a new one for the this property or member.

## Uses of IStructure in org.eclipse.birt.report.model.api.command

Fields in org.eclipse.birt.report.model.api.command declared as IStructure
Modifier and Type
Field
Description
`protected IStructure`
PropertyNameException.`struct`
A structure object.
Constructors in org.eclipse.birt.report.model.api.command with parameters of type IStructure
Modifier
Constructor
Description
``
`PropertyNameException(org.eclipse.birt.report.model.core.DesignElement obj, IStructure struct, String memberName)`
Constructs a exception given a structure and its element and the invalid member name.

## Uses of IStructure in org.eclipse.birt.report.model.api.core

Classes in org.eclipse.birt.report.model.api.core that implement IStructure
Modifier and Type
Class
Description
`final class`
`UserPropertyDefn`
Represents a user-defined property.
Methods in org.eclipse.birt.report.model.api.core that return IStructure
Modifier and Type
Method
Description
`IStructure`
IStructure.`copy()`
Creates a deep copy of this structure.
`IStructure`
UserPropertyDefn.`copy()`
Makes a copy of this user property definition.

## Uses of IStructure in org.eclipse.birt.report.model.api.elements.structures

Classes in org.eclipse.birt.report.model.api.elements.structures that implement IStructure
Modifier and Type
Class
Description
`class`
`Action`
The Action structure defines a hyperlink.
`class`
`AggregationArgument`
AggregationArgument.
`class`
`CachedMetaData`
Structure used to cache data set information that include output column information when it gets from databases, input/output parameter definitions.
`class`
`CalculationArgument`
CalculationArgument.
`class`
`ColumnHint`
This class represents one column hint used by data sets.
`class`
`ComputedColumn`
Represents one computed column.
`class`
`ConfigVariable`
This class represents a configuration variable in the report's config variable list.
`class`
`CustomColor`
Represents an custom color in the report's color palette.The use-defined color has a unique name and a valid RGB value for render.
`class`
`DataSetParameter`
Represents the parameter for ODA drivers.
`class`
`DateFormatValue`
The format value for the data.
`class`
`DateTimeFormatValue`
The format value for the data-time.
`class`
`DimensionCondition`
The DimensionCondition structure defines a list of join conditions between cube and hierarchy.
`class`
`DimensionJoinCondition`
Represents a dimension join condition in the DimensionCondition.
`class`
`EmbeddedImage`
Represents an embedded image.
`class`
`ExtendedProperty`
This class represents one Extended property.
`class`
`FilterCondition`
Represents one filter in the filter list of List, Table or their Groups.
`class`
`FormatValue`
The abstract value for the format of string, data-time and number.
`class`
`HideRule`
Implements hide rules of a `ReportItem`.
`class`
`HighlightRule`
Represents a highlight rule that says how a data item should appear based on the value within it.
`class`
`IncludedCssStyleSheet`
Included css style sheet structure
`class`
`IncludedLibrary`
This class represents one include library of report design.
`class`
`IncludeScript`
This class represents a include script.
`class`
`JoinCondition`
Represents a condition used for joint data set.
`class`
`LevelAttribute`
This class represents one attribute of the level element.
`class`
`MapRule`
This class represents a style mapping rule: a translation of a database value into a set of display values.
`class`
`NumberFormatValue`
The format value for the number like integer, float, etc.
`class`
`OdaDataSetParameter`
Represents the parameter for ODA drivers.
`class`
`OdaDesignerState`
The structure of the Oda designer state.
`class`
`OdaLevelAttribute`
This class represents one attribute of the level element.
`class`
`OdaResultSetColumn`
`class`
`ParamBinding`
This class presents the parameter binding that bind data set input parameter to expression by position.
`class`
`ParameterFormatValue`
Represents the format for the default value of scalar parameter.
`class`
`PropertyBinding`
Represents the property binding structure.
`class`
`PropertyMask`
This class provides property masks of system or user defined properties.
`class`
`ResultSetColumn`
This class represents one column in the result set.
`class`
`Rule`
This class represents one rule.
`class`
`ScriptLib`
Represents a jar file used for script handle event.
`class`
`SearchKey`
Structure for optional list of search criteria.
`class`
`SelectionChoice`
This class is a structure for selection-list in ScalarParameter item.
`class`
`SortHint`
This class represents a sort hint.
`class`
`SortKey`
This class represents a sort entry for a table or list item, it defines the column and sort direction pair.
`class`
`StringFormatValue`
The format value for the string type.
`class`
`StyleRule`
Base class for highlight and map rules in the style.
`class`
`TimeFormatValue`
The format value for the time.
`class`
`TimeInterval`
Time interval structure.
`class`
`TOC`
The TOC structure defines a TOC.

## Uses of IStructure in org.eclipse.birt.report.model.api.simpleapi

Methods in org.eclipse.birt.report.model.api.simpleapi that return IStructure
Modifier and Type
Method
Description
`IStructure`
IAction.`getStructure()`
Gets the internal structure instance of this action.
`IStructure`
IDataBinding.`getStructure()`
Returns structure.
`IStructure`
IFilterCondition.`getStructure()`
Returns structure.
`IStructure`
IHideRule.`getStructure()`
Returns structure.
`IStructure`
IHighlightRule.`getStructure()`
Returns structure.
`IStructure`
ISortCondition.`getStructure()`
Returns structure.

## Uses of IStructure in org.eclipse.birt.report.model.api.validators

Methods in org.eclipse.birt.report.model.api.validators with parameters of type IStructure
Modifier and Type
Method
Description
`List<SemanticException>`
StructureListValidator.`validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, IStructure toAdd)`
Validates whether a new structure can be added to structure list.
`List<SemanticException>`
StructureListValidator.`validateForRenaming(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, IStructure toRenamed, IPropertyDefn memberDefn, String newName)`
Validates whether a structure can be renamed to the given name.

## Uses of IStructure in org.eclipse.birt.report.model.core

Classes in org.eclipse.birt.report.model.core that implement IStructure
Modifier and Type
Class
Description
`class`
`org.eclipse.birt.report.model.core.PropertyStructure`
Base class for structures that store some or all of their properties in a hash table.
`class`
`org.eclipse.birt.report.model.core.ReferencableStructure`
Represents a structure that can be referenced using a property of name type.
`class`
`org.eclipse.birt.report.model.core.Structure`
Base class for property structures.