eu.toop.edm

Class EDMRequest

java.lang.Object

eu.toop.edm.EDMRequest

All Implemented Interfaces:

IEDMTopLevelObject

public class EDMRequest
extends Object
implements IEDMTopLevelObject

This class contains the data model for a single TOOP EDM Request. It requires at least the following fields:

• QueryDefinition - Concept or Document query?
• Request ID - the internal ID of the request that must be part of the response. Can be a UUID.
• Specification Identifier - must be the value CToopEDM.SPECIFICATION_IDENTIFIER_TOOP_EDM_V20.
• Issue date time - when the request was created. Ideally in UTC.
• Data Consumer - the basic infos of the DC
• Data Subject - either as Legal Person or as Natural Person, but not both.
• If it is a "ConceptQuery" the request Concepts must be provided.
• If it is a "DocumentQuery" the request distribution must be provided.
• If it is a "ObjectReference" the request Document ID must be provided.

It is recommended to use the builder*() methods to create the EDM request using the builder pattern with a fluent API.

Author:

Philip Helger, Konstantinos Douloudis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EDMRequest.AbstractBuilder<T extends EDMRequest.AbstractBuilder<T>> Generic Builder for an EDM request
static class	EDMRequest.BuilderConcept A builder for a "Concept request".Request a concept response.
static class	EDMRequest.BuilderDocumentByID Builder for a "Document by ID request".
static class	EDMRequest.BuilderDocumentsByDistribution Builder for a "Documents by distribution request".

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

EDMRequest(EToopQueryDefinitionType eQueryDefinition, String sRequestID, EToopResponseOptionType eResponseOption, String sSpecificationIdentifier, LocalDateTime aIssueDateTime, eu.toop.regrep.rim.InternationalStringType aProcedure, com.helger.commons.collection.impl.ICommonsList<CCCEVRequirementType> aFullfillingRequirements, AgentPojo aDataConsumer, String sConsentToken, String sDatasetIdentifier, BusinessPojo aDataSubjectLegalPerson, PersonPojo aDataSubjectNaturalPerson, PersonPojo aAuthorizedRepresentative, IEDMRequestPayloadProvider aRPP)

Method Summary

Modifier and Type	Method and Description
static EDMRequest.BuilderConcept	builderConcept()
static EDMRequest.BuilderDocumentByID	builderDocumentByID()
static EDMRequest.BuilderDocumentsByDistribution	builderDocumentReferencesByDistribution()
static EDMRequest.BuilderDocumentsByDistribution	builderDocumentsByDistribution()
static EDMRequest	create(eu.toop.regrep.query.QueryRequest aQueryRequest)
boolean	equals(Object o)
List<CCCEVRequirementType>	fullfillingRequirements()
List<CCCEVRequirementType>	getAllFullfillingRequirements()
eu.toop.regrep.query.QueryRequest	getAsQueryRequest()
PersonPojo	getAuthorizedRepresentative()
String	getConsentToken()
AgentPojo	getDataConsumer()
String	getDatasetIdentifier()
BusinessPojo	getDataSubjectLegalPerson()
PersonPojo	getDataSubjectNaturalPerson()
LocalDateTime	getIssueDateTime()
IEDMRequestPayloadProvider	getPayloadProvider()
eu.toop.regrep.rim.InternationalStringType	getProcedure()
EToopQueryDefinitionType	getQueryDefinition()
String	getRequestID()
EToopResponseOptionType	getResponseOption()
String	getSpecificationIdentifier()
IVersatileWriter<eu.toop.regrep.query.QueryRequest>	getWriter()
int	hashCode()
static IJAXBVersatileReader<EDMRequest>	reader()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EDMRequest

protected EDMRequest(@Nonnull
                     EToopQueryDefinitionType eQueryDefinition,
                     @Nonnull @Nonempty
                     String sRequestID,
                     @Nonnull
                     EToopResponseOptionType eResponseOption,
                     @Nonnull @Nonempty
                     String sSpecificationIdentifier,
                     @Nonnull
                     LocalDateTime aIssueDateTime,
                     @Nullable
                     eu.toop.regrep.rim.InternationalStringType aProcedure,
                     @Nullable
                     com.helger.commons.collection.impl.ICommonsList<CCCEVRequirementType> aFullfillingRequirements,
                     @Nonnull
                     AgentPojo aDataConsumer,
                     @Nullable
                     String sConsentToken,
                     @Nullable
                     String sDatasetIdentifier,
                     @Nullable
                     BusinessPojo aDataSubjectLegalPerson,
                     @Nullable
                     PersonPojo aDataSubjectNaturalPerson,
                     @Nullable
                     PersonPojo aAuthorizedRepresentative,
                     @Nonnull
                     IEDMRequestPayloadProvider aRPP)

Method Detail

getQueryDefinition

@Nonnull
public final EToopQueryDefinitionType getQueryDefinition()

getRequestID

@Nonnull
 @Nonempty
public final String getRequestID()

getResponseOption

@Nonnull
public final EToopResponseOptionType getResponseOption()

getSpecificationIdentifier

@Nonnull
 @Nonempty
public final String getSpecificationIdentifier()

getIssueDateTime

@Nonnull
public final LocalDateTime getIssueDateTime()

getProcedure

@Nullable
public final eu.toop.regrep.rim.InternationalStringType getProcedure()

fullfillingRequirements

@Nonnull
 @ReturnsMutableObject
public final List<CCCEVRequirementType> fullfillingRequirements()

getAllFullfillingRequirements

@Nonnull
 @ReturnsMutableCopy
public final List<CCCEVRequirementType> getAllFullfillingRequirements()

getDataConsumer

@Nonnull
public final AgentPojo getDataConsumer()

getConsentToken

@Nullable
public final String getConsentToken()

getDatasetIdentifier

@Nullable
public final String getDatasetIdentifier()

getDataSubjectLegalPerson

@Nullable
public final BusinessPojo getDataSubjectLegalPerson()

getDataSubjectNaturalPerson

@Nullable
public final PersonPojo getDataSubjectNaturalPerson()

getAuthorizedRepresentative

@Nullable
public final PersonPojo getAuthorizedRepresentative()

getPayloadProvider

@Nonnull
public final IEDMRequestPayloadProvider getPayloadProvider()

Returns:

The request payload provider. Never null. This is one of IEDMRequestPayloadConcepts, IEDMRequestPayloadDistribution or IEDMRequestPayloadDocumentID.

getAsQueryRequest

@Nonnull
public eu.toop.regrep.query.QueryRequest getAsQueryRequest()

getWriter

@Nonnull
public IVersatileWriter<eu.toop.regrep.query.QueryRequest> getWriter()

reader

@Nonnull
public static IJAXBVersatileReader<EDMRequest> reader()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builderConcept

@Nonnull
public static EDMRequest.BuilderConcept builderConcept()

builderDocumentsByDistribution

@Nonnull
public static EDMRequest.BuilderDocumentsByDistribution builderDocumentsByDistribution()

builderDocumentReferencesByDistribution

@Nonnull
public static EDMRequest.BuilderDocumentsByDistribution builderDocumentReferencesByDistribution()

builderDocumentByID

@Nonnull
public static EDMRequest.BuilderDocumentByID builderDocumentByID()

Returns:

A new builder for an EDM Request that is request with a an ID only.

create

@Nonnull
public static EDMRequest create(@Nonnull
                                          eu.toop.regrep.query.QueryRequest aQueryRequest)