# Uses of Package
org.appng.xml.platform

- Packages that use org.appng.xml.platform
  Package | Description
  --- | ---
  org.appng.api | Base package for the appNG API
  org.appng.api.support | Implementations of commonly used features like internationalization, permission- and parameter-processing etc.
  org.appng.api.support.field | Implementations of `FieldConverter` for the various `FieldType`s
  org.appng.api.support.validation | This package contains all validation-related classes.
  org.appng.camunda.bpm |
  org.appng.core.model | The non-persistent domain model types.
  org.appng.testsupport | Test-related types
  org.appng.testsupport.validation | Types for validation of test data using XMLUnit
  org.appng.xml | Base package for the appNG XML-API
  org.appng.xml.platform |

- Classes in org.appng.xml.platform used by org.appng.api
  Class and Description
  Action Performs some business logic by implementing the `org.appng.api.ActionProvider<T>` interface.
  ActionRef A reference to a `Action`.
  ApplicationRootConfig The root configuration of the application, defining `SessionParams` and `Navigation`.
  Condition A `Condition` is used to check whether the owning element should be displayed.
  Config A container for several configuration elements.
  Data The actual payload of a `Datasource`, containing either a single `Result` or a `Resultset`.
  Datafield For each `FieldDef`inition of a `Datasource`'s `MetaData`, a `Datafield` is being added to the `Result`.
  Datasource Provides some data by implementing the `org.appng.api.DataProvider` interface.
  DatasourceRef A reference to a `Datasource`.
  Event An event is a container for multiple `Action`s, which usually operate on the same kind of domain objects.
  FieldDef A `FieldDef`inition maps a property of a Java-object to it's XML-representation and vice versa.
  FieldPermissions The permissions for a field.
  FieldType Java class for fieldType.
  Icon Used to define the icon for a link.
  Label An internationalized text retrieved from the applications dictionary.
  Linkable
  Linkpanel A `Linkpanel` defines a set of `Link`s which are being displayed on the given `PanelLocation`.
  Messages A set of `Message`s
  MetaData The MetaData defines how the binding from domain-objects to their XML-representation is done, and vice versa.
  OutputFormat The OutputFormat determines the basic format of the output, such as html,pdf or xml.
  OutputType An OutputType offers a certain layout for a `OutputFormat`.
  PageDefinition Defines a page including its `StructureDef` and `PageConfig`.
  Permission A single permission
  Result For each `FieldDef` defined in the `MetaData` (where the `Condition` and `Permissions` are satisfied), the result contains a corresponding `Datafield`.
  Resultset A Resulset contains a set of `Result`s, including pagination support.
  Selection A `Selection` is used to filter a `Resultset` or to display a `FieldDef` which uses a list-type (e.g `FieldType.LIST_SELECT`).
  SelectionGroup A group of `Selection`s used to filter a `Resultset`.
  Sort Contains the `SortOrder` and priority for a sortable `FieldDef`.
  Validation A container for the different validation rules of a field.

- Classes in org.appng.xml.platform used by org.appng.api.support
  Class and Description
  Action Performs some business logic by implementing the `org.appng.api.ActionProvider<T>` interface.
  ActionRef A reference to a `Action`.
  ApplicationRootConfig The root configuration of the application, defining `SessionParams` and `Navigation`.
  Condition A `Condition` is used to check whether the owning element should be displayed.
  Config A container for several configuration elements.
  Data The actual payload of a `Datasource`, containing either a single `Result` or a `Resultset`.
  Datasource Provides some data by implementing the `org.appng.api.DataProvider` interface.
  DatasourceRef A reference to a `Datasource`.
  Datasources A wrapper for multiple `Datasource`s.
  Event An event is a container for multiple `Action`s, which usually operate on the same kind of domain objects.
  FieldDef A `FieldDef`inition maps a property of a Java-object to it's XML-representation and vice versa.
  Label An internationalized text retrieved from the applications dictionary.
  Labels A container for a collection of `Label`s.
  Linkpanel A `Linkpanel` defines a set of `Link`s which are being displayed on the given `PanelLocation`.
  Messages A set of `Message`s
  MetaData The MetaData defines how the binding from domain-objects to their XML-representation is done, and vice versa.
  Option Defines a possible option for a `Selection`
  OptionGroup A group of options.
  PageConfig The configuration of a page, containing the `UrlSchema`.
  PageDefinition Defines a page including its `StructureDef` and `PageConfig`.
  Pages A set of `PageDefinition`s.
  Result For each `FieldDef` defined in the `MetaData` (where the `Condition` and `Permissions` are satisfied), the result contains a corresponding `Datafield`.
  Resultset A Resulset contains a set of `Result`s, including pagination support.
  Selection A `Selection` is used to filter a `Resultset` or to display a `FieldDef` which uses a list-type (e.g `FieldType.LIST_SELECT`).
  SelectionType Java class for selectionType.

