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

Class EbXMLRemoveMetadataRequest30

java.lang.Object

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

All Implemented Interfaces:

EbXMLAdhocQueryRequest<RemoveObjectsRequest>, EbXMLRemoveMetadataRequest<RemoveObjectsRequest>, EbXMLSlotList

public class EbXMLRemoveMetadataRequest30
extends Object
implements EbXMLRemoveMetadataRequest<RemoveObjectsRequest>

Encapsulation of RemoveObjectsRequest

Author:

Boris Stanojevic

Constructor Summary

Constructors

Constructor	Description
EbXMLRemoveMetadataRequest30(RemoveObjectsRequest removeObjectsRequest)	Constructs a request by wrapping the given ebXML 3.0 object.

Method Summary

Modifier and Type	Method	Description
void	addSlot(String slotName, String... slotValues)	Adds a slot with a list of values.
String	getDeletionScope()
String	getHome()
String	getId()
RemoveObjectsRequest	getInternal()
List<ObjectReference>	getReferences()
String	getReturnType()
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	setDeletionScope(String deletionScope)	Sets the deletionScope of the remove request.
void	setHome(String homeCommunityID)
void	setId(String id)
void	setReferences(List<ObjectReference> references)	Sets the object references of the remove request.
void	setReturnType(String returnType)

Methods inherited from class java.lang.Object

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

Constructor Details

EbXMLRemoveMetadataRequest30

public EbXMLRemoveMetadataRequest30(RemoveObjectsRequest removeObjectsRequest)

Constructs a request by wrapping the given ebXML 3.0 object.

Parameters:

removeObjectsRequest - the object to wrap.

Method Details

setReferences

public void setReferences(List<ObjectReference> references)

Description copied from interface: EbXMLRemoveMetadataRequest

Sets the object references of the remove request.

Specified by:

setReferences in interface EbXMLRemoveMetadataRequest<RemoveObjectsRequest>

Parameters:

references - the object references.

getReferences

public List<ObjectReference> getReferences()

Specified by:

getReferences in interface EbXMLRemoveMetadataRequest<RemoveObjectsRequest>

Returns:

the object reference of the remove request.

getDeletionScope

public String getDeletionScope()

Specified by:

getDeletionScope in interface EbXMLRemoveMetadataRequest<RemoveObjectsRequest>

Returns:

the deletionScope of the remove request.

setDeletionScope

public void setDeletionScope(String deletionScope)

Description copied from interface: EbXMLRemoveMetadataRequest

Sets the deletionScope of the remove request.

Specified by:

setDeletionScope in interface EbXMLRemoveMetadataRequest<RemoveObjectsRequest>

setReturnType

public void setReturnType(String returnType)

Specified by:

setReturnType in interface EbXMLAdhocQueryRequest<RemoveObjectsRequest>

Parameters:

returnType - the type of objects that the query should return.

getReturnType

public String getReturnType()

Specified by:

getReturnType in interface EbXMLAdhocQueryRequest<RemoveObjectsRequest>

Returns:

the type of objects that the query should return.

setId

public void setId(String id)

Specified by:

setId in interface EbXMLAdhocQueryRequest<RemoveObjectsRequest>

Parameters:

id - the id of the query.

getId

public String getId()

Specified by:

getId in interface EbXMLAdhocQueryRequest<RemoveObjectsRequest>

Returns:

the id of the query.

setHome

public void setHome(String homeCommunityID)

Specified by:

setHome in interface EbXMLAdhocQueryRequest<RemoveObjectsRequest>

Parameters:

homeCommunityID - home community ID.

getHome

public String getHome()

Specified by:

getHome in interface EbXMLAdhocQueryRequest<RemoveObjectsRequest>

Returns:

home community ID.

getInternal

public RemoveObjectsRequest getInternal()

Specified by:

getInternal in interface EbXMLAdhocQueryRequest<RemoveObjectsRequest>

Returns:

the ebXML object wrapped by this object.

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.