ISchema

Represents the entity of a schema in onion.net

All types for data objects in onion.net are defined by means of this entity.

It is defined in an entity what content the type can contain and what types may be created underneath a data object.

The content consists of Xml and is defined by means of XSD (Xml Schema Definition). Through this definition, it can be ensured at any time that the data of all data objects follows the defined schemas and is valid. This means a data object cannot exist in the data repository at any time that does not correspond to the definition. Furthermore, the schema definition cannot be extended in such a manner that existing data objects no longer correspond to the extension.

This validation is not carried out for older versions of a data object, nor is it carried out for data objects located in the data archive. For this makes it possible to extend or restrict an XSD at runtime and thus adapt the system to new requirements.

Properties

PropertyDescription
Children:ISchemaChildrenCollection

Supplies all subordinate schema definitions of the schema.

DataObjectCount:Int32

Gets the number of instances of the schema.

History:ISchemaHistory

Gets the history for a data object.

Id:Int32

Gets the Id of the schema.

IncomingStructureReferences:ISchema[]

Supplies a list of all schemas in which the current schema has been defined as a child schema.

Methods

MethodDescription
BeginUpdateSchemaDefinition(String):ISchemaUpdateProgress

Starts a procedure for updating the schema.

BeginUpdateSchemaDefinition(String, ITransformationSet):ISchemaUpdateProgress

Starts a procedure for updating the schema and adapting data objects.

BeginUpdateSchemaDefinition(TimeSpan, String):ISchemaUpdateProgress

Starts a procedure for updating the schema.

BeginUpdateSchemaDefinition(TimeSpan, String, ITransformationSet):ISchemaUpdateProgress

Starts a procedure for updating the schema and adapting data objects.

Delete():Void

Deletes a schema from the schema management.

Delete(Boolean):Void

Deletes a schema from the schema management.

GetIncomingContentReferences(Boolean, SchemaReferenceType):ISchema[]

Calls a list of all schemas in which the current schema is used.

IsSubtypeOf(ISchema):Boolean

Checks whether the current schema corresponds to the indicated schema or is structurally subordinate to the latter.

Move(ISchema):Void

Moves the current schema below the indicated schema.

UpdateSchemaLocation(String):Void

Renames the current schema.