ks.model

Das Model in WSPone ist der Dreh- und Angelpunkt für jede Applikation. Das Model beschreibt, wie eine Applikation aufgebaut ist. Welche Entities es gibt und wie diese definiert wurden. Auch das Aussehen eines Formulars wird hierüber beschrieben. Mit ks.model lässt sich auf dieses Model zugreifen.

getApplications

Falls kein expliziter Applikationsname definiert wurde, gibt diese Funktion alle Applikationen zurück. Falls doch einer angegeben wurde, werden alle Applikationen mit diesem Namen zurückgegeben.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
name	String	Nein	Optionaler Name einer Applikation die geholt werden soll

getApplication

Lädt die Applikationsdefinition für den angegebenen Applikationsnamen aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
application	String	Ja	Name der Applikation die geholt werden soll

getTypes

Falls kein expliziter Typename definiert wurde, gibt diese Funktion alle Typen zurück. Falls doch einer angegeben wurde, werden alle Typen mit diesem Namen zurückgegeben. Typen sind beispielsweise String oder Choices.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
name	String	Nein	Optionaler Name des Types der geholt werden soll

getType

Lädt die Type Definition für den angegebenen Type Namen aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
type	String	Ja	Name des Types die geholt werden soll

getWizard

Lädt die Definition eines Wizards anhand dessen Namen oder Id.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
nameOrId	String	Ja	Name oder Id des Wizards

getWizardSection

Lädt die Definition einer WizardSection anhand dessen Namen oder Id.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
nameOrId	String	Ja	Name oder Id der WizardSection

getVirtualCollection

Lädt die Definition einer VirtualCollection anhand dessen Namen oder Id.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
nameOrId	String	Ja	Name oder Id der VirtualCollection

getTypeName

Lädt die Name des Typen für das angegebene Feld. Falls das Feld eine Choice ist, wird auch Choice zurückgegeben. Falls das Feld beispielsweise ein Boolean Feld ist, wird Boolean zurückgeliefert. Bei Relationen wird lediglich zwischen KolibriEntity[] bei ToMany Relationen und KolibriEntity bei allen anderen Relationen unterschieden.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
field	Objekt	Ja	Feld dessen Type bestimmt werden soll

getChoice

Lädt eine bestimmte Choice Definition.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
name	String	Ja	Name der Choice

getDisplayTransformations

Lädt alle DisplayTransformationen oder alle die unter dem angegebenen Namen gefunden werden konnten.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Ja	Name oder Id der DisplayTransformation

getDisplayTransformation

Lädt alle DisplayTransformationen oder alle die unter dem angegebenen Namen gefunden werden konnten.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
displayTransformation	String	Ja	Name oder Id der DisplayTransformation

getChoiceValue

Lädt die Wertdefinition für einen bestimmten Wert der gegebenen Choice.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
choiceName	String	Ja	Name der Choice
choiceValue	String	Ja	Name bzw. Wert der ChoiceValue die geladen werden soll

getEntities

Lädt alle Entities des aktuellen Models oder alle die unter dem angegebenen Namen gefunden werden können.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
name	String	Nein	Optionaler Name der Entity

getEntitiesLocalized

Lädt alle Entities des aktuellen Models oder alle die unter dem angegebenen Namen gefunden werden können. Hier ist der Name jedoch nicht der technische Name, sondern der übersetzte Name.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
name	String	Nein	Optionaler Name der Entity

Beispiel

Dieses Beispiel sucht die Entity NotificationRule aus dem Model, macht dies aber anhand des deutschen übersetzten Namen für diese Entity.

const notificationRuleEntity = await ks.model.getEntitiesLocalized('Benachrichtigungsregel');
console.log(notificationRuleEntity[0].name); // NotificationRule

getEntity

Lädt eine spezifische Entity des aktuellen Models. Der Name ist dabei der technische Name der Entity aus dem Designer.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
name	String	Ja	Name der Entity

getEntityByType

Sucht anhand der angegebenen Relation die Entity aus dem Model, auf die die Relation zeigt.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
relation1	Objekt	Ja	Relation dessen Zielentity geladen werden soll

getScriptTriggers

Lädt alle ScriptTrigger die für die angegebene Entity laufen.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	String	Ja	Name der Entity

getFullCalendarResource

