Package org.openehealth.ipf.commons.ihe.xds.core.responses

Class RetrievedDocumentSet

java.lang.Object

org.openehealth.ipf.commons.ihe.xds.core.responses.Response

org.openehealth.ipf.commons.ihe.xds.core.responses.RetrievedDocumentSet

All Implemented Interfaces:

Serializable

public class RetrievedDocumentSet
extends Response
implements Serializable

Documents returned by the Retrieve Document Set transaction.

Lists are pre-created and can therefore never be null.

Author:

Jens Riemschneider

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RetrievedDocumentSet()	Constructs the response.
RetrievedDocumentSet(Throwable throwable, ErrorCode defaultMetaDataError, ErrorCode defaultError, String location)	Constructs an error response object with the data from an exception.
RetrievedDocumentSet(Status status)	Constructs the response.
RetrievedDocumentSet(Status status, List<RetrievedDocument> documents)	Constructs the response.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<RetrievedDocument>	getDocuments()
int	hashCode()
String	toString()

Methods inherited from class org.openehealth.ipf.commons.ihe.xds.core.responses.Response

getErrors, getStatus, setErrors, setStatus

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievedDocumentSet

public RetrievedDocumentSet()

Constructs the response.

RetrievedDocumentSet

public RetrievedDocumentSet(Status status)

Constructs the response.

Parameters:

status - the status of the request execution.

RetrievedDocumentSet

public RetrievedDocumentSet(Status status,
 List<RetrievedDocument> documents)

Constructs the response.

Parameters:

status - the status of the request execution.

documents - the documents to add to this set.

RetrievedDocumentSet

public RetrievedDocumentSet(Throwable throwable,
 ErrorCode defaultMetaDataError,
 ErrorCode defaultError,
 String location)

Constructs an error response object with the data from an exception.

Parameters:

throwable - the exception that occurred.

defaultMetaDataError - the default error code for XDSMetaDataException.

defaultError - the default error code for any other exception.

location - error location.

Method Details

getDocuments

public List<RetrievedDocument> getDocuments()

Returns:

the documents.

equals

public boolean equals(Object o)

Overrides:

equals in class Response

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class Response

hashCode

public int hashCode()

Overrides:

hashCode in class Response

toString

public String toString()

Overrides:

toString in class Response