net.sparkworks.cargo.client

Interface UnitConversionClient

All Known Implementing Classes:

UnitConversionClientImpl

public interface UnitConversionClient

Method Summary

Modifier and Type	Method and Description
net.sparkworks.cargo.common.dto.UnitConversionDTO	create(UUID sourceUuid, UUID targetUuid, String method) Create a UnitConversion
void	delete(UUID uuid) Delete a UnitConversion by its UUID
net.sparkworks.cargo.common.dto.UnitConversionDTO	getByUUID(UUID uuid) Get a UnitConversion by its UUID
Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO>	listAll() Retrieve all the UnitConversions
Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO>	query(UUID sourceUuid, UUID targetUuid, UUID uuid) Retrieve a Collection of UnitConversion by source Unit UUID, target Unit UUID and UnitConversion UUID The query will try to find conversions with the following priority: 1) find UnitConversion that has source with sourceUuid and target with targetUuid 2) find UnitConversions that has source with sourceUuid 3) find UnitConversions that has target with targetUuid 4) find UnitConversion with uuid If no conversion is found then UnitConversionNotFoundException is thrown

Method Detail

listAll

Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO> listAll()

Retrieve all the UnitConversions

Returns:

a Collection containing all the UnitConversionDTO.

getByUUID

net.sparkworks.cargo.common.dto.UnitConversionDTO getByUUID(UUID uuid)

Get a UnitConversion by its UUID

Parameters:

uuid - the UUID of the UnitConversion to retrieve

Returns:

the UnitConversionDTO found

create

net.sparkworks.cargo.common.dto.UnitConversionDTO create(UUID sourceUuid,
                                                         UUID targetUuid,
                                                         String method)

Create a UnitConversion

Parameters:

sourceUuid - the UUID of the source Unit

targetUuid - the UUID of the target Unit

method - the method applied for the conversion

Returns:

the new UnitConversionDTO

delete

void delete(UUID uuid)

Delete a UnitConversion by its UUID

Parameters:

uuid - the UUID of the UnitConversion to delete

query

Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO> query(UUID sourceUuid,
                                                                    UUID targetUuid,
                                                                    UUID uuid)

Retrieve a Collection of UnitConversion by source Unit UUID, target Unit UUID and UnitConversion UUID The query will try to find conversions with the following priority: 1) find UnitConversion that has source with sourceUuid and target with targetUuid 2) find UnitConversions that has source with sourceUuid 3) find UnitConversions that has target with targetUuid 4) find UnitConversion with uuid If no conversion is found then UnitConversionNotFoundException is thrown

Parameters:

sourceUuid - the UUID of the source Unit

targetUuid - the UUID of the target Unit

uuid - the UUID of the UnitConversion to retrieve

Returns:

a Collection of UnitConversionDTO that contains all the Unit Conversions found