1. INNHOLDSFORTEGNELSE

Transkript

1

2 1. INNHOLDSFORTEGNELSE 1 INNHOLDSFORTEGNELSE OM BRUKERMANUALEN Kapittel beskrivelse INTRODUKSJON OVERSIKT BESKRIVELSE AV FUNKSJONER GetCategory GetCategoryType GetInterviewDefinition SaveInterview SaveAnswer BESKRIVELSE AV OBJEKTER AnswerTypeObject AnswerSetObject QuestionObject InterviewDefinitionObject CategoryObject VEILEDNING FOR SERVICEINTERVIEW Login GetCategory GetCategoryType GetInterviewDefinition SaveInterview SaveAnswer

3 2. OM BRUKERMANUALEN Denne brukermanualen forklarer hvordan Web-Servicen ServiceInterview funger, og hvordan den skal brukes. 2.1 Kapittel beskrivelse 2 - Om brukermanualen Beskrivelse av brukermanualen og dens oppbygning 3 Introduksjon Beskrivelse av webservicen og dens funkjonalitet 4 Oversikt En liten oversikt over webservicen og dens funksjoner 5 Beskrivelse av funksjoner Beskrivelse av ServiceInterviews forskjellige funksjoner, parametere og returdata. 6 Beskrivelse av objekter En beskrivelse av klassene som blir brukt av ServiceInterview, som bl.a returdata. 7 Veiledning for ServiceInterview En veiledning på hvordan en kan bruke webservicen i en klientapplikasjon, og hente data fra returverdiene ServiceInterview returnerer. 3

4 3. INTRODUKSJON ServiceInterview er en Web Service, og er utviklet som et avsluttende hovedprosjekt av Henrik Hesland som går Bachelor Datateknikk, og Petri Wilhelmsen som går Bachelor Informasjonsteknologi på Høgskolen i Oslo, Vår GetInterviewDefinition inneholder hovedsaklig funksjoner og objekter som benyttes til å hente intervjuer fra- og lagre intervjuer til ISAPs databaser. Klassen kan brukes som et mellomledd der andre ønsker å lage egene programmer framfor ISAPs alleredende eksisterende besvarelsesløsninger, for å besvare et intervju. 4

5 4. OVERSIKT Denne modellen viser hvilke funkjsoner som eksisterer i ServiceInterview. Disse vil bli forklart nærmere i kapittel 4. Dette er klassene som er definert i ServiceInterview. Her ser vi at AnswerTypeObject klassen blir brukt i AnswerSetObject, som igjen blir brukt i QuestionObject. QuestionObject blir brukt i InterviewDefinitionObject. CategoryObject er ikke realtert til noen klasser, men alle klassene brukes i ServiceInterviews funkjsoner, og som returverdier. Disse klassene blir nærmere forklart i kapittel 5. 5

6 5. BESKRIVELSE AV FUNKSJONER Her kommer en beskrivelse for bruken av hver funksjon. 5.1 GetCategory Funksjonsnavn: GetCategory Parameter Type Beskrivelse ConnectString String En innloggingsnøkkel som logginn-funksjonen returnerer ved gyldig innlogging Beskrivelse: Funksjonen tester om ConnectString er gyldig, og henter alle kategoriene som eksisterer i databasen. Disse legges inn i objekter av CategoryObject-klassen. Returdata: En array av CategoryObject-objekter. 5.2 GetCategoryType Funksjonsnavn: GetCategoryType Parameter Type Beskrivelse ConnectString String En innloggingsnøkkel som logginn-funksjonen returnerer ved gyldig 6

7 innlogging CategoryID Integer Iden til en kategori i databasen Beskrivelse: Funksjonen tester om ConnectString er gyldig, og henter alle kategoriheaderne (kapitlene) ut fra hvilken kategori de tilhører (bestemt ved CategoryID). Returdata: En array av CategoryObject-objekter. Siden categorytype- og category-dataen er det samme, kan vi fortsette å bruke CategoryObjectklassen. 5.3 GetInterviewDefinition Funksjonsnavn: GetInterviewDefinition Parameter Type Beskrivelse ConnectString String En innloggingsnøkkel som logginn-funksjonen returnerer ved gyldig innlogging idcategory Integer Iden til en kategori i databasen idhead Integer Iden til en header/kapittel i databasen Beskrivelse: Funksjonen tester om ConnectString er gyldig, og bruker idcategory og idhead til å lete i databasen etter riktig intervjudefinisjon. Da denne er funnet lagres dataen i et InterviewDefinitionObject. Returdata: InterviewDefinitionObject som blir generert. 7

