eu.toop.edm

Class EDMResponse

java.lang.Object

eu.toop.edm.EDMResponse

All Implemented Interfaces:

IEDMTopLevelObject

public class EDMResponse
extends Object
implements IEDMTopLevelObject

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

• ResponseOption - "Registry Object" or "Object Reference"?
• Response Status - Success, partial success or failure
• Request ID - the ID of the request to which this response correlates.
• Specification Identifier - must be the value CToopEDM.SPECIFICATION_IDENTIFIER_TOOP_EDM_V20.
• Issue date time - when the response was created. Ideally in UTC.
• Data Provider - the basic infos of the DP
• If it is a "ConceptQuery" the response Concepts must be provided.
• If it is a "DocumentQuery" the response Dataset 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	EDMResponse.AbstractBuilder<T extends EDMResponse.AbstractBuilder<T>> Abstract builder for the main builders
static class	EDMResponse.BuilderConcept A builder for Concept responses.
static class	EDMResponse.BuilderDocument A builder for document responses.
static class	EDMResponse.BuilderDocumentReference

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EDMResponse(EToopResponseOptionType eResponseOption, eu.toop.regrep.ERegRepResponseStatus eResponseStatus, String sRequestID, String sSpecificationIdentifier, LocalDateTime aIssueDateTime, AgentPojo aDataProvider, com.helger.commons.collection.impl.ICommonsList<? extends IEDMResponsePayloadProvider> aPayloadProviders)

Method Summary

Modifier and Type	Method and Description
static EDMResponse.BuilderConcept	builderConcept()
static EDMResponse.BuilderDocument	builderDocument()
static EDMResponse.BuilderDocumentReference	builderDocumentReference()
static EDMResponse	create(eu.toop.regrep.query.QueryResponse aQueryResponse)
boolean	equals(Object o)
List<IEDMResponsePayloadProvider>	getAllPayloadProviders()
eu.toop.regrep.query.QueryResponse	getAsQueryResponse()
AgentPojo	getDataProvider()
LocalDateTime	getIssueDateTime()
String	getRequestID()
EToopResponseOptionType	getResponseOption()
eu.toop.regrep.ERegRepResponseStatus	getResponseStatus()
String	getSpecificationIdentifier()
IVersatileWriter<eu.toop.regrep.query.QueryResponse>	getWriter()
int	hashCode()
List<IEDMResponsePayloadProvider>	payloadProviders()
static IJAXBVersatileReader<EDMResponse>	reader()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EDMResponse

protected EDMResponse(@Nonnull
                      EToopResponseOptionType eResponseOption,
                      @Nonnull
                      eu.toop.regrep.ERegRepResponseStatus eResponseStatus,
                      @Nonnull @Nonempty
                      String sRequestID,
                      @Nonnull @Nonempty
                      String sSpecificationIdentifier,
                      @Nonnull
                      LocalDateTime aIssueDateTime,
                      @Nonnull
                      AgentPojo aDataProvider,
                      @Nonnull @Nonempty
                      com.helger.commons.collection.impl.ICommonsList<? extends IEDMResponsePayloadProvider> aPayloadProviders)

Method Detail

getResponseOption

@Nonnull
public final EToopResponseOptionType getResponseOption()

getResponseStatus

@Nonnull
public final eu.toop.regrep.ERegRepResponseStatus getResponseStatus()

getRequestID

@Nonnull
 @Nonempty
public final String getRequestID()

getSpecificationIdentifier

@Nonnull
 @Nonempty
public final String getSpecificationIdentifier()

getIssueDateTime

@Nonnull
public final LocalDateTime getIssueDateTime()

getDataProvider

@Nonnull
public final AgentPojo getDataProvider()

payloadProviders

@Nonnull
 @Nonempty
 @ReturnsMutableObject
public final List<IEDMResponsePayloadProvider> payloadProviders()

Returns:

The payload providers. Never null but maybe empty. The payload elements are either IEDMResponsePayloadConcepts, IEDMResponsePayloadDocument or IEDMResponsePayloadDocumentReference.

getAllPayloadProviders

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public final List<IEDMResponsePayloadProvider> getAllPayloadProviders()

Returns:

The payload providers. Never null but maybe empty. The payload elements are either IEDMResponsePayloadConcepts, IEDMResponsePayloadDocument or IEDMResponsePayloadDocumentReference.

getAsQueryResponse

@Nonnull
public eu.toop.regrep.query.QueryResponse getAsQueryResponse()

getWriter

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

reader

@Nonnull
public static IJAXBVersatileReader<EDMResponse> 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 EDMResponse.BuilderConcept builderConcept()

builderDocument

@Nonnull
public static EDMResponse.BuilderDocument builderDocument()

builderDocumentReference

@Nonnull
public static EDMResponse.BuilderDocumentReference builderDocumentReference()

create

@Nonnull
public static EDMResponse create(@Nonnull
                                           eu.toop.regrep.query.QueryResponse aQueryResponse)