net.sparkworks.cargo.client

Interface ResourceClient

All Known Implementing Classes:

ResourceClientImpl

public interface ResourceClient

Method Summary

Modifier and Type	Method and Description
Long	count() Retrieve the number of the Resources the user has access to.
net.sparkworks.cargo.common.dto.ResourceDTO	create(String systemName, String userFriendlyName, net.sparkworks.cargo.common.enumerator.ResourceType type, String phenomenon, String unit, String controls, UUID groupUUID) Create a new Resource.
void	delete(UUID uuid) Delete a Resource by its UUID.
net.sparkworks.cargo.common.dto.ResourceDTO	getBySystemName(String systemName) Retrieve a Resource by its name
net.sparkworks.cargo.common.dto.ResourceDTO	getByUUID(UUID uuid) Retrieve a Resource by its UUID
Collection<net.sparkworks.cargo.common.dto.ResourceDTO>	listAll() Retrieve all the Resources the user has access to.
net.sparkworks.cargo.common.dto.ResourceDTO	move(UUID resourceUuid, UUID targetGroupUuid) Move a Resource to a Group
net.sparkworks.cargo.common.dto.ResourceDTO	update(UUID uuid, String userFriendlyName, net.sparkworks.cargo.common.enumerator.ResourceType typeUuid, String controls, UUID phenomenonUuid, UUID unitUuid)

Method Detail

listAll

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

Retrieve all the Resources the user has access to.

Returns:

a Collection containing all the ResourceDTO the user has access to.

getByUUID

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

Retrieve a Resource by its UUID

Parameters:

uuid - the UUID of the Resource to retrieve

Returns:

the ResourceDTO found

getBySystemName

net.sparkworks.cargo.common.dto.ResourceDTO getBySystemName(String systemName)

Retrieve a Resource by its name

Parameters:

systemName - the system name of the Resource to retrieve

Returns:

the ResourceDTO found

create

net.sparkworks.cargo.common.dto.ResourceDTO create(String systemName,
                                                   String userFriendlyName,
                                                   net.sparkworks.cargo.common.enumerator.ResourceType type,
                                                   String phenomenon,
                                                   String unit,
                                                   String controls,
                                                   UUID groupUUID)

Create a new Resource.

Parameters:

systemName - the uri of the new Resource

userFriendlyName - the user friendly name of the Resource

type - Sensor/Actuator

phenomenon - the phenomenon name of the Resource observes

unit - the unit of measurement the Resource

controls - // TODO: 3/12/2018 add description to controls

groupUUID - the UUID of the Group the new Resource will belong to

Returns:

the new ResourceDTO

count

Long count()

Retrieve the number of the Resources the user has access to.

Returns:

the number of the Resources the user has access to

delete

void delete(UUID uuid)

Delete a Resource by its UUID.

Parameters:

uuid - the UUID of the Resource to delete

move

net.sparkworks.cargo.common.dto.ResourceDTO move(UUID resourceUuid,
                                                 UUID targetGroupUuid)

Move a Resource to a Group

Parameters:

resourceUuid - the Resource UUID

targetGroupUuid - the Group UUID

Returns:

the updated ResourceDTO

update

net.sparkworks.cargo.common.dto.ResourceDTO update(UUID uuid,
                                                   String userFriendlyName,
                                                   net.sparkworks.cargo.common.enumerator.ResourceType typeUuid,
                                                   String controls,
                                                   UUID phenomenonUuid,
                                                   UUID unitUuid)