cz.ues.myterritory.person

Interface UESFriend

Deprecated.

It is recommended to encapsulate calling UESFriend's methods (commands) because some changes are expected in one of next iterations. Thanks the encapsulation, it will be easily to respond to the changes.

@Deprecated
@UESService
public interface UESFriend

Since:

UES7-10

Method Summary

Methods

Modifier and Type	Method and Description
void	activateAccess(UESURI friendUri) Deprecated.
UESURI	create(UESURI personalTerritoryUri, UESFriendCreate friend) Deprecated.
void	deactivateAccess(UESURI friendUri) Deprecated.
UESFriendAttributes	getAttributes(UESURI friendUri) Deprecated.
UESURI	setAttributes(UESURI friendUri, UESFriendSetAttributes friend) Deprecated.

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI personalTerritoryUri,
UESFriendCreate friend)
throws UESFriendRTException

Deprecated.

Creates a new friend. The command creates a new friend in a specified personal territory. At the very least meta artifact and Universe ID must be specified in UESFriendCreate DTO.

Parameters:

personalTerritoryUri - UES URI of the personal territory where a new friend will be created

friend - DTO containing attributes of the new friend

Returns:

UESURI of the new friend

Throws:

UESFriendRTException

Since:

UES7-10

getAttributes

@UESCommand(stereotype=READ)

UESFriendAttributes getAttributes(UESURI friendUri)
throws UESFriendRTException

Deprecated.

This command returns attributes representing the friend specified by the friendUri parameter. The command does not change the state of the friend in the system.

Parameters:

friendUri - UESURI of a friend whose attributes are returned

Returns:

DTO containing the friend attributes

Throws:

UESFriendRTException

Since:

UES7-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI friendUri,
UESFriendSetAttributes friend)
throws UESFriendRTException

Deprecated.

Command for setting attributes of a friend. The command can't modify references to objects like location, competent role and so on.

Parameters:

friendUri - UESURI of the friend whose attributes are to be changed

friend - DTO containing new attributes the friend

Returns:

UESURI of the friend

Throws:

UESFriendRTException

Since:

UES7-10

activateAccess

@UESCommand(stereotype=UPDATE)

void activateAccess(UESURI friendUri)
throws UESFriendRTException

Deprecated.

This command activates a friend. The friend will be again with access to the territory where is located.

Parameters:

friendUri - UESURI of a friend that the access will be reactivated.

Throws:

UESFriendRTException

Since:

UES7-10

deactivateAccess

@UESCommand(stereotype=UPDATE)

void deactivateAccess(UESURI friendUri)
throws UESFriendRTException

Deprecated.

This command deactivates a friend. The friend will be without access to the territory where is located.

Parameters:

friendUri - UESURI of a friend that the access will be canceled.

Throws:

UESFriendRTException

Since:

UES7-10