net.sparkworks.cargo.client

Interface PhenomenonClient

All Known Implementing Classes:

PhenomenonClientImpl

public interface PhenomenonClient

Method Summary

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

Method Detail

listAll

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

Retrieve all the Phenomena

Returns:

a Collection containing all the PhenomenonDTO.

getByUUID

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

Get a Phenomenon by its UUID

Parameters:

uuid - the UUID of the Phenomenon to retrieve

Returns:

the PhenomenonDTO found by the UUID

create

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

Create a Phenomenon

Parameters:

name - the name of the Phenomenon

Returns:

the new PhenomenonDTO

delete

void delete(UUID uuid)

Delete a Phenomenon by its UUID

Parameters:

uuid - the UUID of the Phenomenon to delete

query

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

Retrieve a Phenomenon by its name or UUID

Parameters:

name - the name of the Phenomenon

uuid - the UUID of the Phenomenon

Returns:

the PhenomenonDTO found

update

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