com.gmcb.plandk3.server

Interface Pdk3WsInterface

All Known Implementing Classes:

Pdk3Ws

public interface Pdk3WsInterface

Dette interface specificerer alle metoder som publiceres på Pdk3 SOAP-snitfladen til PlanSystem DK.
Metoder på Pdk3 snitfladen kan grupperes efter følgende:

Plandata Læse indhold af planer Oprette/opdatere/slette planer

Administration af brugere Få information om eksisterende brugere Oprette/nedlægge/ændre brugere

Administration af brugeres rettigheder Få information om eksisterende brugeres rettigheder Administrere brugeres rettigheder

Administrere email-abonnenter Få information om eksisterende email-abonnenter Tilføje/fjerne/ændre email-abonnenter

Metadata og diverse Få beskrivelser af data, data-strukturer og program-version.

Nedenstående liste giver en generel beskrivelse af alle input-parametre til metoder på Pdk3 snitfladen. Beskrivelserne af de enkelte metoder vil evt. indeholde yderligere information, såfremt specielle forhold gør sig gældende for en given parameter. Mangler der beskrivelse til en parameter i beskrivelsen af en metode gælder nedenstående tabel:

Type	Navn	Beskrivelse
String	user	Angiver navn på aktuel bruger. Skal altid være til stede.
String	pwd	Angiver adgangskode for aktuel bruger. Skal altid være til stede.
String	targetUser	Angiver navn på en bruger som skal oprettes/slettes/ændres eller for hvilken rettigheder skal ad-ministreres.
String	targetPwd	Angiver password for en bruger som skal oprettes/ændres .
Int	featureType	Angiver objektkode for en plantype. De aktuelt mulige værdier kan findes ved kald af metoden getPlanTypes(). De enkelte plantyper er grupperet i følgende intervaller: 10-99: Pdk2 typer 1100-1199: Pdk3 typer 1200-1299: Diadem typer -1: Kodeværdi som kan benyttes til identification af alle plantyper (wildcard)
Int[]	adminCodes	Angiver en array af kommunenumre.
String	featureId	Angiver numerisk ID for en plan-feature.
String	attributeName	Angiver XML-navn på en attribut i en given plan-feature.
Int	areaNodeId	ID for en node i områdehierarkiet.
Int	privilegeMask	En bitmaske til angivelse af rettigheder i forbindelse med tilføjelse/fjernelse af rettigheder for en bruger. De enkelte bit har følgende betydning: Bit 0: Læse Bit 1: Skrive Bit 2: Slette Bit 3: Admin Bit 4: Email Admin Samtlige rettigheder kan således angives med værdien 31.
Boolean	includeChildren	Angiver hvorvidt en metode som returnerer information om node og node-indhold i område-hierarki skal returnere information om børne-noder (rekursivt).
String[]	Adresses	En array af email-adresser som ønskes tilføjet eller fjernet.

Alle metoder på Pdk3 snitfladen returnerer objekter som er specialiserede udgaver af PdkMethodResult. Som et eksempel herpå kan nævnes, at alle metoder som returnerer GML-data til repræsentation af planer alle returnerer et resultat objekt af typen GmlResult.

PdkMethodResult indeholder en overordnet status-kode for hvorvidt et kald er gået godt eller skidt, samt en liste med evt. status-meddelelser.
Opstår der fejl i forbindelse med kaldet af en metode kan dette derfor nemt afgøres ved inspektion af den overordnede status-kode og årsagerne vil altid fremgå af listen med status-meddelelser.

I tilfælde af SOAP-faults / exceptions, vil der være tale om fejl, som ligger uden for Pdk3-snitfladens kontrol, og som typisk vil kunne relateres til driftsmæssige problemer.

I alle metodekald er user og pwd de to første parametre, og de skal altid identificere en registreret bruger hvormed et givet metode-kald forsøges udført. Kan en bruger,password kombination ikke godkendes af systemet returneres der altid et resultat objekt med følgende indhold:

  
  Status = Status.ERROR
  StatusMessage.code = EXCEPTION
  StatusMessage.message = "Ugyldig bruger og/eller adgangskode!" 
  
 

Bemærk at denne Java-dokumentation er genereret på grundlag af Java-klasser således som de forefindes i service implementationen af Pdk3 snitfladen. Dokumentationen vil derfor kunne omfatte beskrivelser af member-variable, metoder og klasser, som ikke nødvendigvis er tilrådighed i en WSDL-importeret udgave af snitfladen. Læseren bør forholde sig til denne omstændighed.

Method Summary