- Classes in org.appng.xml.platform used by org.appng.api.support.field
  Class and Description
  Datafield For each `FieldDef`inition of a `Datasource`'s `MetaData`, a `Datafield` is being added to the `Result`.

- Classes in org.appng.xml.platform used by org.appng.api.support.validation
  Class and Description
  FieldDef A `FieldDef`inition maps a property of a Java-object to it's XML-representation and vice versa.
  MetaData The MetaData defines how the binding from domain-objects to their XML-representation is done, and vice versa.
  Rule A custom rule supporting any options
  ValidationRule Abstract base-class for specific validation rules.

- Classes in org.appng.xml.platform used by org.appng.camunda.bpm
  Class and Description
  FieldDef A `FieldDef`inition maps a property of a Java-object to it's XML-representation and vice versa.

- Classes in org.appng.xml.platform used by org.appng.core.model
  Class and Description
  Action Performs some business logic by implementing the `org.appng.api.ActionProvider<T>` interface.
  ApplicationReference The application, as part of the platform's content.
  Authentication A special navigation-item that represents an available authentication mechanism.
  Authentications A wrapper for the available `Authentication` items.
  Config A container for several configuration elements.
  Data The actual payload of a `Datasource`, containing either a single `Result` or a `Resultset`.
  DataConfig The configuration for a `Datasource`.
  Datafield For each `FieldDef`inition of a `Datasource`'s `MetaData`, a `Datafield` is being added to the `Result`.
  Datasource Provides some data by implementing the `org.appng.api.DataProvider` interface.
  DatasourceRef A reference to a `Datasource`.
  FieldDef A `FieldDef`inition maps a property of a Java-object to it's XML-representation and vice versa.
  Label An internationalized text retrieved from the applications dictionary.
  Linkable
  Linkpanel A `Linkpanel` defines a set of `Link`s which are being displayed on the given `PanelLocation`.
  Messages A set of `Message`s
  MetaData The MetaData defines how the binding from domain-objects to their XML-representation is done, and vice versa.
  NavigationItem A single item for navigation.
  OutputFormat The OutputFormat determines the basic format of the output, such as html,pdf or xml.
  OutputType An OutputType offers a certain layout for a `OutputFormat`.
  PageDefinition Defines a page including its `StructureDef` and `PageConfig`.
  PageReference A concrete page containing a `Structure`, which was previously defined by a `PageDefinition`.
  Param A parameter, used for the `UrlSchema` of a `PageDefinition` and for parametrizing `Action`s and `Datasource`s.
  Params A set of `Param`eters used when referencing/calling an `Action`/`Datasource`.
  Platform The root element of an appNG target XML document.
  PlatformConfig The configuration for the owning `Platform`.
  Result For each `FieldDef` defined in the `MetaData` (where the `Condition` and `Permissions` are satisfied), the result contains a corresponding `Datafield`.
  Resultset A Resulset contains a set of `Result`s, including pagination support.
  Section Defines a section of a `Structure`.
  Sectionelement Defines an element of a `Section`.
  Selection A `Selection` is used to filter a `Resultset` or to display a `FieldDef` which uses a list-type (e.g `FieldType.LIST_SELECT`).
  Subject A subject contains information about the currently logged-in user.
  Template A Template references a XSL stylesheet, located either in the folder `/xsl` of a appNG-template or of a appNG-application.
  ValidationRule Abstract base-class for specific validation rules.