8 5.4 SaveInterview Funksjonsnavn: SaveInterview Parameter Type Beskrivelse ConnectString String En innloggingsnøkkel som logginn-funksjonen returnerer ved gyldig innlogging idcategory Integer Iden til en kategori i databasen idhead Integer Iden til en header/kapittel i databasen idarea Integer Forklarer hvor intervjuet skal bli lagret i databasen Period Integer Et 4sifret tall som beskriver hvilken periode intervjuet blir besvart i Position String Stillingen besvareren har Person String Besvarerens navn Beskrivelse: Funksjonen tester om ConnectString er gyldig, for så å bruke parameterverdiene til å generere et intervju i databasen. Returdata: Integer, som er iden til det nye intervjuet. 8

9 5.5 SaveAnswer Funksjonsnavn: SaveAnswer Parameter Type Beskrivelse ConnectString String En innloggingsnøkkel som logginn-funksjonen returnerer ved gyldig innlogging iinterviewid Integer Iden på det gjeldende intevjuet svaret skal bli registrert i lcurrentquestionindex Integer Hvilket spørsmål i intevjuet svaret skal bli registrert på answersetid1 Integer Iden på svarsettet answer1 skal lagres i answer1 Integer Svaret brukeren har valgt answersetid2 Integer Iden på svarsettet answer2 skal lagres i answer2 Integer Svaret brukeren har valgt answersetid3 Integer Iden på svarsettet answer3 skal lagres i answer3 Integer Svaret brukeren har valgt answersetid4 Integer Iden på svarsettet answer4 skal lagres i answer4 Integer Svaret brukeren har valgt Beskrivelse: Funksjonen tester om ConnectString er gyldig, tar imot hvilket intervju og spørsmål besvarelsen er gjort på via iinterviewid og lcurrentquestionindex. Deretter går den igjennom spørsmplets svarsett( opp til 3 stk ) og lagrer de tilhørende svarene i hvert svarsett. Returdata: Boolean, som returnerer True hvis svaret ble registrert, ellers false. 9

10 6. BESKRIVELSE AV OBJEKTER Her beskriver vi hvordan objektene som retureres fra ServiceInterview er bygget opp. 6.1 AnswerTypeObject Denne klassen inneholder: Beskrivelse: Inneholder et svar alternativ for et svar sett. Inneholder Get/Set metoder for å hente/skrive til variablene. 6.2 AnswerSetObject Denne klassen inneholder: 10

11 Beskrivelse: Inneholder et SvarSett objekt, med opp til 5 svar, dvs 5 objekter av AnswerTypeObject. Inneholder Get/Set metoder for å hente/skrive til variablene. answertypes har to Get/Set metoder, en for å hente alle, og en for å lagre over answertypes(index) gitt en index som forteller hvor i arrayen du vil lagre til. 6.3 QuestionObject Denne klassen inneholder: Beskrivelse: Inneholder et spørsmål. Inneholder Get/Set metoder for å hente/skrive til variablene. answersets(5) er en array av AnswerSetObjecter, som inneholder spørsmålets svarsett. Id er spørsmålets id, _questionname er spørsmålsteksten. 11

12 6.4 InterviewDefinitionObject Denne klassen inneholder: Beskrivelse: Inneholder en array med alle intervjuets spørsmål. Inneholder Get/Set metoder for å hente/skrive til variablene. currentindex blir brukt til å legge til spørsmål i spørsmåls arrayen, slik at de kommer i rett rekkefølge. _count sier hvor mange spørsmål det er i intervjuetdefinisjonen. Returneres av funksjonen GetInterviewDefinition. 12

13 6.5 CategoryObject Denne klassen inneholder: Beskrivelse: Denne klassen blir brukt for å lagre informasjon om kategori og header/kapittel. Returneres av funksjonene GetCategory og GetCategoryType. 13

