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

Interface EbXMLFactory

All Known Implementing Classes:

EbXMLFactory30

public interface EbXMLFactory

Serves as a factory for ebXML objects.

This factory is used to provide version independent creation of ebXML objects.

Author:

Jens Riemschneider

Method Summary

Modifier and Type	Method	Description
EbXMLAdhocQueryRequest<AdhocQueryRequest>	createAdhocQueryRequest()	Creates a new request to query a registry.
EbXMLQueryResponse<AdhocQueryResponse>	createAdhocQueryResponse(EbXMLObjectLibrary objectLibrary, boolean returnsObjectRefs)	Creates a new response for a query request.
EbXMLAssociation	createAssociation(String id, EbXMLObjectLibrary objectLibrary)	Creates a new association.
EbXMLClassification	createClassification(EbXMLObjectLibrary objectLibrary)	Creates a new classification.
EbXMLExtrinsicObject	createExtrinsic(String id, EbXMLObjectLibrary objectLibrary)	Creates a new extrinsic object and adds it to the object library.
EbXMLObjectLibrary	createObjectLibrary()
EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType>	createProvideAndRegisterDocumentSetRequest(EbXMLObjectLibrary library)	Creates a new request to provide and register documents.
EbXMLRegistryError	createRegistryError()	Creates a new registry error object.
EbXMLRegistryPackage	createRegistryPackage(String id, EbXMLObjectLibrary objectLibrary)	Creates a new registry package and adds it to the object library.
EbXMLRegistryResponse<RegistryResponseType>	createRegistryResponse()	Creates a new response for a registry request.
EbXMLNonconstructiveDocumentSetRequest<RemoveDocumentsRequestType>	createRemoveDocumentsRequest()	Creates a new request to remove documents.
EbXMLRemoveMetadataRequest<RemoveObjectsRequest>	createRemoveMetadataRequest()	Creates a new remove metadata request.
EbXMLNonconstructiveDocumentSetRequest<RetrieveDocumentSetRequestType>	createRetrieveDocumentSetRequest()	Creates a new request to retrieve documents.
EbXMLRetrieveDocumentSetResponse<RetrieveDocumentSetResponseType>	createRetrieveDocumentSetResponse()	Creates a new response for a retrieve document request.
EbXMLRetrieveImagingDocumentSetRequest<RetrieveImagingDocumentSetRequestType>	createRetrieveImagingDocumentSetRequest()	Creates a new request to retrieve imaging documents.
EbXMLSubmitObjectsRequest<SubmitObjectsRequest>	createSubmitObjectsRequest()	Creates a new request to submit objects.

Method Details

createObjectLibrary

EbXMLObjectLibrary createObjectLibrary()

Returns:

a new instance of an object library filled with object references used for ebXML requests/responses.

createClassification

EbXMLClassification createClassification(EbXMLObjectLibrary objectLibrary)

Creates a new classification.

Parameters:

objectLibrary - the object library to use.

Returns:

the created object.

createExtrinsic

EbXMLExtrinsicObject createExtrinsic(String id,
 EbXMLObjectLibrary objectLibrary)

Creates a new extrinsic object and adds it to the object library.

Parameters:

id - the id of the object within the object library.

objectLibrary - the object library to use.

Returns:

the created object.

createRegistryPackage

EbXMLRegistryPackage createRegistryPackage(String id,
 EbXMLObjectLibrary objectLibrary)

Creates a new registry package and adds it to the object library.

Parameters:

id - the id of the object within the object library.

objectLibrary - the object library to use.

Returns:

the created object.

createAssociation

EbXMLAssociation createAssociation(String id,
 EbXMLObjectLibrary objectLibrary)

Creates a new association.

Parameters:

id - the id of the object within the object library.

objectLibrary - the object library to use.

Returns:

the created object.

createSubmitObjectsRequest

EbXMLSubmitObjectsRequest<SubmitObjectsRequest> createSubmitObjectsRequest()

Creates a new request to submit objects.

Returns:

the created object.

createProvideAndRegisterDocumentSetRequest

EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType> createProvideAndRegisterDocumentSetRequest(EbXMLObjectLibrary library)

Creates a new request to provide and register documents.

Parameters:

library - the object library to use.

Returns:

the created object.

createRetrieveDocumentSetRequest

EbXMLNonconstructiveDocumentSetRequest<RetrieveDocumentSetRequestType> createRetrieveDocumentSetRequest()

Creates a new request to retrieve documents.

Returns:

the created object.

createRemoveDocumentsRequest

EbXMLNonconstructiveDocumentSetRequest<RemoveDocumentsRequestType> createRemoveDocumentsRequest()

Creates a new request to remove documents.

Returns:

the created object.

createRetrieveImagingDocumentSetRequest

EbXMLRetrieveImagingDocumentSetRequest<RetrieveImagingDocumentSetRequestType> createRetrieveImagingDocumentSetRequest()

Creates a new request to retrieve imaging documents.

Returns:

the created object.

createAdhocQueryRequest

EbXMLAdhocQueryRequest<AdhocQueryRequest> createAdhocQueryRequest()

Creates a new request to query a registry.

Returns:

the created object.

createAdhocQueryResponse

EbXMLQueryResponse<AdhocQueryResponse> createAdhocQueryResponse(EbXMLObjectLibrary objectLibrary,
 boolean returnsObjectRefs)

Creates a new response for a query request.

Parameters:

objectLibrary - the object library to use.

returnsObjectRefs - true if the response is meant to return object references instead of the real objects. This parameter should be true to ensure that an object library is not included in the query result contains ObjectRefs. Those ObjectRefs cannot be distinguished from the ObjectRefs of the object library and therefore the object library would produce unwanted query results.

Returns:

the created object.

createRegistryResponse

EbXMLRegistryResponse<RegistryResponseType> createRegistryResponse()

Creates a new response for a registry request.

Returns:

the created object.

createRetrieveDocumentSetResponse

EbXMLRetrieveDocumentSetResponse<RetrieveDocumentSetResponseType> createRetrieveDocumentSetResponse()

Creates a new response for a retrieve document request.

Returns:

the created object.

createRegistryError

EbXMLRegistryError createRegistryError()

Creates a new registry error object.

Returns:

the created object.

createRemoveMetadataRequest

EbXMLRemoveMetadataRequest<RemoveObjectsRequest> createRemoveMetadataRequest()

Creates a new remove metadata request.

Returns:

the created object.