- Classes in org.appng.xml.platform used by org.appng.testsupport
  Class and Description
  Action Performs some business logic by implementing the `org.appng.api.ActionProvider<T>` interface.
  ActionRef A reference to a `Action`.
  DatasourceRef A reference to a `Datasource`.
  Params A set of `Param`eters used when referencing/calling an `Action`/`Datasource`.

- Classes in org.appng.xml.platform used by org.appng.testsupport.validation
  Class and Description
  Action Performs some business logic by implementing the `org.appng.api.ActionProvider<T>` interface.
  Datasource Provides some data by implementing the `org.appng.api.DataProvider` interface.

- Classes in org.appng.xml.platform used by org.appng.xml
  Class and Description
  Bean References a bean defined in the applications `beans.xml` file.

- Classes in org.appng.xml.platform used by org.appng.xml.platform
  Class and Description
  Action Performs some business logic by implementing the `org.appng.api.ActionProvider<T>` interface.
  ActionRef A reference to a `Action`.
  ApplicationConfig The `ApplicationConfig` is responsible for the basic configuration of a application.
  ApplicationReference The application, as part of the platform's content.
  ApplicationRootConfig The root configuration of the application, defining `SessionParams` and `Navigation`.
  Authentication A special navigation-item that represents an available authentication mechanism.
  Authentications A wrapper for the available `Authentication` items.
  Bean References a bean defined in the applications `beans.xml` file.
  BeanOption Used to parametrize a `Bean`.
  Condition A `Condition` is used to check whether the owning element should be displayed.
  Config A container for several configuration elements.
  Content The actual content of a `Platform`.
  Data The actual payload of a `Datasource`, containing either a single `Result` or a `Resultset`.
  DataConfig The configuration for a `Datasource`.
  Datafield For each `FieldDef`inition of a `Datasource`'s `MetaData`, a `Datafield` is being added to the `Result`.
  Datasource Provides some data by implementing the `org.appng.api.DataProvider` interface.
  DatasourceRef A reference to a `Datasource`.
  Datasources A wrapper for multiple `Datasource`s.
  Digits A `ValidationRule` indicating the `FieldDef`'s value is a digit with a maximum of `Digits.getInteger()` integral digits and `Digits.getFraction()` fraction digits.
  Event An event is a container for multiple `Action`s, which usually operate on the same kind of domain objects.
  Events A wrapper for multiple `Event`s.
  FieldDef A `FieldDef`inition maps a property of a Java-object to it's XML-representation and vice versa.
  FieldPermissions The permissions for a field.
  FieldPermissionType Java class for fieldPermissionType.
  FieldType Java class for fieldType.
  FileUpload A `ValidationRule` indicating the `FieldDef`'s value represents one ore more `org.appng.forms.FormUpload`s.
  Future A `ValidationRule` indicating the `FieldDef`s value represents a date in the future.
  GetParams Those are the GET-`Param`eters which can be used on the page.
  Icon Used to define the icon for a link.
  Icontype Java class for icontype.
  ItemType Java class for itemType.
  Label An internationalized text retrieved from the applications dictionary.
  Labels A container for a collection of `Label`s.
  Link Java class for link complex type.
  Linkable
  Linkmode Java class for linkmode.
  Linkpanel A `Linkpanel` defines a set of `Link`s which are being displayed on the given `PanelLocation`.
  Localization Contains all localization-relevant information
  Max A `ValidationRule` indicating the `FieldDef`'s value must have a maximal decimal-value of `Max.getValue()`
  Message A single message
  Messages A set of `Message`s
  MessageType Java class for messageType.
  MetaData The MetaData defines how the binding from domain-objects to their XML-representation is done, and vice versa.
  Min A `ValidationRule` indicating the `FieldDef`'s value must have a minimal decimal-value of `Min.getValue()`
  Navigation ]>
  NavigationItem A single item for navigation.
  NotNull A `ValidationRule` indicating the `FieldDef`s value is mandatory and thus not nullable.
  OpenapiAction Java class for openapi-action complex type.
  Option Defines a possible option for a `Selection`
  OptionGroup A group of options.
  Output Defines the output-format and -type to be used.
  OutputFormat The OutputFormat determines the basic format of the output, such as html,pdf or xml.
  OutputType An OutputType offers a certain layout for a `OutputFormat`.
  PageConfig The configuration of a page, containing the `UrlSchema`.
  PageDefinition Defines a page including its `StructureDef` and `PageConfig`.
  PageReference A concrete page containing a `Structure`, which was previously defined by a `PageDefinition`.
  Pages A set of `PageDefinition`s.
  PagesReference A wrapper for a collection of `PageReference`s.
  PanelLocation Java class for panel-location.
  Param A parameter, used for the `UrlSchema` of a `PageDefinition` and for parametrizing `Action`s and `Datasource`s.
  Params A set of `Param`eters used when referencing/calling an `Action`/`Datasource`.
  ParamType Java class for paramType.
  Past A `ValidationRule` indicating the `FieldDef`s value represents a date in the past.
  Pattern A `ValidationRule` indicating the `FieldDef`'s value must match the regular expression defined by `Pattern.getRegexp()`.
  Permission A single permission
  PermissionMode Java class for permissionMode.
  Permissions A container for a set of `Permission`s.
  Platform The root element of an appNG target XML document.
  PlatformConfig The configuration for the owning `Platform`.
  PostParams Those are the POST-`Param`eters which can be used on the page.
  Result For each `FieldDef` defined in the `MetaData` (where the `Condition` and `Permissions` are satisfied), the result contains a corresponding `Datafield`.
  Resultset A Resulset contains a set of `Result`s, including pagination support.
  Rule A custom rule supporting any options
  Rule.Option Java class for anonymous complex type.
  Section Defines a section of a `Structure`.
  SectionConfig Java class for sectionConfig complex type.
  SectionDef Defines a section within a `StructureDef`.
  Sectionelement Defines an element of a `Section`.
  SectionelementDef Defines an section-element within a `SectionDef`.
  Selection A `Selection` is used to filter a `Resultset` or to display a `FieldDef` which uses a list-type (e.g `FieldType.LIST_SELECT`).
  SelectionGroup A group of `Selection`s used to filter a `Resultset`.
  SelectionType Java class for selectionType.
  Session Configures the session for the application.
  SessionInfo Keeps track of information about the users session with appNG.
  SessionParams A set of `Param`eters maintened by the session, may be a POST-, GET- or URL-paramter.
  Size A `ValidationRule` indicating the length of the `FieldDef`s value needs to be between `Size.getMin()` and `Size.getMax()` characters long.
  Sort Contains the `SortOrder` and priority for a sortable `FieldDef`.
  SortOrder Java class for sortOrder.
  Structure Defines the structure of a `PageDefinition`.
  StructureDef Defines the structure within a `PageDefinition`.
  Subject A subject contains information about the currently logged-in user.
  Template A Template references a XSL stylesheet, located either in the folder `/xsl` of a appNG-template or of a appNG-application.
  Textcontents Java class for anonymous complex type.
  TextElement A text element that contains some XML, plain text or a CDATA section.
  TextElement.Xml Java class for anonymous complex type.
  Textelements Java class for textelements complex type.
  Type A `ValidationRule` that contains the message for the case that the `FieldDef`s value does not match with its `FieldType`.
  UrlParams Those are the `Param`eters defined by the URL path-segments (separeted by '/') which can be used on the page.
  UrlSchema The URL-Schema defines which `Param`eters are allowed on a certain `PageReference` respectively `PageDefinition`.
  UserData This is used to keep track of the user inputs during validation.
  UserInputField A single field the users entered a value for.
  Validation A container for the different validation rules of a field.
  ValidationGroups Java class for validationGroups complex type.
  ValidationGroups.Group The full qualified class name for this group.
  ValidationRule Abstract base-class for specific validation rules.

Copyright © 2011–2023 aiticon GmbH. All rights reserved.