Package be.vlaanderen.vip.magda.client.diensten

Class GeefSociaalStatuutRequest

java.lang.Object

be.vlaanderen.vip.magda.client.MagdaRequest

be.vlaanderen.vip.magda.client.diensten.PersonMagdaRequest

be.vlaanderen.vip.magda.client.diensten.GeefSociaalStatuutRequest

public class GeefSociaalStatuutRequest
extends PersonMagdaRequest

A request to a "GeefSociaalStatuut" MAGDA service, which provides information on a given social status for an INSZ. Adds the following fields to the PersonMagdaRequest:

• socialStatusName: the name of the type of social status about which the information is requested
• atDateOfRequest: if true, the date used in the criteria is to be the same as the date used in the Tijdstip/Datum field from the request header. Mutually exclusive with other date parameters.
• date: the date on which the information on the social status was in effect.
• startDate: required, the start date of the period in which the social status was in effect
• endDate: optional, the end date of the period in which the social status was in effect. When not specified, the period is assumed to run until today.
• locationName: the name of the location where the social status was in effect (optional)

The "GeefSociaalStatuut" MAGDA service can be queried by a specific date or by period using "startDate" and/or "endDate".

See Also:

• XML template for this request type
• More information on this request type

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeefSociaalStatuutRequest.Builder

Field Summary

Fields inherited from class be.vlaanderen.vip.magda.client.MagdaRequest

DEFAULT_REGISTRATION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeefSociaalStatuutRequest(@NotNull INSZNumber insz, @NotNull Registration registration, @NotNull String socialStatusName, boolean atDateOfRequest, LocalDate date, LocalDate startDate, LocalDate endDate, String locationName)

Method Summary

Modifier and Type	Method	Description
static GeefSociaalStatuutRequest.Builder	builder()
protected void	fillIn(MagdaDocument request, UUID requestId, MagdaRegistrationInfo magdaRegistrationInfo, Instant instant)
MagdaServiceIdentification	magdaServiceIdentification()

Methods inherited from class be.vlaanderen.vip.magda.client.diensten.PersonMagdaRequest

getSubject

Methods inherited from class be.vlaanderen.vip.magda.client.MagdaRequest

fillInCommonFields, toMagdaDocument, toMagdaDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GeefSociaalStatuutRequest

protected GeefSociaalStatuutRequest(@NotNull
 @NotNull INSZNumber insz,
 @NotNull
 @NotNull Registration registration,
 @NotNull
 @NotNull String socialStatusName,
 boolean atDateOfRequest,
 @Nullable
 LocalDate date,
 @Nullable
 LocalDate startDate,
 @Nullable
 LocalDate endDate,
 @Nullable
 String locationName)

Method Details

builder

public static GeefSociaalStatuutRequest.Builder builder()

magdaServiceIdentification

public MagdaServiceIdentification magdaServiceIdentification()

Specified by:

magdaServiceIdentification in class MagdaRequest

fillIn

protected void fillIn(MagdaDocument request,
 UUID requestId,
 MagdaRegistrationInfo magdaRegistrationInfo,
 Instant instant)

Specified by:

fillIn in class MagdaRequest