14 7. VEILEDNING FOR SERVICEINTERVIEW Beskrive hvordan en kan bruke klassene, lage instanser av dem og hente data fram dem. Nå skal vi ta for oss hvordan funkjsonene og klassene i ServiceInterview kan bli brukt i en applikasjon. 7.1 Login Først må vi lage en web referanse til ServiceInterview, som ligger på ISAPOpens server. Vi kan f.eks gi referansen navnet refserviceinterview. Deretter må vi lage en instanse av ServiceInterview, f.eks med navn si : refserviceinterview.serviceinterview si = new refserviceinterview.serviceinterview(); Nå har vi laget et objekt av ServiceInterview med navnet si. For å kunne bruke ServiceInterviews funkjsoner og klasser, må en først ha en gyldig innloggings nøkkel. Denne kan hentes slik: string ConnectString = si.login( server, username, password, "", "").ConnectString.ToString(); Denne variabelen av typen string kan vi nå bruke som parameter på alle de andre funkjsonene som krever en ConnectString som parameter. 7.2 GetCategory For å finne totalt antall kategorier som ligger på ISAPOpens server, kan vi gjøre følgende: int count = si.getcategory(connectstring).getlength(0); 14

15 (GetLenth(int dimension) er en funkjson som er definert i Array, og er en vanlig funkjson for alle arrays i C#. Funkjsonen returnerer antall elementer i arrayen. GetCategory returnerer en array med CategoryObjecter og kan derfor bruke klassen Array s funkjsonalitet.) For å hente navnet og IDen på en kategori som eksisterer som indeks 0 i retur-arrayen, kan en gjøre følgende: string name = si.getcategory(connectstring)[0].name; string id = si.getcategory(connectstring)[0].id; 7.3 GetCategoryType For å finne totalt antall kapittler som ligger på ISAPOpens server gitt en kategoriid, kan vi gjøre følgende: int count = si.getcategorytype(connectstring, kategoriid).getlength(0); Vi kan også her hente data fra GetCategoryType på samme måte som GetCategory: sgi.getcategorytype(connectstring,kategoriid))[0].name sgi.getcategorytype(connectstring,kategoriid))[0].id 7.4 InterviewDefinitionObject For å hente en intervjudefinisjon, må vi ha en ConnectString, KategoriID og kapittelid. Vi kan også for enkelhetskyld grunnet mange klassemedlemmer i InterviewDefininitionObject lage et objekt av typen InterviewDefininitionObject som er en klasse i ServiceInterview: refserviceinterview.interviewdefinitionobject ido; ido = si.getinterviewdefinition(connectstring,kategoriid,kapittelid); Vi har nå hentet et intervju med definisjonen kategoriid og kapittelid, og lagret den i ido. Vi kan bruke ido videre for å hente ut data om intervjuet, dens spørmål, IDer osv. 15

16 Spørsmålene ligger i ido.questions[] og vi kan hente f.eks spørreteksten og andre spørsmålsrelaterte felt fra ido slik: string chapteritem1 = ido.questions[1].chapteritem1; string chapteritem2 = ido.questions[1].chapteritem2; string chapteritem3 = ido.questions[1].chapteritem3; string questionname = ido.questions[1].name; int questionid = ido.questions[1].id; int countanswerset = ido.questions[1].countanswersets; Svarsett og svar typer, og dens data kan hentes slik: int answersetid = ido.questions[1].answersets[1].id; string answersetname = ido.questions[1].answersets[1].name; int answersettypeid ido.questions[1].answersets[1].answertypes[1].id; int answersettypename = ido.questions[1].answersets[1].answertypes[1].name; 7.5 SaveInterview For å lagre et nytt intervju på serveren, må en først lage et ServiceInterview objekt slik vi har gjort tidligere. Denne kan vi bruke til å kalle på funkjsonen SaveAnswer: si.saveinterview(connectstring, catid, headid, areaid, period, position, person); 7.6 SaveAnswer For å lagre et svar trenger en intervjuid, spørsmålsindex, 4 answersets og 4 svar( ett svar for hvert answerset ). Hvis spørmålet har førre enn 4 answersets, kan en sende verdiene -1 til de resterende svarsettene og svarverdiene: bool saved = (bool)sgi.saveanswer(connectstring,intervjuid,spørsmålsindex,answerseti D[0],answer[0],answerSetID[1],answer[1],answerSetID[2],answer[2], answersetid[3],answer[3]); SaveAnswer returnerer true eller false om svaret er lagret eller ikke. Er den true er alt ok, er den false har ikke alt gått som det skal. 16