Modifier and Type	Method and Description
SubscriberResult	addSubscriber(java.lang.String user, java.lang.String pwd, int areaNodeId, int featureType, java.lang.String email, java.lang.String firstName, java.lang.String lastName, java.lang.String organization, boolean required) Tilføjer email-abonnent til område-node for given feature-type.
PrivilegeResult	addUserPrivilege(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, int featureType, int areaNodeId, int privilegeMask) Tilføjer adgangsrettigheder for en bruger for given feature-type under given område-node.
SubscriberResult	changeSubscriber(java.lang.String user, java.lang.String pwd, int areaNodeId, int featureType, java.lang.String targetEmail, java.lang.String email, java.lang.String firstName, java.lang.String lastName, java.lang.String organization, boolean required) Ændrer email-abonnent til område-node for given feature-type.
UserResult	changeUser(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, java.lang.String newUserName, java.lang.String newPwd, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.String organization) Opdaterer informationer for en eksisterende bruger.
FeatureTransactionResult	createNewVersion(java.lang.String user, java.lang.String pwd, java.lang.String gml)
UserResult	createUser(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, java.lang.String targetPwd, int areaNodeId, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.String organization) Opretter ny bruger under given område-node.
FeatureTransactionResult	deleteFeature(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Sletter senest opdaterede version af plan-feature af given type og med givet ID. Hvis der eksisterer børn (og børnebørn) tilknyttet planen vil disse også blive slettet, såfremt dette er muligt.
UserResult	deleteUser(java.lang.String user, java.lang.String pwd, java.lang.String targetUser) Nedlægger en eksisterende bruger og alle vedkommendes adgangsrettigheder.
PrivilegeResult	deleteUserPrivilege(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, int featureType, int areaNodeId, int privilegeMask) Fjerner adgangsrettigheder for en bruger for given feature-type under given område-node.
AccessKeyResult	getAccessKey(java.lang.String user, java.lang.String pwd, java.lang.String clientIP) Henter AccessKeyResult indeholdene en access-key-streng til brug for en anden klient's kald af getCredentials().
AreaInfoResult	getAreaInfo(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren) Henter AreaInfoResult med definition af node eller node-struktur for en given område-node.
AreaInfoResult	getAreaInfoWithPrivileges(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren, java.lang.String targetUser, int featureType) Henter AreaInfoResult med definition af hvilke adgangsrettigheder der findes til en given område-node eller given område-node-struktur for en given bruger og en given feature-type.
AreaInfoResult	getAreaInfoWithSubscribers(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren, int featureType) Henter AreaInfoResult med definition af hvilke email-abonnenter der findes til en given område-node eller given område-node-struktur for en given feature-type.
AreaInfoResult	getAreaInfoWithUsers(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren) Henter AreaInfoResult med definition af hvilke brugere der findes til en given område-node eller indenfor en given område-node-struktur.
AreaNodeTypesResult	getAreaNodeTypes(java.lang.String user, java.lang.String pwd) Henter AreaNodeTypesResult indeholdende informationer om de område-node-typer som Pdk3 snitfladen understøtter.
AreaTypesResult	getAreaTypes(java.lang.String user, java.lang.String pwd) Henter AreaTypesResult indeholdende informationer om hvilke område-typer Pdk3 snitfladen understøtter.
GmlResult	getChildrenByParentId(java.lang.String user, java.lang.String pwd, int parentFeatureType, int childFeatureType, java.lang.String parentFeatureId, java.lang.String[] attributes) Henter GmlResult som indeholder senest opdaterede versioner af plan-features af given type, for en given moder-plan.
CredentialsResult	getCredentials(java.lang.String accessKey) Henter CredentialsResult indeholdende brugernavn,password for en tidligere tilvejebragt access-key-streng vha.
EmailInfoResult	getEmailInfo(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Henter EmailInfoResult indeholdende informationer vedrørende email-udsendelse for given plan.
FeatureInfoResult	getFeatureAttributeInfo(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String attributeName) Henter FeatureInfoResult indeholdende informationer om en enkelt eller alle attributter for en given plan-feature-type.
GmlResult	getFeatureAttributesByAdminCodes(java.lang.String user, java.lang.String pwd, int featureType, int[] adminCodes, java.lang.String[] attributes) Henter GmlResult med senest opdaterede versioner af plan-features af given type, som tilhører et udvalg af administrative enheder (kommuner/områder). Der afleveres kun attribut-data for specificerede attributter - hermed kan størrelse af returneret GML reduceres. Bemærk at der altid leveres "påkrævne" attributter, således at den afleverede GML altid er skema-valid.
GmlResult	getFeatureByAdminCodes(java.lang.String user, java.lang.String pwd, int featureType, int[] adminCodes) Henter GmlResult med senest opdaterede versioner af Plan-features af given type, som tilhører et udvalg af administrative enheder (kommuner/områder).
GmlResult	getFeatureById(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Henter GmlResult med senest opdaterede version af plan-feature af given type og med givet ID.
GmlResult	getFeatureByIdAndPStatus(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.Integer pstatus)
GmlResult	getFeatureByIdAndVersion(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.Integer version)
GmlResult	getFeatureCollection(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String ogcFilter) Henter GmlResult indeholdende plan-features af samme type, som tilfredsstiller et evt.
GmlResult	getFeatureCollectionPaged(java.lang.String user, java.lang.String pwd, int featureType, int startOffset, int count, java.lang.String[] selectAttributes, int[] adminCodes, java.lang.String ogcFilter, java.lang.String[] orderByAttributes, java.lang.String[] descendingAttributes) Hent GmlResult indeholdende et vilkårligt sub-set af et sæt planobjekter, som tilfredsstiller vilkårlige søgekriterier, og som er sorteret efter vilkårlige kriterier.
FeatureCountResult	getFeatureCount(java.lang.String user, java.lang.String pwd, int featureType, int[] adminCodes, java.lang.String ogcFilter) Hent FeatureCountResult som afspejler det maksimale antal planer, som vil blive returneret ved gentagne kald af getFeatureCollectionPaged() for et givet sæt forespørgselskriterier. Se getFeatureCollectionPaged().
FeatureExtentResult	getFeatureExtentById(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Henter FeatureExtentResult som indeholder geografisk udstrækning af senest opdaterede plan-feature af given type og med givet ID.
GmlResult	getFeatureWithinGeometry(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String gml) Henter GmlResult som indeholder senest opdaterede versioner af plan-features af given type, og som er overlappet af geometri angivet i GML-streng.
NewFeatureIdResult	getNewFeatureId(java.lang.String user, java.lang.String pwd, int featureType) Henter NewFeatureIdResult indeholdende et genereret ID til brug for oprettelse af ny plan-feature af given type.
PlanTypesResult	getPlanTypes(java.lang.String user, java.lang.String pwd) Henter PlanTypesResult indeholdende informationer om hvilke plantyper Pdk3 snitfladen understøtter.
ProgramInfoResult	getProgramInfo(java.lang.String user, java.lang.String pwd) Henter ProgramInfoResult indeholdende informationer om aktuel version af Pdk3 servicen og tilhørende database.
SubscribersByAdmincodeResult	getSubscribersByAdminCode(java.lang.String user, java.lang.String pwd, int featureType, int adminCode) Henter SubscribersByAdmincodeResult med definitioner af hvilke email-abonnenter der findes til en given kommune for en given feature-type.
FeatureTransactionResult	modifyVersion(java.lang.String user, java.lang.String pwd, java.lang.String gml)
SubscriberResult	removeSubscribers(java.lang.String user, java.lang.String pwd, int areaNodeId, int featureType, java.lang.String[] adresses) Fjerner email-abonnenter fra given område-node for given feature-type.
FeatureTransactionResult	saveFeature(java.lang.String user, java.lang.String pwd, java.lang.String gml)
FeatureTransactionResult	saveFeatureAndNotify(java.lang.String user, java.lang.String pwd, java.lang.String gml, java.lang.String[] adresses) Gemmer (opretter/opdaterer) en enkelt plan-feature i henhold til data indeholdt i GML-streng, men til forskel fra saveFeature metoden, kan email-udsendelse til en række abonnenter undertrykkes.
FeatureTransactionResult	saveFeatureValidate(java.lang.String user, java.lang.String pwd, boolean validateDraft, java.lang.String gml) Gemmer (opretter/opdaterer) plan-features i henhold til data indeholdt i GML-streng.
SendEmailResult	sendEmailByPlanId(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.String tilStatus, java.lang.String subject, java.lang.String body, java.lang.String[] includeAdresses, java.lang.String[] excludeAdresses) Sender email til abonnenter for en given plan's status-skift og returnér SendEmailResult med information om udsendte emails.
UserResult	setUserPassword(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, java.lang.String targetPwd) Ændrer password for en eksisterende bruger.
FeatureTransactionResult	testPlanStatusChange(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.String newState) Tester om en given plan (og børneplaner) kan opdateres til en angiven status.
ValidateGmlResult	validateGML(java.lang.String user, java.lang.String pwd, java.lang.String gml) Kontrollerer validitet af en GML-streng indeholdende plan-features i henhold til GML-skemaer i PlansystemDK.

Method Detail

getProgramInfo

ProgramInfoResult getProgramInfo(java.lang.String user,
                                 java.lang.String pwd)
                          throws java.lang.Exception

Henter ProgramInfoResult indeholdende informationer om aktuel version af Pdk3 servicen og tilhørende database.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

PropgramInfoResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getPlanTypes

PlanTypesResult getPlanTypes(java.lang.String user,
                             java.lang.String pwd)
                      throws java.lang.Exception

Henter PlanTypesResult indeholdende informationer om hvilke plantyper Pdk3 snitfladen understøtter.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

PlanTypesResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getAreaTypes

AreaTypesResult getAreaTypes(java.lang.String user,
                             java.lang.String pwd)
                      throws java.lang.Exception

Henter AreaTypesResult indeholdende informationer om hvilke område-typer Pdk3 snitfladen understøtter.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

AreaTypesResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getAreaNodeTypes

AreaNodeTypesResult getAreaNodeTypes(java.lang.String user,
                                     java.lang.String pwd)
                              throws java.lang.Exception

Henter AreaNodeTypesResult indeholdende informationer om de område-node-typer som Pdk3 snitfladen understøtter.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

AreaNodeTypesResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureAttributeInfo

FeatureInfoResult getFeatureAttributeInfo(java.lang.String user,
                                          java.lang.String pwd,
                                          int featureType,
                                          java.lang.String attributeName)
                                   throws java.lang.Exception

Henter FeatureInfoResult indeholdende informationer om en enkelt eller alle attributter for en given plan-feature-type.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

attributeName - Navn på attribut. Er navnet blankt returneres definition af alle attrbibutter.

Returns:

FeatureInfoResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

validateGML

ValidateGmlResult validateGML(java.lang.String user,
                              java.lang.String pwd,
                              java.lang.String gml)
                       throws java.lang.Exception

Kontrollerer validitet af en GML-streng indeholdende plan-features i henhold til GML-skemaer i PlansystemDK.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

ValidateGmlResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

saveFeature

FeatureTransactionResult saveFeature(java.lang.String user,
                                     java.lang.String pwd,
                                     java.lang.String gml)
                              throws java.lang.Exception

Throws:

java.lang.Exception

createNewVersion

FeatureTransactionResult createNewVersion(java.lang.String user,
                                          java.lang.String pwd,
                                          java.lang.String gml)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

modifyVersion

FeatureTransactionResult modifyVersion(java.lang.String user,
                                       java.lang.String pwd,
                                       java.lang.String gml)
                                throws java.lang.Exception

Throws:

java.lang.Exception

saveFeatureValidate

FeatureTransactionResult saveFeatureValidate(java.lang.String user,
                                             java.lang.String pwd,
                                             boolean validateDraft,
                                             java.lang.String gml)
                                      throws java.lang.Exception

Gemmer (opretter/opdaterer) plan-features i henhold til data indeholdt i GML-streng.

Hvis den eller de berørte planer skifter status, vil dette medføre at der automatisk udsendes email's til de tilknyttede abonnenter. Dette gælder dog kun for visse plantyper.

Hvis der ikke ønskes udsendt email til alle abonnenter kan metoden saveFeatureAndNotify anvendes i stedet.

Bemærk at der kan gemmes flere plan-features i et enkelt kald til metoden. Hvis en eller flere plan-features derved ikke kan gemmes, vil INGEN af de leverede plan-features blive gemt.

Hvis den/de plan-features som gemmes er af typen kommuneplan, kommuneplantillæg eller lokalplan og der skiftes status, vil dette automatisk medføre at underliggende planer med samme status som den eksisterende plan også vil skifte status - dette afspejles i de FeatureTransaction objekter, som metoden returnerer. Dette medfører ligeledes at status-skift på f.eks. en lokalplan ikke kan udføres hvis de tilhørende lokalplandelområder ikke kan skifte status til den ny status, og det returnerede resultat-objekt vil angive hvilke lokalplandelområder som ikke kan skifte status.

Bemærk at ikke alle underliggende planer nødvendigvis vil blive opdateret. Fx vil en underliggende plan ikke blive opdateret, hvis den er i status kladde og hovedplanen skifter status fra forslag til vedtaget (Se info om behandling af børne-planer herunder). For at teste hvorvidt en plan kan skifte status, kan metoden testPlanStatusChange kaldes.

Behandling af børne-planer er implementeres således:

  Hvis moder-plan skifter status
  For alle børne-planer (lokalplandelområder, kommuneplanrammer og kommuneplantillæg)
  (Hvis NY moder-plan er i status aflyst OG barne-plan ikke er i status kladde eller aflyst)
  ELLER (hvis barne-plan er i samme status som GAMMEL moder-plan 
  OG hvis der ikke er tale om at barne-planen er et kommuneplantillæg)  
  Sæt datoforsl, datovedt og datoaflyst fra moder-plan hvis ikke sat, og behandl barne-plan.
 

Forudsætninger: - Aktuel bruger har skrive-rettighed til hver eneste plan-feature som ønskes opdateret. - Der er tale om valide opdateringer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

validateDraft - om plan skal valideres også i kladde

gml - GML-streng med Plan-features.

Returns:

FeatureTransactionResult med kvitteringer for plan-opdateringer.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

saveFeatureAndNotify

FeatureTransactionResult saveFeatureAndNotify(java.lang.String user,
                                              java.lang.String pwd,
                                              java.lang.String gml,
                                              java.lang.String[] adresses)
                                       throws java.lang.Exception

Gemmer (opretter/opdaterer) en enkelt plan-feature i henhold til data indeholdt i GML-streng, men til forskel fra saveFeature metoden, kan email-udsendelse til en række abonnenter undertrykkes. Se metoden saveFeature for øvrig information.

Forudsætninger: - Aktuel bruger har skrive-rettighed til hver eneste plan-feature som ønskes opdateret. - Der er tale om valide opdateringer. Se metoden saveFeature.

Bemærk: - Der vil altid blive udsendt emails til påkrævede abonennenter uanset om de forefindes i adresses parameteren.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

gml - GML-streng med netop én Plan-feature.

adresses - Array indeholdende email-adresser som IKKE skal notificeres.

Returns:

FeatureTransactionResult med kvitteringer for plan-opdateringer.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

testPlanStatusChange

FeatureTransactionResult testPlanStatusChange(java.lang.String user,
                                              java.lang.String pwd,
                                              int featureType,
                                              java.lang.String featureId,
                                              java.lang.String newState)
                                       throws java.lang.Exception

Tester om en given plan (og børneplaner) kan opdateres til en angiven status.

Det returnerede FeatureTransactionResult vil svare til, hvad man ville få returneret, hvis man forsøgte at gemme en feature med saveFeature, men der vil ALDRIG blive skrevet data i databasen.
Metoden kan således give overblik over hvorvidt en plan (specielt en moder-plan) er klar til at skifte status. Se iøvrigt metoden saveFeature().

Forudsætninger: - Aktuel bruger har skrive-rettighed til hver eneste plan-feature som skal opdateres. - Der er tale om valide opdateringer. Se metoden saveFeature.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - PlanId på plan som skal forsøges gemt

newState - Status som planen skal forsøges at sættes i angives som: "F" = Forslag, "V" = Vedtaget og "A" = Aflyst

Returns:

FeatureTransactionResult indeholdende kvitteringer for plan-opdateringer (de angivne opdateringer er dog ikke blevet udført)

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureByAdminCodes

GmlResult getFeatureByAdminCodes(java.lang.String user,
                                 java.lang.String pwd,
                                 int featureType,
                                 int[] adminCodes)
                          throws java.lang.Exception

Henter GmlResult med senest opdaterede versioner af Plan-features af given type, som tilhører et udvalg af administrative enheder (kommuner/områder).

Forudsætninger: - Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsøges læst.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

adminCodes - Array med identifikationer af administrative enheder.

Returns:

GmlResult med rekvirerede Plan-features.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureAttributesByAdminCodes

GmlResult getFeatureAttributesByAdminCodes(java.lang.String user,
                                           java.lang.String pwd,
                                           int featureType,
                                           int[] adminCodes,
                                           java.lang.String[] attributes)
                                    throws java.lang.Exception

Henter GmlResult med senest opdaterede versioner af plan-features af given type, som tilhører et udvalg af administrative enheder (kommuner/områder).
Der afleveres kun attribut-data for specificerede attributter - hermed kan størrelse af returneret GML reduceres.
Bemærk at der altid leveres "påkrævne" attributter, således at den afleverede GML altid er skema-valid.

Forudsætninger: - Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsøges læst.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

adminCodes - Array med identifikationer af administrative enheder.

attributes - Array med kolonner som skal afleveres. null alle kolonner

Returns:

GmlResult med rekvirerede plan-features.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureById

GmlResult getFeatureById(java.lang.String user,
                         java.lang.String pwd,
                         int featureType,
                         java.lang.String featureId)
                  throws java.lang.Exception

Henter GmlResult med senest opdaterede version af plan-feature af given type og med givet ID.

Forudsætninger: - Aktuel bruger har læse-rettighed til den plan-feature som forsøges læst. - Planen eksisterer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

GmlResult med rekvireret plan-features.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureByIdAndPStatus

GmlResult getFeatureByIdAndPStatus(java.lang.String user,
                                   java.lang.String pwd,
                                   int featureType,
                                   java.lang.String featureId,
                                   java.lang.Integer pstatus)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getFeatureByIdAndVersion

GmlResult getFeatureByIdAndVersion(java.lang.String user,
                                   java.lang.String pwd,
                                   int featureType,
                                   java.lang.String featureId,
                                   java.lang.Integer version)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getFeatureExtentById

FeatureExtentResult getFeatureExtentById(java.lang.String user,
                                         java.lang.String pwd,
                                         int featureType,
                                         java.lang.String featureId)
                                  throws java.lang.Exception

Henter FeatureExtentResult som indeholder geografisk udstrækning af senest opdaterede plan-feature af given type og med givet ID.

Hvis featuren ikke har geometri, returneres udstrækning for kommune eller for relevant "moder-plan" hvis en sådan findes. Alternativt returneres udstrækning for Danmark.

Denne metode er implementeret for at kunne tilvejebringe et "default extent" til brug for opstart af SpatialEdit.

Forudsætninger: - Aktuel bruger har læse-rettighed til den plan-feature som forsøges læst. - Planen eksisterer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

FeatureExtent.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getChildrenByParentId

GmlResult getChildrenByParentId(java.lang.String user,
                                java.lang.String pwd,
                                int parentFeatureType,
                                int childFeatureType,
                                java.lang.String parentFeatureId,
                                java.lang.String[] attributes)
                         throws java.lang.Exception

Henter GmlResult som indeholder senest opdaterede versioner af plan-features af given type, for en given moder-plan.

Forudsætninger: - Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsøges læst. - ParentFeatureType er valid, og der findes børneplaner for denne plantype. - ChildFeatureType er valid, og childFeatureType er barn af parentFeatureType.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

parentFeatureType - Identifikation af parent feature-type.

childFeatureType - Identifikation af child feature-type.

parentFeatureId - Identifikation af plan, hvis børn ønskes fundet.

attributes - Optional array med attributter som skal returneres - hvis null returneres alle attributter.

Returns:

GmlResult med rekvirerede plan-features.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureWithinGeometry

GmlResult getFeatureWithinGeometry(java.lang.String user,
                                   java.lang.String pwd,
                                   int featureType,
                                   java.lang.String gml)
                            throws java.lang.Exception

Henter GmlResult som indeholder senest opdaterede versioner af plan-features af given type, og som er overlappet af geometri angivet i GML-streng.

Et eksempel på en input GML-streng indeholdende geometri er vist herunder:

  
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <gml:polygonProperty xmlns:gml="http://www.opengis.net/gml">
    <gml:Polygon srsName='epsg:25832'>
      <gml:outerBoundaryIs>
        <gml:LinearRing>
          <gml:coordinates>545000,6150000 546000,6150000 546000,6151000 545000,6151000 545000,6150000</gml:coordinates>
        </gml:LinearRing>
      </gml:outerBoundaryIs>
    </gml:Polygon>
  </gml:polygonProperty>
  
 

Forudsætninger: - Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsøges læst.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

gml - GML-streng med geometri.

Returns:

GmlResult med rekvirerede med plan-features.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureCollection

GmlResult getFeatureCollection(java.lang.String user,
                               java.lang.String pwd,
                               int featureType,
                               java.lang.String ogcFilter)
                        throws java.lang.Exception

Henter GmlResult indeholdende plan-features af samme type, som tilfredsstiller et evt. OGC-søge-filter.

Et eksempel på en XML-streng indeholdende et OGC-filter, som finder forekomster hvor cvr_kode matcher værdien 60183112, er vist herunder:

 
 <ogc:Filter xmlns:ogc="http://www.opengis.net/ogc">
   <PropertyIsEqualTo>
     <PropertyName>cvr_kode</PropertyName>
     <Literal>60183112</Literal>
   </PropertyIsEqualTo>
 </ogc:Filter> 
 
 

Bemærk at OGC-filtre fortolkes uden hensyn til namespace-definitioner på Pdk3-snitfladen. Anvendelsen af prefixet "ogc:" i ovenstående er derfor i princip overflødigt.

Mere information om OGC-filter kan findes på:

http://www.opengeospatial.org/standards/filter

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

ogcFilter - XML-repræsentation af et OGC-filter med hvilket features kan afgrænses. Kan være null eller tom.

Returns:

GmlResult med rekvirerede med plan-features.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureCollectionPaged

GmlResult getFeatureCollectionPaged(java.lang.String user,
                                    java.lang.String pwd,
                                    int featureType,
                                    int startOffset,
                                    int count,
                                    java.lang.String[] selectAttributes,
                                    int[] adminCodes,
                                    java.lang.String ogcFilter,
                                    java.lang.String[] orderByAttributes,
                                    java.lang.String[] descendingAttributes)
                             throws java.lang.Exception

Hent GmlResult indeholdende et vilkårligt sub-set af et sæt planobjekter, som tilfredsstiller vilkårlige søgekriterier, og som er sorteret efter vilkårlige kriterier. Det kan endvidere angives præcist hvilke attributter, som ønskes returneret for de pågældende planobjekter, uanset om attributterne er påkrævede i forhold til GML-skemaet for plantypen. Metoden vil derfor potentielt kunne returnere GML-data, som ikke er GML-skema valide.

En forudsætning for, at metoden skal returnere meningsfulde og sammenhængende resultater henover flere på hinanden følgende kald er, at kun startOffset og count justeres mellem de enkelte kald. I et typisk scenarie vil count holdes konstant, mens startOffset inkrementeres med count, indtil der returneres et resultat, som indeholder færre end count objekter.

I princip vil denne metode kunne benyttes på en måde, så den kan udføre præcist det samme, som hver af de følgende eksisterende metoder på SOAP-snitfladen: getChildrenByParentId() getFeatureAttributesByAdminCodes() getFeatureByAdminCodes() getFeatureById() getFeatureCollection() getFeatureWithinGeometry()

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

startOffset - Offset til 1. række i result-set, som skal returneres.

count - Maximalt antal rækker som skal returneres fra result-set. Med værdien 0 vil alle rækker blive returneret.

selectAttributes - Array med navne på netop de attributter, som ønskes returneret for de enkelte objekter i det returnerede GML-dokument. Kan være null eller tom, hvis alle attributter ønskes returneret.

adminCodes - Array med identifikationer af administrative enheder, som de returnerede objekter skal tilhøre. Kan være null eller tom, hvis der ikke skal udvælges objekter i forhold til deres administrative tilhørsforhold. For visse plantypers vedkommende fremgår administrativt tilhørsforhold ikke af GML-attributter i GML-skemaet. For disse typers vedkommende er det specielt relevant at afgrænse dette tilhørsforhold vha. af denne parameter. adminCodes kan dog angives for alle plantyper uanset dette forhold.

ogcFilter - Et OGC-filter i XML-form, hvormed der kan angives yderligere kriterier for de returnerede objekter, f.eks. geografisk afgrænsning. Kan være null. Med et OGC-filter kan der kun filtreres på de GML-attributter, som GML-skemaet for den pågældende plantype indeholder. Et OGC-filter minder i sin funktion meget om en SQL-where klausul, men det er i modsætning hertil ikke knyttet til en speciel SQL-dialekt.

orderByAttributes - Array med navne på alle de attributter, hvormed de returnerede objekter skal sorteres. Kan være null eller tom, såfremt returnerede objekter blot skal sorteres stigende på deres ID. Der kan sorteres på alle GML-attributter uanset om de er indeholdt i selectAttributes.

descendingAttributes - Array med navne på netop de attributter i orderByAttributes, hvormed der skal sorteres faldende og ikke stigende. Kan være null eller tom, såfremt der blot skal sorteres stigende på alle attributter angivet i orderByAttributes. Kan kun angives såfremt orderByAttributes også er angivet. Må kun indeholde navne, som også forefindes i orderByAttributes.

Returns:

GmlResult med rekvirerede med plan-features.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getFeatureCount

FeatureCountResult getFeatureCount(java.lang.String user,
                                   java.lang.String pwd,
                                   int featureType,
                                   int[] adminCodes,
                                   java.lang.String ogcFilter)
                            throws java.lang.Exception

Hent FeatureCountResult som afspejler det maksimale antal planer, som vil blive returneret ved gentagne kald af getFeatureCollectionPaged() for et givet sæt forespørgselskriterier.
Se getFeatureCollectionPaged().

Parameters:

user - - se getFeatureCollectionPaged().

pwd - - se getFeatureCollectionPaged().

featureType - - se getFeatureCollectionPaged().

adminCodes - - se getFeatureCollectionPaged().

ogcFilter - - se getFeatureCollectionPaged().

Returns:

FeatureCountResult med maximalt antal planer, som tilfredsstiller de givne søgekriterier.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

deleteFeature

FeatureTransactionResult deleteFeature(java.lang.String user,
                                       java.lang.String pwd,
                                       int featureType,
                                       java.lang.String featureId)
                                throws java.lang.Exception

Sletter senest opdaterede version af plan-feature af given type og med givet ID.
Hvis der eksisterer børn (og børnebørn) tilknyttet planen vil disse også blive slettet, såfremt dette er muligt.

Forudsætninger: - Aktuel bruger har slette-rettighed til plan-feature som forsøges slettet. - Plan-feature eksisterer. - Tilstand af plan-feature muliggør sletning. - Børn og børnebørn til planen kan slettes. - Hvis plan-feature har status-egenskab, skal denne være "kladde".

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

FeatureTransactionResult med kvittering for sletning.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getNewFeatureId

NewFeatureIdResult getNewFeatureId(java.lang.String user,
                                   java.lang.String pwd,
                                   int featureType)
                            throws java.lang.Exception

Henter NewFeatureIdResult indeholdende et genereret ID til brug for oprettelse af ny plan-feature af given type.

Forudsætninger: - Aktuel bruger har skrive-rettighed til pgld. plan-feature-type.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

Returns:

NewFeatureIdResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

createUser

UserResult createUser(java.lang.String user,
                      java.lang.String pwd,
                      java.lang.String targetUser,
                      java.lang.String targetPwd,
                      int areaNodeId,
                      java.lang.String firstName,
                      java.lang.String lastName,
                      java.lang.String email,
                      java.lang.String organization)
               throws java.lang.Exception

Opretter ny bruger under given område-node.

Den oprettede bruger vil blive tilknyttet noden identificeret med areaNodeId i område-hierarkiet.

En brugers tilhørsforhold til en node i områdehierarkiet afspejler ikke nødvendigvis det område eller den organisation han er en del af.

Tilhørsforholdet har først og fremmest betydning for, hvem der efterfølgende kan nedlægge eller ændre brugeren igen.

Alle ny-oprettede brugere vil automatisk få tildelt læse-adgang til alle planer i hele landet.

Forudsætninger: - Aktuel bruger har admin-rettighed til den givne område-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal oprettes.

targetPwd - Password for bruger som skal oprettes.

areaNodeId - Identifikation af område-node.

firstName - Brugerens fornavn.

lastName - Brugerens efternavn.

email - Brugerens email adresse.

organization - Brugerens organisation.

Returns:

UserResult med informationer for den oprettede bruger.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

changeUser

UserResult changeUser(java.lang.String user,
                      java.lang.String pwd,
                      java.lang.String targetUser,
                      java.lang.String newUserName,
                      java.lang.String newPwd,
                      java.lang.String firstName,
                      java.lang.String lastName,
                      java.lang.String email,
                      java.lang.String organization)
               throws java.lang.Exception

Opdaterer informationer for en eksisterende bruger.

Forudsætninger: - Aktuel bruger har admin-rettighed til targetUser's område-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal ændres.

newUserName - Brugerens nye initialer.

newPwd - Brugerens nye password.

firstName - Brugerens nye fornavn.

lastName - Brugerens nye efternavn.

email - Brugerens nye email-adresse.

organization - Brugerens nye organisation.

Returns:

UserResult med informationer for den opdaterede bruger.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

deleteUser

UserResult deleteUser(java.lang.String user,
                      java.lang.String pwd,
                      java.lang.String targetUser)
               throws java.lang.Exception

Nedlægger en eksisterende bruger og alle vedkommendes adgangsrettigheder.

Forudsætninger: - Aktuel bruger har admin-rettighed til den givne område-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal nedlægges.

Returns:

UserResult med informationer for den nedlagte bruger.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

setUserPassword

UserResult setUserPassword(java.lang.String user,
                           java.lang.String pwd,
                           java.lang.String targetUser,
                           java.lang.String targetPwd)
                    throws java.lang.Exception

Ændrer password for en eksisterende bruger.

Forudsætninger: - Aktuel bruger har admin-rettighed til område-node for den pgld. bruger.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal have ændret password.

targetPwd - Brugerens nye password.

Returns:

UserResult med informationer for den opdaterede bruger.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

addUserPrivilege

PrivilegeResult addUserPrivilege(java.lang.String user,
                                 java.lang.String pwd,
                                 java.lang.String targetUser,
                                 int featureType,
                                 int areaNodeId,
                                 int privilegeMask)
                          throws java.lang.Exception

Tilføjer adgangsrettigheder for en bruger for given feature-type under given område-node.

Forudsætninger: - Aktuel bruger har admin-rettighed til den givne område-node. - Aktuel bruger besidder selv de adgangsrettigheder til område-noden som han ønsker at tilføje.

Bemærk: - Der må enten refereres til en specifik feature-type eller til alle feature-typer (vha. -1). Refereres der til alle feature-typer påvirkes evt. adgangsrettigheder til individuelle feature-typer ikke. Refereres der til specifik feature-type påvirkes evt. adgangsrettigheder til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal have tildelt rettigheder.

featureType - Identifikation af feature-type hvortil adgangsrettigheder skal gives.

areaNodeId - Identifikation af område-node hvorpå adgangsrettigheder skal placeres.

privilegeMask - Bit-maske med rettigheder som skal tilføjes.

Returns:

PrivilegeResult med resulterende adgangsrettigheder til plan-typen for brugeren i område-noden.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

deleteUserPrivilege

PrivilegeResult deleteUserPrivilege(java.lang.String user,
                                    java.lang.String pwd,
                                    java.lang.String targetUser,
                                    int featureType,
                                    int areaNodeId,
                                    int privilegeMask)
                             throws java.lang.Exception

Fjerner adgangsrettigheder for en bruger for given feature-type under given område-node.

Forudsætninger: - Aktuel bruger har admin-rettighed til den givne område-node. - Aktuel bruger besidder selv de adgangsrettigheder til område-noden som han ønsker at fjerne.

Bemærk: - Der må enten refereres til en specifik feature-type eller til alle feature-typer (vha. -1). Refereres der til alle feature-typer påvirkes evt. adgangsrettigheder til individuelle feature-typer ikke. Refereres der til specifik feature-type påvirkes evt. adgangsrettigheder til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal have tildelt rettigheder.

featureType - Identifikation af feature-type hvortil adgangsrettigheder skal gives.

areaNodeId - Identifikation af område-node hvorpå adgangsrettigheder skal placeres.

privilegeMask - Bit-maske med rettigheder som skal fjernes.

Returns:

PrivilegeResult med resulterende adgangsrettigheder til plan-typen for brugeren i område-noden.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getAreaInfo

AreaInfoResult getAreaInfo(java.lang.String user,
                           java.lang.String pwd,
                           int areaNodeId,
                           boolean includeChildren)
                    throws java.lang.Exception

Henter AreaInfoResult med definition af node eller node-struktur for en given område-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af område-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

Returns:

AreaInfoResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getAreaInfoWithUsers

AreaInfoResult getAreaInfoWithUsers(java.lang.String user,
                                    java.lang.String pwd,
                                    int areaNodeId,
                                    boolean includeChildren)
                             throws java.lang.Exception

Henter AreaInfoResult med definition af hvilke brugere der findes til en given område-node eller indenfor en given område-node-struktur.

Forudsætninger: - Aktuel bruger har admin-rettighed til den givne område-node.

Bemærk: - Der returneres kun område-struktur for de dele af den komplette node-struktur som har tilknyttet brugere.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af område-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

Returns:

AreaInfoResult med tilknyttede brugere.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getAreaInfoWithPrivileges

AreaInfoResult getAreaInfoWithPrivileges(java.lang.String user,
                                         java.lang.String pwd,
                                         int areaNodeId,
                                         boolean includeChildren,
                                         java.lang.String targetUser,
                                         int featureType)
                                  throws java.lang.Exception

Henter AreaInfoResult med definition af hvilke adgangsrettigheder der findes til en given område-node eller given område-node-struktur for en given bruger og en given feature-type.

Forudsætninger: - Aktuel bruger har admin-rettighed til den givne område-node.

Bemærk: - Der returneres kun område-struktur for de dele af den komplette node-struktur som har tilknyttet adgangsrettigher af given beskaffenhed.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af område-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

Returns:

AreaInfoResult med tilknyttede adgangsrettigheder.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getAreaInfoWithSubscribers

AreaInfoResult getAreaInfoWithSubscribers(java.lang.String user,
                                          java.lang.String pwd,
                                          int areaNodeId,
                                          boolean includeChildren,
                                          int featureType)
                                   throws java.lang.Exception

Henter AreaInfoResult med definition af hvilke email-abonnenter der findes til en given område-node eller given område-node-struktur for en given feature-type.

Forudsætninger: - Aktuel bruger har admin-rettighed eller email-admin-rettighed til den givne område-node.

Bemærk: - Bemærk at der kun returneres område-struktur for de dele af den komplette node-struktur som har tilknyttet abonnenter for pgld. feature-type.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af område-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

featureType - Feature-type for hvilken der findes abonnenter.

Returns:

AreaInfoResult med tilknyttede email-abonnenter.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getSubscribersByAdminCode

SubscribersByAdmincodeResult getSubscribersByAdminCode(java.lang.String user,
                                                       java.lang.String pwd,
                                                       int featureType,
                                                       int adminCode)
                                                throws java.lang.Exception

Henter SubscribersByAdmincodeResult med definitioner af hvilke email-abonnenter der findes til en given kommune for en given feature-type.

Forudsætninger: - Aktuel bruger har admin-rettighed eller email-admin-rettighed til den pgld. kommune.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Feature-type for hvilken der findes abonnenter.

adminCode - Kommunenr. for hvilken der findes abonnenter.

Returns:

SubscribersByAdmincodeResult med liste af email-abonnenter.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

addSubscriber

SubscriberResult addSubscriber(java.lang.String user,
                               java.lang.String pwd,
                               int areaNodeId,
                               int featureType,
                               java.lang.String email,
                               java.lang.String firstName,
                               java.lang.String lastName,
                               java.lang.String organization,
                               boolean required)
                        throws java.lang.Exception

Tilføjer email-abonnent til område-node for given feature-type.

Forudsætninger: - Aktuel bruger har admin-rettighed eller email-admin-rettighed til den givne område-node.

Bemærk: - Der må enten refereres til en specifik feature-type eller til alle feature-typer (vha. -1). Refereres der til alle feature-typer påvirkes email-abonnenter til individuelle feature-typer ikke. Refereres der til specifik feature-type påvirkes email-abonnenter til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af område-node.

featureType - Feature-type for hvilken abonnenter skal tilføjes.

email - Abonnents email-adresse.

firstName - Abonnents fornavn.

lastName - Abonnents efternavn.

organization - Abonnents organization.

required - Flag for hvorvidt email udsendelse skal være påkrævet.

Returns:

SubscriberResult med definition af område-noden og hvilke email-abonnenter den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

changeSubscriber

SubscriberResult changeSubscriber(java.lang.String user,
                                  java.lang.String pwd,
                                  int areaNodeId,
                                  int featureType,
                                  java.lang.String targetEmail,
                                  java.lang.String email,
                                  java.lang.String firstName,
                                  java.lang.String lastName,
                                  java.lang.String organization,
                                  boolean required)
                           throws java.lang.Exception

Ændrer email-abonnent til område-node for given feature-type.

Forudsætninger: - Aktuel bruger har admin-rettighed eller email-admin-rettighed til den givne område-node.

Bemærk: - Der må enten refereres til en specifik feature-type eller til alle feature-typer (vha. -1). Refereres der til alle feature-typer påvirkes email-abonnenter til individuelle feature-typer ikke. Refereres der til specifik feature-type påvirkes email-abonnenter til alle feature-typer ikke. - Metoden kan IKKE benyttes hvis der er tilknyttet en bruger til email-abonnenten - hvis dette er tilfældet skal metoden changeUser i stedet anvendes.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af område-node.

featureType - Feature-type for hvilken abonnenter skal tilføjes.

targetEmail - Abonnents email-adresse.

email - Abonnents nye email-adresse.

firstName - Abonnents nye fornavn.

lastName - Abonnents nye efternavn.

organization - Abonnents nye organization.

required - Flag for hvorvidt email udsendelse skal være påkrævet.

Returns:

SubscriberResult med definition af område-noden og hvilke email-abonnenter den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

removeSubscribers

SubscriberResult removeSubscribers(java.lang.String user,
                                   java.lang.String pwd,
                                   int areaNodeId,
                                   int featureType,
                                   java.lang.String[] adresses)
                            throws java.lang.Exception

Fjerner email-abonnenter fra given område-node for given feature-type.

Forudsætninger: - Aktuel bruger har admin-rettighed til den givne område-node, eller han har dels har email-admin-rettighed til noden, men har også selv tidligere tilføjet de pgld. abonnenter til noden.

Bemærk: - Der må enten refereres til en specifik feature-type eller til alle feature-typer (vha. -1). Refereres der til alle feature-typer påvirkes email-abonnenter til individuelle feature-typer ikke. Refereres der til specifik feature-type påvirkes email-abonnenter til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af område-node.

featureType - Feature-type for hvilken abonnenter skal tilføjes.

adresses - Array med email-adresser som skal fjernes.

Returns:

SubscriberResult med definition af område-noden og hvilke email-abonnenter den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getAccessKey

AccessKeyResult getAccessKey(java.lang.String user,
                             java.lang.String pwd,
                             java.lang.String clientIP)
                      throws java.lang.Exception

Henter AccessKeyResult indeholdene en access-key-streng til brug for en anden klient's kald af getCredentials(). Bemærk at den returnerede nøgle KUN kan anvendes af en klient som har den IP-adresse som specificeres i parametren clientIp. Den returnerede nøgle udløber efter 120 sekunder.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

clientIP - IP-adresse på den klient som skal benytte den returnerede accessKey

Returns:

AccessKeyResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getCredentials

CredentialsResult getCredentials(java.lang.String accessKey)
                          throws java.lang.Exception

Henter CredentialsResult indeholdende brugernavn,password for en tidligere tilvejebragt access-key-streng vha. getAccessKey().

Parameters:

accessKey - Den nøgle som blev afleveret fra getAccessKey.

Returns:

CredentialsResult med brugernavn,password.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

getEmailInfo

EmailInfoResult getEmailInfo(java.lang.String user,
                             java.lang.String pwd,
                             int featureType,
                             java.lang.String featureId)
                      throws java.lang.Exception

Henter EmailInfoResult indeholdende informationer vedrørende email-udsendelse for given plan.

Forudsætninger: - Aktuel bruger har admin-adgang til den plan-feature som der forsøges læst email informationer for. - Planen eksisterer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

EmailInfoResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.

sendEmailByPlanId

SendEmailResult sendEmailByPlanId(java.lang.String user,
                                  java.lang.String pwd,
                                  int featureType,
                                  java.lang.String featureId,
                                  java.lang.String tilStatus,
                                  java.lang.String subject,
                                  java.lang.String body,
                                  java.lang.String[] includeAdresses,
                                  java.lang.String[] excludeAdresses)
                           throws java.lang.Exception

Sender email til abonnenter for en given plan's status-skift og returnér SendEmailResult med information om udsendte emails.

Forudsætninger: - Aktuel bruger har skrive-adgang til den pgld. plan-feature. - Planen eksisterer. - Der har været udsendt emails i forbindelse med det specificerede statusskift / seneste statusskift.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

tilStatus - Optional identifikation statusskift: "F" = Forslag, "V" = Vedtaget og "A" = Aflyst. Der udsendes email for seneste statusskift hvis denne parameter er null.

subject - Emne felt til email'en.

body - Indhold af email - Kan være tekst eller HTML formateret.

includeAdresses - Adresser som der yderligere skal sendes til.

excludeAdresses - Adresser som der oprindeligt blev sendt til, men som der ikke skal sendes til igen i denne omgang.

Returns:

SendEmailResult.

Throws:

java.lang.Exception - I tilfælde af en Pdk3-ekstern exception.