net.sparkworks.cargo.client

Interface GroupClient

All Known Implementing Classes:

GroupClientImpl

public interface GroupClient

Method Summary

Modifier and Type	Method and Description
Long	count() Retrieve the number of the Groups the user has access to.
net.sparkworks.cargo.common.dto.GroupDTO	create(String name, String path) Create a new Group.
void	delete(UUID uuid) Delete a Group by its UUID.
net.sparkworks.cargo.common.dto.GroupDTO	getByUUID(UUID uuid) Retrieve a Group by its UUID if the user has access to it.
Collection<net.sparkworks.cargo.common.dto.GatewayDTO>	getGroupGateways(UUID uuid) Retrieve the Gateways that belong to a specific Group
Collection<net.sparkworks.cargo.common.dto.ResourceDTO>	getGroupResources(UUID uuid) Retrieve the Resources of a Group with specific UUID.
net.sparkworks.cargo.common.dto.GroupNodeDTO	getGroupsTree() Retrieve the Tree structure of the Groups starting from the Root
Collection<net.sparkworks.cargo.common.dto.GroupDTO>	getRootGroups() Retrieve the Main Groups of the current User
Collection<net.sparkworks.cargo.common.dto.GroupDTO>	getSubGroups(UUID uuid, int depth) Retrieve the SubGroups of a specific Group in certain depth.
Collection<net.sparkworks.cargo.common.dto.GroupDTO>	listAll() Retrieve a list of all the Groups the user has access to.
void	move(UUID sourceUUID, UUID targetUUID) Move a Group under another Group.
net.sparkworks.cargo.common.dto.GroupDTO	update(UUID uuid, String name) Update a Group by its UUID

Method Detail

listAll

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

Retrieve a list of all the Groups the user has access to.

Returns:

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

create

net.sparkworks.cargo.common.dto.GroupDTO create(String name,
                                                String path)

Create a new Group.

Parameters:

name - the name of the new Group

path - the path of the Parent Group

Returns:

the new GroupDTO

getByUUID

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

Retrieve a Group by its UUID if the user has access to it.

Parameters:

uuid - the UUID of the Group to retrieve

Returns:

the GroupDTO found by the UUID

count

Long count()

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

Returns:

the number of the Groups the user has access to

delete

void delete(UUID uuid)

Delete a Group by its UUID.

Parameters:

uuid - the UUID of the Group to delete

move

void move(UUID sourceUUID,
          UUID targetUUID)

Move a Group under another Group. e.g. (using invalid UUID just for the purpose of readability in the example) GroupA = {uuid=111, path=ROOT.PATH.TO.GROUPA} GroupB = {uuid=333, path=ROOT.PATH.TO.ANOTHER.GROUPB} GroupC = {uuid=555, path=ROOT.PATH.TO.GROUPA.GROUPC} After executing move(111, 333) the Groups data will be like: GroupA = {uuid=111, path=ROOT.PATH.TO.ANOTHER.GROUPB.GROUPA} GroupB = {uuid=333, path=ROOT.PATH.TO.ANOTHER.GROUPB} GroupC = {uuid=555, path=ROOT.PATH.TO.ANOTHER.GROUPB.GROUPA.GROUPC}

Parameters:

sourceUUID - the UUID of the Group to be moved

targetUUID - the UUID of the target Group

getGroupResources

Collection<net.sparkworks.cargo.common.dto.ResourceDTO> getGroupResources(UUID uuid)

Retrieve the Resources of a Group with specific UUID.

Parameters:

uuid - the the UUID of the Group to get the Resources from

Returns:

a Collection of ResourceDTOs that belong to the Group

getSubGroups

Collection<net.sparkworks.cargo.common.dto.GroupDTO> getSubGroups(UUID uuid,
                                                                  int depth)

Retrieve the SubGroups of a specific Group in certain depth.

Parameters:

uuid - the UUID of the Group to get the SubGroups from

depth - the depth of the SubGroups

Returns:

a Collection of GroupDTO containing the SubGroups of the Group

getGroupGateways

Collection<net.sparkworks.cargo.common.dto.GatewayDTO> getGroupGateways(UUID uuid)

Retrieve the Gateways that belong to a specific Group

Parameters:

uuid - the UUID of the Group

Returns:

a Collection of GatewayDTO that belong to the Group

getRootGroups

Collection<net.sparkworks.cargo.common.dto.GroupDTO> getRootGroups()

Retrieve the Main Groups of the current User

Returns:

a Collection of GroupDTO that contains the main Groups of the user

update

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

Update a Group by its UUID

Parameters:

uuid - the UUID of the Group

name - the new name of the Group

Returns:

the updated GroupDTO

getGroupsTree

net.sparkworks.cargo.common.dto.GroupNodeDTO getGroupsTree()

Retrieve the Tree structure of the Groups starting from the Root

Returns:

a GroupNodeDTO that contains all the Tree