Onion.Client
Im Namensraum Onion.Client werden alle Funktionalitäten für den Zugriff auf die Daten des onion.net Information Servers bereitgestellt.
Namensräume
| Namensraum | Beschreibung |
|---|---|
| Onion.Client.Configuration | Der Namensraum stellt Klassen zur Bereitstellung der Konfiguration der Client API zur Verfügung. |
| Onion.Client.Events | Der Namensraum Onion.Client.Events stellt Klassen zur Verarbeitung der onion.net Events bereit. |
Schnittstellen
| Schnittstelle | Beschreibung |
|---|---|
| IArchivedChangeSet | Repräsentiert die Entität eines archivierten ChangeSets. |
| IArchivedDataObject | Repräsentiert die Entität für ein archiviertes Datenobjekt. |
| IArchiveQuery | Stellt Funktionalitäten zur Ausführung einer Suche im Archiv der Datenverwaltung bereit. |
| IArchiveSearchResult | Dient als Container für die Ergebnisse eines Suchvorgangs im Papierkorb für Datenobjekte. |
| IAssignmentChangedGroupModification | Repräsentiert die strukturelle Veränderung "Arbeitsbereich geändert". |
| IBinaryObject | Repräsentiert die Entität eines Binärobjektes in onion.net. |
| IBinaryObjectLifetime | Repräsentiert die Entität einer Version eines Binärobjektes. |
| IBinaryObjectLifetimeCollection | Enthält eine Liste aller Versionen eines Binärobjektes. |
| IChangeSet | Repräsentiert die Entität für ein Enterprise ChangeSet. |
| IChangeSetArchiveCollection | Enthält eine Zusammenstellung aller bereits freigegebenen ChangeSets. |
| IChangeSetController | Enthält Methoden zur Verwaltung von ChangeSets. |
| IChangeSetDiscardedModification | Repräsentiert die strukturelle Veränderung "ChangeSet verworfen". |
| IChangeSetEntries | Dient als Container für eine Liste von Änderungen in ChangeSets. |
| IChangeSetEntry | Repräsentiert die Entität für die Sammlung aller Änderungen für ein Datenobjekt. |
| IChangeSetEntryAction | Führt eine Aktion für eine Zusammenstellung von Änderungen durch. |
| IChangeSetInitialPosition | Repräsentiert eine strukturelle Veränderung eines ChangeSets. Diese ist die Erstellung eines ChangeSets. |
| IChangeSetModification | Enthält Metainformationen zu einer Änderung eines Aspektes eines Datenobjektes. |
| IChangeSetRenamedModification | Repräsentiert die strukturelle Veränderung "ChangeSet umbenannt". |
| IChangeSetRightCollection | Liefert eine Zusammenstellung aller Berechtigungen eines ChagneSets zurück. |
| IChangeSetStateChangedModification | Repräsentiert die strukturelle Veränderung "Änderung des Status eines ChangeSets". |
| IChangeSetStructuralModification | Stellt die Basis aller strukruellen Veränderungen für ein ChangeSet dar. |
| IChangeSetStructuralModificationCollection | Liefert eine Zusammenstellung aller strukturellen Veränderungen eines ChangeSets. |
| IChangSetCommittedModification | Repräsentiert die strukturelle Veränderung "ChangeSet publiziert". |
| IDataArchive | Repräsentiert die Entität des Archives für Datenobjekte in onion.net. |
| IDataObject | Repräsentiert die Entität eines Datenobjektes in onion.net |
| IDataObjectChildrenCollection | Repräsentiert eine Zusammenstellung von Datenobjekten, welche sich unterhalb eines anderen Datenobjektes befinden. |
| IDataObjectContent | Repräsentiert den Teil Inhalt der Entität eines Datenobjektes. |
| IDataObjectDeletedModification | Repräsentiert die strukturelle Veränderung "Datenobjekt gelöscht". |
| IDataObjectHistory | Enthält Listen aller Versionen und struktureller Veränderungen eines Datenobjektes. |
| IDataObjectIdentityReservation | Repräsentiert eine Reservierung für eine Id eines Datenobjektes. |
| IDataObjectInitialPosition | Repräsentiert eine strukturelle Veränderung eines Datenobjektes. Diese ist die Erstellung des Datenobjektes. |
| IDataObjectLock | Repräsentiert die Entität für eine Sperre eines Datenobjektes. |
| IDataObjectLockCollection | Enthält eine Zusammenstellung von Sperren für Datenobjekte. |
| IDataObjectMeta | Repräsentiert den Teil Metainformationen der Entität eines Datenobjektes. |
| IDataObjectNameModification | Repräsentiert die strukturelle Veränderung "Datenobjekt umbenannt". |
| IDataObjectNameReservation | Repräsentiert eine Reservierung für einen Namen eines Datenobjektes. |
| IDataObjectParentModification | Repräsentiert die strukturelle Veränderung "Datenobjekt verschoben". |
| IDataObjectPublishedModification | Repräsentiert die strukturelle Veränderung "Datenobjekt publiziert". |
| IDataObjectReference | Repräsentiert eine Hülle für ein Datenobjekt. |
| IDataObjectReferenceCollection | Gibt eine Zusammenstellung von Referenzen zu Datenobjekten zurück. |
| IDataObjectReservation | Stellt die Basis für Reservierungen dar. |
| IDataObjectRestoredModification | Repräsentiert die strukturelle Veränderung "Datenobjekt wiederhergestellt". |
| IDataObjectRightCollection | Repräsentiert eine Zusammenstellung aller Berechtigungen für ein Datenobjekt. |
| IDataObjectStatus | Repräsentiert den Teil Status der Entität eines Datenobjektes. |
| IDataObjectStructuralModification | Stellt die Basis für strukturelle Veränderung dar. |
| IDataObjectStructuralModificationCollection | Ruft eine Zusammenstellung aller strukturellen Veränderungen für ein Datenobjekt ab. |
| IDataObjectVersion | Repräsentiert die Entität einer Version für ein Datenobjekt. |
| IDataObjectVersionCollection | Enthält eine Zusammenstellung aller Versionen für ein Datenobjekt. |
| IDataRepository | Stellt Methoden zum Zugriff auf Datenobjekte im Datenbestand und Datenarchiv zur Verfügung. |
| IDeleteProcess | Repräsentiert die Entität eines Löschvorgangs in onion.net |
| IEventHub | Stellt Ereignisse für die weitere Verarbeitung von Veränderungen in onion.net zur Verfügung. |
| IGroup | Repräsentiert die Entität einer Gruppe in onion.net |
| IGroupAddedIncludeModification | Repräsentiert die strukturelle Veränderung "Gruppe hinzugefügt zu Gruppe umfasst Rechte von". |
| IGroupAddedMemberModification | Repräsentiert die strukturelle Veränderung "Mitglied hinzugefügt". |
| IGroupCollection | Liefert eine Zusammenstellung aller Gruppen. |
| IGroupIncludeModification | Stellt die Basis für alle strukturellen Veränderungen von Gruppeninkludierungen dar. |
| IGroupIncludesCollection | Liefert eine Zusammenstellung aller Gruppeninkludierungen einer Gruppe. |
| IGroupInitialPosition | Repräsentiert eine strukturelle Veränderung einer Gruppe. Diese ist die Erstellung einer Gruppe. |
| IGroupMemberModification | Stellt die Basis für alle strukturellen Veränderungen von Gruppenmitgliedschaften dar. |
| IGroupMembersCollection | Liefert eine Zusammenstellung aller Gruppenmitglieder einer Gruppe. |
| IGroupMeta | Repräsentiert den Teil Metainformationen der Entität Gruppe. |
| IGroupRemovedIncludeModification | Repräsentiert die strukturelle Veränderung "Gruppe entfernt aus Gruppe umfasst Rechte von". |
| IGroupRemovedMemberModification | Repräsentiert die strukturelle Veränderung "Mitglied entfernt". |
| IGroupRenamedModification | Repräsentiert die strukturelle Veränderung "Gruppe umbenannt". |
| IGroupRightCollection | Liefert eine Zusammenstellung über alle Berechtigungen für Datenobjekte, die in der Gruppe definiert worden sind. |
| IGroupStructuralModification | Stellt die Basis für alle strukturellen Veränderungen einer Gruppe dar. |
| IGroupStructuralModificationCollection | Liefert eine Zusammenstellung aller strukturellen Veränderungen für eine Gruppe. |
| ILockProcess | Repräsentiert die Entität für einen Vorgang für Sperren auf Datenobjekte. |
| IOnionSession | Repräsentiert die Entität einer Sitzung zum onion.net Information Server. |
| IOnionSessionHost | Repräsentiert einen Teil der Entität einer onion.net Sitzung. |
| IPathFilterCollection | Liefert eine Zusammenstellung von Datenobjekten zur Filterung der Suchergebnisse im Datenbestand nach Pfaden. |
| ISchema | Repräsentiert die Entität eines Schemas in onion.net. |
| ISchemaAbstractModification | Repräsentiert die strukturelle Veränderung "Schema ist abstrakt". |
| ISchemaChangeSet | Ermöglicht die Aktualisierung einer Sammlung von Schemata in einem Vorgang. |
| ISchemaChildrenCollection | Repräsentiert eine Zusammenstellung von Schemata, welche sich strukturell unterhalb eines anderen Schemas befinden. |
| ISchemaContent | Repräsentiert die Teile Inhalt und Metainformationen der Entität Schema. |
| ISchemaFilterCollection | Liefert eine Zusammenstellung von Schemata zur Filterung der Suchergebnisse im Datenbestand. |
| ISchemaHistory | Enthält Zusammenstellungen aller Versionen und strukturelle Veränderungen eines Schemas. |
| ISchemaInitialPosition | Repräsentiert eine strukturelle Veränderung eines Schemas. Diese ist die Erstellung des Schemas. |
| ISchemaParentModification | Repräsentiert die strukturelle Veränderung "Schema verschoben". |
| ISchemaRenamedModification | Repräsentiert die strukturelle Veränderung "Schema umbenannt". |
| ISchemaRepository | Stellt Methoden zum Zugriff auf Schemata zur Verfügung. |
| ISchemaSortChildrenAlphabeticModification | Repräsentiert die strukturelle Veränderung "Kinddatenobjekte alphabetisch sortieren. |
| ISchemaStructuralModification | Stellt die Basis für alle strukturellen Veränderungen eines Schemas dar. |
| ISchemaStructuralModificationCollection | Liefert eine Zusammenstellung aller strukturellen Veränderungen für ein Schema. |
| ISchemaUpdateProgress | Führt die Aktualisierung von Schemata und Datenobjekten durch. |
| ISchemaVersion | Repräsentiert die Entität einer Version für ein Schema. |
| ISchemaVersionCollection | Enthält eine Zusammenstellung aller Versionen für ein Schema. |
| ISchemaVersioningDisabledModification | Repräsemtiert die strukturelle Veränderung "Versionierung für Datenobjekte deaktiviert". |
| ISearchQuery | Repräsentiert eine Suche im Datenbestand. |
| ISearchResult | Repräsentiert das Suchergebnis einer Suche im Datenbestand. |
| IStructureSchemaChildrenCollection | Enthält eine Zusammenstellung aller Kindschemata eines Schemas. |
| ITemporaryBinaryObject | Repräsentiert ein temporäres Binärobjekt in onion.net. |
| ITransformationSet | Repräsentiert eine Zusammenstellung von Xsl Transformationen zur Aktualisierung von Datenobjekten. |
| IUser | Repräsentiert die Entität eines Benutzers in onion.net. |
| IUserAddedGroupModification | Repräsentiert die strukturelle Veränderung "Als Mitglied einer Gruppe hinzugefügt". |
| IUserCollection | Liefert eine Zusammenstellung aller Benutzer, die im System existieren. |
| IUserDeletedModification | Repräsentiert die strukturelle Veränderung "Benutzer gelöscht". |
| IUserGroupCollection | Liefert eine Zusammenstellung aller Gruppenmitgliedschaften des Benutzers. |
| IUserGroupModification | Stetllt die Basis für alle strukturellen Veränderungen von Gruppenmitgliedschaften dar. |
| IUserInitialPosition | Repräsentiert eine strukturelle Veränderung eines Benutzers. Diese ist die Erstellung eines Benutzers. |
| IUserMeta | Repräsentiert den Teil Metainformationen der Entität Benutzer. |
| IUserPasswordChangedModification | Repräsentiert die strukturelle Veränderung "Kennwort geändert". |
| IUserRemovedGroupModification | Repräsentiert die strukturelle Veränderung "Als Mitglied einer Gruppe entfernt". |
| IUserRenamedModification | Repräsentiert die strukturelle Veränderung "Benutzer umbenannt". |
| IUserRepository | Stellt Eigenschaften zum Zugriff auf die Benutzer und Gruppen der Benutzerverwaltung zur Verfügung. |
| IUserRolesUpdatedModification | Repräsentiert die strukturelle Veränderung "Rollen verändert". |
| IUserSettingsContainer | Repräsentiert die Entität für eine Zusammenstellung von Benutzerprofilen. |
| IUserStructuralModification | Stellt die Basis für alle strukturellen Veränderungen eines Benutzers dar. |
| IUserStructuralModificationCollection | Liefert eine Zusammenstellung aller strukturellen Veränderungen für einen Benutzer. |
Klassen
| Klasse | Beschreibung |
|---|---|
| AccessPermissionException | Diese Ausnahme wird ausgelöst, wenn der verwendete Benutzer beim Zugriff auf Informationen von onion.net nicht über genügend Berechtigungen verfügt. |
| AlreadyEnteredChangeSetException | Diese Ausnahme wird ausgelöst, wenn der angemeldete Benutzer in der aktuellen Sitzung versucht ein weiteres Enterprise ChangeSet zu betreten. |
| BinaryNotExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird auf nicht oder nicht mehr vorhandene Binärdaten in onion.net zuzugreifen. |
| ChangeSetAlreadyExistsException | Diese Ausnahme wird ausgelöst, wenn ein ChangeSet mit einem bereits vorhandenen Namen erstellt oder umbenannt wird. |
| ChangeSetLockedException | Diese Ausnahme wird ausgelöst, wenn der aktuelle Benutzer versucht Änderungen an Datenobjekten vorzunehmen, wenn sich das aktuelle Enterprise ChangeSet im gesperrten Zustand befindet. |
| ChangeSetNotFoundException | Diese Ausnahme wird ausgelöst, beim Versuch auf ein nicht vorhandenes ChangeSet zuzugreifen. |
| ChangeSetRight | Repräsentiert die Entität für eine Berechtigung eines ChangeSets. |
| ChildNotExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird auf ein nicht existierendes Kindobjekt zuzugreifen. |
| CircularReferenceException | Diese Ausnahme wird ausgelöst, wenn durch eine Operation eine zirkuläre Struktur im onion.net Datenbaum entsteht. |
| ContentFilter | Repräsentiert einen Filter für die onion.net Datensuche. Dieser Filter schränkt nach dem Inhalt ein. |
| DataObjectAlreadyExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein Datenobjekt mit gleichem Namen in einer Ebene zu erstellen oder zu verschieben. |
| DataObjectAlreadyLockedException | Diese Ausnahme wird ausgelöst, wenn versucht wird eine Sperre für ein Datenobjekt zu setzen, welche bereits für dieses besteht oder gegen eine andere Sperrregel verstößt. |
| DataObjectCheckedOutException | Diese Ausnahme wird ausgelöst, wenn versucht wird eine Operation für ein Datenobjekt auszuführen, für welche das Datenobjekt zurückgegeben sein muss. |
| DataObjectLockedException | Diese Ausnahme wird ausgelöst, wenn versucht wird eine Änderung an einem Datenobjekt durchzuführen, welche bereits in einem anderen ChangeSet vorgenommen worden ist. |
| DataObjectLockNotFoundException | Diese Ausnahme wird ausgelöst, wenn versucht wird auf eine Sperre zuzugreifen, die nicht existiert. |
| DataObjectNotCheckedOutException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein Datenobjekt zurückzugeben oder zu verwerfen, wenn dieses bereits zurückgegeben ist. |
| DataObjectNotExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein Datenobjekt anhand der Id, Name oder Pfad abzurufen oder auf Informationen von einem nicht mehr existierenden Datenobjekt zuzugreifen. |
| DataObjectReferencedException | Diese Ausnahme wird ausgelöst, wenn versucht wird das Datenobjekt zu löschen, es jedoch noch in einem anderen Datenobjekt referenziert wird. |
| DataObjectVersionNotExistsException | Diese Ausnahme wird ausgelöst, wenn nach einer Version für ein Datenobjekt gesucht wurde, welche nicht oder nicht im aktuellen Kontext vorhanden ist. |
| DataReferenceLockedException | Diese Ausnahme wird ausgelöst, wenn ein Datenobjekt referenziert werden soll, welches in einem ChangeSet zum Löschen markiert worden ist. |
| DeleteProcessNotFoundException | Diese Ausnahme wird ausgelöst, wenn versucht wird einen Löschprozess mit einer Id abzurufen, welcher nicht im Archiv existiert. |
| EnteredDifferentChangeSetException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein ChangeSet zu verlassen, welches nicht dies der aktuellen Sitzung ist. |
| GroupNotExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird eine Gruppe abzurufen, welche nicht existiert. |
| InvalidCredentialsException | Diese Ausnahme wird ausgelöst. wenn sich der Benutzer nicht am System anmelden kann. |
| InvalidSessionException | Diese Ausnahme wird ausgelöst, wenn die aktuelle Sitzung ungültig ist. |
| LockProcessNotFoundException | Diese Ausnahme wird ausgelöst, wenn der angemeldete Benutzer versucht einen LockProcess abzurufen, welcher nicht existiert. |
| NameFilter | Repräsentiert einen Filter für die onion.net Datensuche. Dieser Filter schränkt nach dem Namen ein. |
| OnionSession | Erzeugt eine Verbindung zum onion.net Information Server und ist die Implementierung der Schnittstelle IOnionSession. |
| OnionSessionState | Repräsentiert die Entität eines Zustandes einer Client API Sitzung. |
| RequiresSessionHostException | Diese Ausnahme wird ausgelöst, wenn der verwendete Benutzer versucht eine neue Sitzung (Subsession) zu erzeugen und nicht über die nötige Rolle Anwendungsserver verfügt. |
| Right | Repräsentiert die Entität für eine Berechtigung eines Datenobjektes. |
| SchemaAlreadyExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein Schema mit einem Namen zu erstellen, welches im System bereits vorhanden ist. |
| SchemaAlreadyInUseException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein Schema als abstrakt zu definieren, wenn bereits Instanzen existieren. |
| SchemaNotExistsException | Diese Ausnahme wird ausgelöst, wenn der angemeldete Benutzer versucht ein Schema abzurufen, welches nicht existiert. |
| SchemaStillReferencedException | Diese Ausnahme wird ausgelöst, wenn der angemeldete Benutzer versucht ein Schema zu löschen, welches noch verwendet wird. |
| SchemaUpdateException | Diese Ausnahme wird ausgelöst, wenn das zu speichernde XSD nicht valide ist. |
| SchemaVersionNotExistsException | Diese Ausnahme wird ausgelöst, wenn der angemeldete Benutzer nach einer Schemaversion sucht, die nicht existiert. |
| StructureSchemaChildAlreadyExistsException | Diese Ausnahme wird ausgelöst, wenn ein Schema ein zweites mal als Kindschema definiert werden soll. |
| StructureSchemaChildNotExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein Schema als Kindschema zu entfernen, wenn es bereits kein Kindschema war. |
| UserAlreadyExistsException | Diese Ausnahme wird ausgelöst, wenn versucht wird ein Benutzer mit einem Namen zu erstellen, welcher im System bereits vorhanden ist. |
| UserApplicationSettings | Repräsentiert die Entität eines Benutzerprofils. |
| UserNotExistsException | Diese Ausnahme wird ausgelöst, wenn der angemeldete Benutzer versucht einen Benutzer abzufragen, der nicht existiert. |
| WrongSchemaException | Diese Ausnahme wird ausgelöst, wenn der angemeldete Benutzer versucht ein Datenobjekt unterhalb eines anderen Datenobjektes zu erstellen, welches nach Kindschemadefinition nicht erlaubt ist. |
| XmlSchemaValidationException | Diese Ausnahme wird ausgelöst, wenn ein Schema nicht valide ist. |
Enumerationen
| Enumeration | Beschreibung |
|---|---|
| ApprovalState | Gibt den Zustand eines Publikationsstatus für ein Datenobjekt an. |
| ArchivedChangeSetState | Gibt an, wie das ChangeSet freigegeben worden ist. |
| ChangeSetState | Gibt den Zustand eines Enterprise ChangeSets an.. |
| ContentMatchType | Beeinflusst die Art der Inhaltssuche. |
| DataObjectChangeTypes | Gibt die Veränderungen eines Datenobjektes in einem ChangeSet an. |
| DataObjectStatusFilter | Repräsentiert einen Filter für die onion.net Datensuche. Dieser Filter schränkt nach dem Status des Datenobjektes ein. |
| GroupAssignment | Gibt den Arbeitsbereich für eine Gruppe im Datenbestand an. |
| LockTypes | Gibt die Sperre auf ein Datenobjekt an. |
| MatchType | Repräsentiert den Suchmodus für Wörter im Namen von Datenobjekten. |
| PositioningMode | Gibt an, ob ein Datenobjekt vor oder nach einem Referenzdatenobjekt positioniert werden soll. |
| RightValue | Gibt den Zustand für eine Berechtigung an. |
| SchemaReferenceType | Gibt an, wie ein Schema referenziert wird. |
| SchemaUpdatePhase | Gibt an, in welchem Schritt sich ein SchemaUpdateProgress befindet. |
| SearchMode | Gibt an, welche Datenobjekte im angegebenen Pfad gefunden werden sollen. |
| UserRoles | Gibt die Rolle eines Benutzers an. |