Sucht anhand des angegebenen Namen die spezifische Kalenderressource aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Ja	Name oder Id der Ressource

getFullCalendarResources

Lädt alle Kalenderressource oder alle die unter dem angegebenen Namen gefunden werden konnten aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Nein	Name oder Id der Ressource

getFullCalendarEvent

Sucht anhand des angegebenen Namen das spezifische Kalenderevent aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Ja	Name oder Id des Events

getFullCalendarEvents

Lädt alle Kalenderevents oder alle die unter dem angegebenen Namen gefunden werden konnten aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Nein	Name oder Id des Events

getGuidedTour

Sucht anhand des angegebenen Namen die spezifische GuidedTour aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Ja	Name oder Id der GuidedTour

getGuidedTours

Lädt alle GuidedTours oder alle die unter dem angegebenen Namen gefunden werden konnten aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Nein	Name oder Id der GuidedTour

getGuidedTourStep

Sucht anhand des angegebenen Namen den spezifischen GuidedTour Schritt aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Ja	Name oder Id des GuidedTour Schritts

getGuidedTourSteps

Lädt alle GuidedTour Schritte oder alle die unter dem angegebenen Namen gefunden werden konnten aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
idOrName	String	Nein	Name oder Id des GuidedTour Schritts

getLayout

Lädt die Layoutdefinition mit dem angegebenen Namen oder anhand der Url aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
nameOrUrl	String	Ja	Name oder Url des Layouts

getLayouts

Lädt alle Layouts des aktuellen Models.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
N/A	N/A	N/A	N/A

getRelation

Lädt eine spezifische Relation der angegebenen Entity.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	String	Ja	Name der Entity
relationId	String	Ja	Name der Relation die geladen werden soll

getRelations

Lädt alle Relationen der angegebenen Entity.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	String	Ja	Name der Entity

getAttributes

Lädt alle Attribute der angegebenen Entity.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	String	Ja	Name der Entity

getFieldInfo

Liefert diverse Informationen für das angegebene Feld zurück. Darunter ist die Definition des Felds an sich, die Entity Definition und ob das Feld direkt an der angegebenen Entity liegt oder vererbt wurde.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entityIdOrName	String	Ja	Name oder Id der Entity
fieldIdOrName	String	Ja	Name oder Id des Feldes

Beispiel

Dieses Beispiel sucht für die Entity NotificationRule Informationen über das Feld id aus dem Model. Da id von der KolibriEntity vererbt wird, gibt own hier beispielsweise false zurück.

const fieldInfo = ks.model.getEntitiesLocalized('NotificationRule', 'id');
console.log(fieldInfo.entity.name); // 'NotificationRule'
console.log(fieldInfo.field.name); // 'id'
console.log(fieldInfo.own); // false

getFields

Lädt alle Felder der angegebenen Entity oder alle die unter dem angegebenen Namen gefunden werden können.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	String	Ja	Name der Entity
name	String	Nein	Optionaler Name des Felds

getFieldsLocalized

Lädt alle Felder der angegebenen Entity oder alle die unter dem angegebenen Namen gefunden werden können. Hier ist der Name jedoch nicht der technische Name, sondern der übersetzte Name. Analog zu getEntitiesLocalized.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	String	Ja	Name der Entity
name	String	Nein	Optionaler Name des Felds

getField

Lädt ein spezifisches Feld der angegeben Entity. Der Name ist dabei der technische Name des Felds aus dem Designer.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	String	Ja	Name der Entity
nameWithDotWalk	String	Ja	Name des Felds

getView

Lädt die Definition der View mit dem angegebenen Namen oder der Id.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
nameOrId	String	Ja	Name der View

findDescendants

Lädt alle Entitydefinitionen die von der angegebenen Entity abgeleitet wurden.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	Objekt	Ja	Entitydefinition für die die Ableitungen geladen werden sollen

getGlobalScripts

Lädt alle GlobalScript aus dem aktuellen Model. Optional kann das Ergebnis auch anhand des Typen (server-side, client-side oder both) eingeschränkt werden.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
type	String	Nein	Type des GlobalScripts

getFieldType

Sucht anhand des Felds den zugehörigen Typen aus dem Model.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
field	Objekt	Ja	Felddefinition für die der Type geladen werden soll