ContactService (Cyclos 4.14.14 Scripting API Documentation)

All Superinterfaces:

CRUDService<ContactDTO,ContactData,ContactDataParams>, Service

All Known Subinterfaces:

ContactServiceLocal

All Known Implementing Classes:

ContactServiceImpl, ContactServiceSecurity
```
public interface ContactService
extends CRUDService<ContactDTO,ContactData,ContactDataParams>
```
Service for managing a user's contacts

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`ContactSearchData`	`getSearchData(UserLocatorVO owner)`	Returns data for searching contacts of the given owner.
`boolean`	`removeByOwnerAndContact(UserLocatorVO owner, @NotNull UserLocatorVO contact)`	Deprecated. This method is kept only to support the analogous REST operation.
`Page<ContactVO>`	`search(ContactQuery query)`	Searches the contacts according to the given query.

Methods inherited from interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

- Method Detail
  - getSearchData
```
ContactSearchData getSearchData(UserLocatorVO owner)
                         throws FrameworkException
```
    Returns data for searching contacts of the given owner. If no owner is given, it is assumed the logged user.
    
    Throws:
    
    FrameworkException
  - removeByOwnerAndContact
```
@Deprecated
boolean removeByOwnerAndContact(UserLocatorVO owner,
                                @NotNull
                                @NotNull UserLocatorVO contact)
                         throws FrameworkException
```
    Deprecated.
    This method is kept only to support the analogous REST operation. Will be removed in 4.12.
    
    Removes the contact, if exists, for the given owner and contact users. If no owner is given, it is assumed the logged user.
    
    Returns:
    
    Whether a contact was removed
    
    Throws:
    
    FrameworkException
  - search
```
Page<ContactVO> search(ContactQuery query)
                throws FrameworkException
```
    Searches the contacts according to the given query. If the query has no owner it is assumed the logged user.
    
    Throws:
    
    FrameworkException