## Uses of Class
org.appng.xml.BaseObject

- Packages that use BaseObject
  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.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.platform |

- - ### Uses of BaseObject in org.appng.api

    Subclasses of BaseObject in org.appng.api
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FieldWrapper` A `FieldWrapper` extends a `FieldDef` and adds the ability to read and set the field's string-representation ( `FieldWrapper.getStringValue()`/`FieldWrapper.setStringValue(String)`) and also the object-representation ( `FieldWrapper.getObject()`/ `FieldWrapper.setObject(Object)`).

  - ### Uses of BaseObject in org.appng.api.support

    Subclasses of BaseObject in org.appng.api.support
    Modifier and Type | Class and Description
    --- | ---
    `class` | `OptionGroupFactory.OptionGroup`
    `class` | `SelectionFactory.Selection`

  - ### Uses of BaseObject in org.appng.core.model

    Subclasses of BaseObject in org.appng.core.model
    Modifier and Type | Class and Description
    --- | ---
    `protected class` | `ApplicationProvider.DataSourceWrapper`

  - ### Uses of BaseObject in org.appng.testsupport

    Subclasses of BaseObject in org.appng.testsupport
    Modifier and Type | Class and Description
    --- | ---
    `protected class` | `TestBase.ActionCall` A wrapper for an `ActionRef`, allowing to add `Param`eters and to retrieve the actual `CallableAction`.
    `protected class` | `TestBase.DataSourceCall` A wrapper for a `DatasourceRef`, allowing to add `Param`eters and to retrieve the actual `CallableDataSource`.

    Methods in org.appng.testsupport with parameters of type BaseObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | TestBase.`validate(BaseObject object)`
    `void` | TestBase.`validate(BaseObject object, org.custommonkey.xmlunit.DifferenceListener differenceListener)`
    `void` | TestBase.`validate(BaseObject object, String suffix)`
    `void` | TestBase.`validate(BaseObject object, String suffix, org.custommonkey.xmlunit.DifferenceListener differenceListener)`

  - ### Uses of BaseObject in org.appng.testsupport.validation

    Methods in org.appng.testsupport.validation with parameters of type BaseObject
    Modifier and Type | Method and Description
    --- | ---
    `static void` | WritingXmlValidator.`validateXml(BaseObject object, String controlFile)` Validates that the document represented by `object` is equal to the document parsed from the `controlFile`.
    `static void` | WritingXmlValidator.`validateXml(BaseObject object, String controlFile, org.custommonkey.xmlunit.DifferenceListener differenceListener)` Validates that the document represented by `object` is equal to the document parsed from the `controlFile`.

  - ### Uses of BaseObject in org.appng.xml.platform

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

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