# Package org.appng.xml.platform

- Class Summary
  Class | 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.
  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.
  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 |
  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
  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.
  ObjectFactory | This object contains factory methods for each Java content interface and Java element interface generated in the org.appng.xml.platform package.
  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.
  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`.
  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
  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`.
  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`.
  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.

- Enum Summary
  Enum | Description
  --- | ---
  FieldPermissionType | Java class for fieldPermissionType.
  FieldType | Java class for fieldType.
  Icontype | Java class for icontype.
  ItemType | Java class for itemType.
  Linkmode | Java class for linkmode.
  MessageType | Java class for messageType.
  PanelLocation | Java class for panel-location.
  ParamType | Java class for paramType.
  PermissionMode | Java class for permissionMode.
  SelectionType | Java class for selectionType.
  SortOrder | Java class for sortOrder.

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