net.sparkworks.cargo.client

Interface UnitClient

All Known Implementing Classes:

UnitClientImpl

public interface UnitClient

Method Summary

Modifier and Type	Method and Description
net.sparkworks.cargo.common.dto.UnitDTO	create(String name) Create a Unit
void	delete(UUID uuid) Delete a Unit by its UUID
net.sparkworks.cargo.common.dto.UnitDTO	getByUUID(UUID uuid) Get a Unit by its UUID
Collection<net.sparkworks.cargo.common.dto.UnitDTO>	listAll() Retrieve all the Units
net.sparkworks.cargo.common.dto.UnitDTO	query(String name, UUID uuid) Retrieve a Unit by its name or UUID
net.sparkworks.cargo.common.dto.UnitDTO	update(UUID uuid, String name)

Method Detail

listAll

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

Retrieve all the Units

Returns:

a Collection containing all the UnitDTO.

getByUUID

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

Get a Unit by its UUID

Parameters:

uuid - the UUID of the Unit to retrieve

Returns:

the UnitDTO found

create

net.sparkworks.cargo.common.dto.UnitDTO create(String name)

Create a Unit

Parameters:

name - the name of the Unit

Returns:

the new UnitDTO

delete

void delete(UUID uuid)

Delete a Unit by its UUID

Parameters:

uuid - the UUID of the Unit to delete

query

net.sparkworks.cargo.common.dto.UnitDTO query(String name,
                                              UUID uuid)

Retrieve a Unit by its name or UUID

Parameters:

name - the name of the Unit

uuid - the UUID of the Unit

Returns:

the UnitDTO found

update

net.sparkworks.cargo.common.dto.UnitDTO update(UUID uuid,
                                               String name)