Objekt-egenskaper tilgjengelig i kodevinduet
Hvilke funksjoner og operasjoner du kan utføre avhenger av hvilke typer objekter du jobber med. Bruk denne oversikten som et forenklet oppslagsverk når du skriver kode i Compose.
Type Objekt tilgjengelig i skript basert på validering
Validering | Type Objekt tilgjengelig i skript |
Tekstbasert validering | |
Tekststreng | java.lang.String |
Heltall | java.math.BigInteger |
Desimal | java.math.BigDecimal |
Dato | DateObj |
Filbasert validering | |
Binær | BinaryFileObj |
PDFFileObj | |
Tekst | TextFileObj |
XML | XMLFileObj |
Datovalidert Objekt (DateObj)
Egenskap | Beskrivelse |
year | Returnerer året som et heltall. |
month | Returnerer måned som et heltall (1-12). |
day | Returnerer dag som et heltall (1-31). |
asString | Tekststreng-representasjon. Tar formen "YYYY-MM-DD". e.g.: 2013-04-01 |
format("Y/MM/DD") | Formaterer datoen etter formatet oppgitt. |
Objekter som representerer filer
Egenskap | Beskrivelse |
filename | Returnerer filnavnet som en Tekststreng. |
contentType | Returnerer innholdstypen som en Tekststreng. |
content.size() | Returnerer størrelsen på innholdet. |
content.bytes() | Returnerer en byte[] relatert til filinnholdet. |
Ytterligere egenskaper avhenger av valideringen til Objektet, altså enten TextFileObj (tekstfiler), XMLFileObj (XML-fil), PDFFileObj (PDF) eller BinaryFileObj (alle filtyper).
TextFileObj (tekstfiler)
Egenskap | Beskrivelse |
encoding | Returnerer koden som en Tekststreng. |
textReader | Returnerer en forekomst av java.io.Reader for innhold til tekstfilen. |
getTextReader("ISO-8859-1") | Returnerer en forekomst av java.io.Reader i den spesifiserte standarden for tekstfilens innhold. |
XMLFileObj (XML-filer)
Egenskap | Beskrivelse |
encoding | Returnerer koden som en Tekststreng. |
textReader | Returnerer en forekomst av java.io.Reader for innhold til tekstfilen. |
getTextReader("ISO-8859-1") | Returnerer en forekomst av java.io.Reader i den spesifiserte standarden for tekstfilens innhold. |
XMLElements | Returnerer en forekomst av org.w3c.dom.Document som representerer XML-filen (Dette eksponerer XML-filen via DOM-API-et) |
XMLStreamReader | Returnerer en forekomst av implementeringen javax.xml.stream.XMLStreamReader som representerer XML-filen (Dette eksponerer XML-filen via StAX-API-et). |
PDFFileObj (PDF-filer)
Egenskap | Beskrivelse |
pdfVersion | Returnerer PDF-versjonen som en Tekststreng. |
BinaryFileObj (alle filtyper)
Ingen ytterligere egenskaper eksisterer for BinaryFileObj utenom de som finnes for FileObj.
Spørsmålsobjekt
Egenskap | Beskrivelse |
question | Returnerer et Objekt med detaljer om spørsmålet. |
Andre tilgjengelige egenskaper avhenger av svarets spørsmålstype. Et spørsmålssvar-objekt kan være en forekomst av enten ValueInputQuestion (tekstbasert svar), SingleSelectQuestion (svar på spørsmål med enkeltvalg), MultiSelectQuestion (svar på spørsmål med flervalg) eller FileQuestion (filbasert svar).
ValueInputQuestion (tekstbasert svar)
Egenskap | Beskrivelse |
answer | Svarets verdi. Avhenger av spørsmålets validering. Kan være en forekomst av BigDecimal, BigInteger, String eller et Dato-Objekt. Svarets verdi kan være null hvis svaret er tomt eller verdien ikke er kompatibel med valideringen. |
SingleSelectQuestion (svar på spørsmål med enkeltvalg)
Egenskap | Beskrivelse |
answer | Returnerer et Objekt som representerer detaljene til det valgte alternativet. Dette kan være null hvis ingen alternativer er valgt. |
Det er anbefalt å bruke syntaks med ?, typ Q21.answer?.value i kontekst av spørsmål med enkeltvalg og flervalg. ? er en Groovy null-sikker operator. Bruken av den forhindrer null-pekere når svaret er null (altså når ingen alternativer er valgt).
MultiSelectQuestion (svar på spørsmål med flervalg)
Egenskap | Beskrivelse |
answers | Liste av valgte alternativer representert som objekter. Listen er tom hvis ingen alternativer er valgt. |
FileQuestion (filbasert svar)
Egenskap | Beskrivelse |
answer | Svarets verdi. Svarets verdi kan være null hvis svaret er tomt eller verdien ikke er kompatibel med valideringen. |
Flere egenskaper for spørsmåls-alternativer
Egenskap | Beskrivelse |
value | Svarverdier som kan være en forekomst av BigDecimal, BigInteger, String eller et Objekt som representerer en dato. |
label.text | Får alternativ-teksten lokalisert i henhold til sluttbrukerens språk. Returnerer en Tekststreng. |
label.getText() | Får alternativ-teksten lokalisert i henhold til sluttbrukerens språk. Returnerer en Tekststreng. |
label.getText("eng") | Får alternativ-teksten lokalisert i henhold til språkkoden spesifisert. Returnerer en Tekststreng. |
Flere egenskaper for spørsmål
Egenskap | Beskrivelse |
id | ID til et spørsmål, f.eks. Q12. |
label.text | Får alternativ-teksten lokalisert i henhold til sluttbrukerens språk. |
label.getText() | Samme resultat som å bruke metoden Q12.question.text. |
label.getText("eng") | Får alternativ-teksten lokalisert i henhold til språkkoden spesifisert. Verdien for standardspråket returneres hvis argumentet er null. |
Skjemaobjekt
Egenskap | Beskrivelse |
id | Returnerer ID-en til skjemaet som en Tekststreng. i.e.: arkivelementets ID. |
version | Returnerer versjonen av skjemaet som en Tekststreng. |
Formatert tekst
Egenskap | Beskrivelse |
plainText | Returnerer teksten uten markeringsspråk. Eks: Q13.question.text.plainText |
html4 | Returnerer teksten med HTML-markeringsspråk. Eks: Q13.question.text.html4 |
markup | Returnerer den originale formaterte teksten med markeringsspråk. Eks: Q13.question.text.markup |
xml | Returnerer den formaterte teksten uten markeringsspråk, så teksten kan brukes i en XML-fil. XML-sensitive tegn blir fjernet. Eks: Q13.question.text.xml |
Objekt for svar på spørsmålsgrupper
Egenskap | Beskrivelse |
groupId | Returnerer ID-en til en spørsmålsgruppe, f.eks. QG1. |
questionAnswers | Returnerer en struktur av spørsmålene direkte under gruppen. Nøkkelen er ID-en til spørsmålsgruppen. Verdien er et Objekt som representerer informasjonen til spørsmålets svar. |
questionGroupAnswers | Returnerer en struktur av spørsmålene på rotnivå. Nøkkelen er ID-en til spørsmålsgruppen. Verdien er en liste av Objekter som representerer informasjonen til spørsmålsgruppens svar. |
Q42 | Returnerer et Objekt som inneholder detaljene relatert til spørsmålet med ID Q42 under den spørsmålsgruppen. |
QG2 | Returnerer en liste med Objekter som inneholder detaljer relatert til spørsmålsgruppen med ID QG2 under den spørsmålsgruppen. |
Dette objektet former i realiteten en trestruktur.
Skjemaobjekt som inn-variabel i tekstgenerator
Egenskap | Beskrivelse |
questionAnswers | Returnerer en struktur av spørsmål på rotnivå. Nøkkelen er ID-en til spørsmålsgruppen. Verdien er et Objekt som representerer informasjonen til spørsmålets svar. |
questionGroupAnswers | Returnerer en struktur av spørsmål på rotnivå. Nøkkelen er ID-en til spørsmålsgruppen. Verdien er en liste av Objekter som representerer informasjonen til spørsmålsgruppens svar. |
form | Returnerer et Objekt som inneholder informasjon om skjemaet. |
Q21 | Returnerer den første instansen av Objektet som inneholder svarinformasjonen til spørsmålet med ID Q21. |
QG1 | Returnerer en liste med Objekter som inneholder detaljer relatert til spørsmålsgruppen med ID QG1. |
Util-Objekter
Egenskap | Beskrivelse |
Util.escapeXml(value) | Eliminerer tegn så verdien (value) kan brukes i en XML-tag. |
Util.escapeHtml4(value) | Eliminerer tegn så verdien (value) kan brukes i et HTML4-dokument. |
Util.currentTime() | Returnerer dato og tidspunkt som en Tekststreng med standardformat: "yyyy-MM-dd HH:mm:ss.SSS". Typisk output kan være: "2020-11-14 15:47:54.365" |
Objekter som representerer brukeragent-informasjon
Egenskap | Beskrivelse |
items | Liste med items som representerer brukeragent-informasjonen. Et item kan være enten et Produkt eller en Kommentar (se oversiktene under). |
text | Returnerer en trimmet versjon av den originale brukeragent-tekststrengen. |
untrimmedText | Returnerer den originale brukeragent-tekststrengen. |
Produkt
Egenskap | Beskrivelse |
name | Returnerer navnet på produktet som en Tekststreng. |
version | Returnerer produktets versjon som en Tekststreng. |
text | Returnerer en trimmet tekstverdi som representerer kjerne-tekststreng-verdien fra den originale brukeragent-tekststrengen. |
untrimmedText | Returnerer en utrimmet tekstverdi som representerer kjerne-tekststreng-verdien fra den originale brukeragent-tekststrengen. |
Kommentar
Egenskap | Beskrivelse |
details | Returnerer en liste med Tekstreng-verdier som representerer kommentaren. |
text | Returnerer en trimmet tekstverdi som representerer kjerne-tekststreng-verdien fra den originale brukeragent-tekststrengen. |
untrimmedText | Returnerer en utrimmet tekstverdi som representerer kjerne-tekststreng-verdien fra den originale brukeragent-tekststrengen. |