PrismSchema (midPoint API Distribution 4.4.11-SNAPSHOT API)

All Superinterfaces:

DebugDumpable, DefinitionSearchImplementation, DefinitionsStore, Freezable, GlobalDefinitionsStore, PrismContextSensitive

All Known Subinterfaces:

ConnectorSchema, LayerRefinedResourceSchema, MutablePrismSchema, MutableResourceSchema, RefinedConnectorSchema, RefinedResourceSchema, ResourceSchema

All Known Implementing Classes:

ConnectorSchemaImpl, LayerRefinedResourceSchemaImpl, com.evolveum.midpoint.prism.impl.schema.PrismSchemaImpl, RefinedConnectorSchemaImpl, RefinedResourceSchemaImpl, ResourceSchemaImpl
```
public interface PrismSchema
extends DebugDumpable, GlobalDefinitionsStore, DefinitionSearchImplementation, PrismContextSensitive, Freezable
```
Schema as a collection of definitions. This is a midPoint-specific view of schema definition. It is just a collection of definitions grouped under a specific namespace. The schema and all the public classes in this package define a schema meta-model. It is supposed to be used for run-time schema interpretation. It will not be a convenient tool to work with static data model objects such as user or role. But it is needed for interpreting dynamic schemas for resource objects, extensions and so on.

Author:

semancik, mederly

Field Summary
- Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
  INDENT_STRING

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default @NotNull List<ComplexTypeDefinition>`	`getComplexTypeDefinitions()`
`@NotNull Collection<Definition>`	`getDefinitions()`	Returns set of definitions.
`<T extends Definition> @NotNull List<T>`	`getDefinitions(@NotNull Class<T> type)`	Returns set of definitions of a given type.
`@NotNull String`	`getNamespace()`	Returns schema namespace.
`default @NotNull List<PrismObjectDefinition>`	`getObjectDefinitions()`
`com.google.common.collect.Multimap<QName,ItemDefinition<?>>`	`getSubstitutions()`
`boolean`	`isEmpty()`
`@NotNull Document`	`serializeToXsd()`

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.schema.GlobalDefinitionsStore
findComplexTypeDefinitionByCompileTimeClass, findComplexTypeDefinitionByType, findContainerDefinitionByCompileTimeClass, findContainerDefinitionByElementName, findContainerDefinitionByType, findItemDefinitionByCompileTimeClass, findItemDefinitionByElementName, findItemDefinitionByElementName, findItemDefinitionByType, findItemDefinitionByType, findItemDefinitionsByCompileTimeClass, findItemDefinitionsByElementName, findItemDefinitionsByElementName, findObjectDefinitionByCompileTimeClass, findObjectDefinitionByElementName, findObjectDefinitionByType, findPropertyDefinitionByElementName, findReferenceDefinitionByElementName, findSimpleTypeDefinitionByType, findTypeDefinitionByCompileTimeClass, findTypeDefinitionByType, findTypeDefinitionByType, findTypeDefinitionsByType, findTypeDefinitionsByType

Methods inherited from interface com.evolveum.midpoint.prism.PrismContextSensitive
getPrismContext

Method Detail

getNamespace
```
@NotNull
@NotNull String getNamespace()
```
Returns schema namespace. All schema definitions are placed in the returned namespace.

Returns:

schema namespace

getDefinitions
```
@NotNull
@NotNull Collection<Definition> getDefinitions()
```
Returns set of definitions. The set contains all definitions of all types that were parsed. Order of definitions is insignificant.

Returns:

set of definitions

getDefinitions
```
@NotNull
<T extends Definition> @NotNull List<T> getDefinitions(@NotNull
                                                       @NotNull Class<T> type)
```
Returns set of definitions of a given type. The set contains all definitions of the given type that were parsed. Order of definitions is insignificant.

Returns:

set of definitions

getObjectDefinitions

@NotNull
default @NotNull List<PrismObjectDefinition> getObjectDefinitions()

getComplexTypeDefinitions

@NotNull
default @NotNull List<ComplexTypeDefinition> getComplexTypeDefinitions()

serializeToXsd

@NotNull
@NotNull Document serializeToXsd()
                          throws SchemaException

Throws:: SchemaException

isEmpty
```
boolean isEmpty()
```

getSubstitutions

com.google.common.collect.Multimap<QName,ItemDefinition<?>> getSubstitutions()