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

Class EbXMLProvideAndRegisterDocumentSetRequest30

java.lang.Object

org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30.EbXMLObjectContainer30

org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30.EbXMLProvideAndRegisterDocumentSetRequest30

All Implemented Interfaces:

EbXMLObjectContainer, EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType>, EbXMLSlotList, EbXMLSubmitObjectsRequest<ProvideAndRegisterDocumentSetRequestType>

public class EbXMLProvideAndRegisterDocumentSetRequest30
extends EbXMLObjectContainer30
implements EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType>

Encapsulation of ProvideAndRegisterDocumentSetRequestType

Author:

Jens Riemschneider

Constructor Summary

Constructors

Constructor	Description
EbXMLProvideAndRegisterDocumentSetRequest30(ProvideAndRegisterDocumentSetRequestType request)	Constructs a request by wrapping the given ebXML 3.0 object using a new object library.
EbXMLProvideAndRegisterDocumentSetRequest30(ProvideAndRegisterDocumentSetRequestType request, EbXMLObjectLibrary objectLibrary)	Constructs a request by wrapping the given ebXML 3.0 object.

Method Summary

Modifier and Type	Method	Description
void	addDocument(String id, javax.activation.DataHandler dataHandler)	Adds a new document to the request.
void	addSlot(String slotName, String... slotValues)	Adds a slot with a list of values.
Map<String,javax.activation.DataHandler>	getDocuments()
ProvideAndRegisterDocumentSetRequestType	getInternal()
String	getSingleSlotValue(String slotName)	Gets a single slot value.
List<EbXMLSlot>	getSlots()
List<EbXMLSlot>	getSlots(String slotName)	Returns a filtered list of the slots.
List<String>	getSlotValues(String slotName)	Gets the values of a slot.
void	removeDocument(String id)	Removes a document from the request.

Methods inherited from class org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30.EbXMLObjectContainer30

addAssociation, addClassification, addExtrinsicObject, addRegistryPackage, cast, fillObjectLibrary, getAssociations, getClassifications, getExtrinsicObjects, getExtrinsicObjects, getObjectLibrary, getRegistryPackages, getRegistryPackages

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openehealth.ipf.commons.ihe.xds.core.ebxml.EbXMLObjectContainer

addAssociation, addClassification, addExtrinsicObject, addRegistryPackage, getAssociations, getClassifications, getExtrinsicObjects, getExtrinsicObjects, getObjectLibrary, getRegistryPackages, getRegistryPackages

Constructor Details

EbXMLProvideAndRegisterDocumentSetRequest30

public EbXMLProvideAndRegisterDocumentSetRequest30(ProvideAndRegisterDocumentSetRequestType request,
 EbXMLObjectLibrary objectLibrary)

Constructs a request by wrapping the given ebXML 3.0 object.

Parameters:

request - the object to wrap.

objectLibrary - the object library to use.

EbXMLProvideAndRegisterDocumentSetRequest30

public EbXMLProvideAndRegisterDocumentSetRequest30(ProvideAndRegisterDocumentSetRequestType request)

Constructs a request by wrapping the given ebXML 3.0 object using a new object library.

Parameters:

request - the object to wrap.

Method Details

addDocument

public void addDocument(String id,
 javax.activation.DataHandler dataHandler)

Description copied from interface: EbXMLProvideAndRegisterDocumentSetRequest

Adds a new document to the request.

Specified by:

addDocument in interface EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType>

Parameters:

id - the id of the document.

dataHandler - the data handler allowing access and describing to the document contents.

removeDocument

public void removeDocument(String id)

Description copied from interface: EbXMLProvideAndRegisterDocumentSetRequest

Removes a document from the request.

Specified by:

removeDocument in interface EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType>

Parameters:

id - the id of the document.

getDocuments

public Map<String,javax.activation.DataHandler> getDocuments()

Specified by:

getDocuments in interface EbXMLProvideAndRegisterDocumentSetRequest<ProvideAndRegisterDocumentSetRequestType>

Returns:

the documents contained in the request. This map is read-only.

getInternal

public ProvideAndRegisterDocumentSetRequestType getInternal()

Specified by:

getInternal in interface EbXMLSubmitObjectsRequest<ProvideAndRegisterDocumentSetRequestType>

Returns:

the wrapped ebXML representation of this request.

addSlot

public void addSlot(String slotName,
 String... slotValues)

Description copied from interface: EbXMLSlotList

Adds a slot with a list of values.

Specified by:

addSlot in interface EbXMLSlotList

Parameters:

slotName - the slot name.

slotValues - the slot values. The slot will not be created if this parameter is empty or null.

getSlotValues

public List<String> getSlotValues(String slotName)

Description copied from interface: EbXMLSlotList

Gets the values of a slot.

Specified by:

getSlotValues in interface EbXMLSlotList

Parameters:

slotName - the name of the slot. It is expected that the name is only used for a single slot. Use EbXMLSlotList.getSlots(String) if it is possible that the name is used multiple times.

Returns:

the list of slot values.

getSingleSlotValue

public String getSingleSlotValue(String slotName)

Description copied from interface: EbXMLSlotList

Gets a single slot value.

Specified by:

getSingleSlotValue in interface EbXMLSlotList

Parameters:

slotName - the name of the slot. It is expected that the name is only used for a single slot. Use EbXMLSlotList.getSlots(String) if it is possible that the name is used multiple times.

Returns:

the first slot value. Other slot values are ignored. Can be null if the slot does not exist, has no slot values or the value is null.

getSlots

public List<EbXMLSlot> getSlots()

Specified by:

getSlots in interface EbXMLSlotList

Returns:

the complete list of all slots.

getSlots

public List<EbXMLSlot> getSlots(String slotName)

Description copied from interface: EbXMLSlotList

Returns a filtered list of the slots.

Specified by:

getSlots in interface EbXMLSlotList

Parameters:

slotName - name of the slots.

Returns:

the list of slots named with the given slot name.