Interface ContactHandler
public interface ContactHandler
This handler provides access to
Contact
objects.- Since:
- 11.26
-
Method Summary
Modifier and TypeMethodDescriptiongetContact
(Call call) getContact
(Ticket ticket) getContactByContactIdentifier
(ContactIdentifier contactIdentifier) This method returns the optionalContact
for aContactIdentifier
.getContactByContactIdentifier
(ContactIdentifier contactIdentifier, Tenant tenant) getContactByID
(Long id) This method returns the optionalContact
of an id.getContactListByContactIdentifier
(ContactIdentifier contactIdentifier) This method returns a list of all contacts matching any of the search criteria of theContactIdentifier
.getContactListByContactIdentifier
(ContactIdentifier contactIdentifier, Tenant tenant) This method returns a list of contacts that are assigned to aTenant
and matching any of the search criteria of theContactIdentifier
.getContactModifier
(Contact contact, Optional<User> user) Build aContactModifier
for the passedContact
object.getContactRelationHandler
(Contact contact, Optional<User> user) Build aContactRelationHandler
for the passedContact
object.getJoinedContactList
(Contact contact) Returns a list of contacts that are joined to the associatedContact
.
-
Method Details
-
getContact
-
getContact
-
getContactByID
-
getContactByContactIdentifier
This method returns the optionalContact
for aContactIdentifier
. If the search criteria of theContactIdentifier
do not match anyContact
the method returns an emptyOptional
.- Parameters:
contactIdentifier
- theContactIdentifier
with the search criteria inside.- Returns:
- the optional
Contact
for aContactIdentifier
, or an emptyOptional
if the search criteria of theContactIdentifier
do not match anyContact
. - Since:
- 12.24
-
getContactListByContactIdentifier
This method returns a list of all contacts matching any of the search criteria of theContactIdentifier
. If more than oneContact
is found, the list is sorted ascending by the contact's id.- Parameters:
contactIdentifier
- theContactIdentifier
with the search criteria inside- Returns:
- the list of matching contacts
- Since:
- 12.24
-
getContactByContactIdentifier
This method returns the optionalContact
for aContactIdentifier
and aTenant
. If the search criteria of theContactIdentifier
and theTenant
do not belong to anyContact
the method returns an emptyOptional
.- Parameters:
contactIdentifier
- theContactIdentifier
with the search criteria insidetenant
- theTenant
assigned to aContact
- Returns:
- the optional
Contact
for aContactIdentifier
and aTenant
, or an emptyOptional
if the search criteria of theContactIdentifier
and the Tenant do not match anyContact
. - Since:
- 12.24
-
getContactListByContactIdentifier
This method returns a list of contacts that are assigned to aTenant
and matching any of the search criteria of theContactIdentifier
. If more than oneContact
is found, the list is sorted ascending by the contact's id.- Parameters:
contactIdentifier
- theContactIdentifier
with the search criteria insidetenant
- theTenant
assigned to aContact
- Returns:
- the list of matching contacts
- Since:
- 12.24
-
getJoinedContactList
Returns a list of contacts that are joined to the associatedContact
. If more than oneContact
is found, the list is sorted ascending by the contact's id.- Parameters:
contact
- theContact
to be used to search for associated contacts- Returns:
- the list of associated contacts
- Since:
- 12.24
-
getContactModifier
Build aContactModifier
for the passedContact
object.- Parameters:
contact
- the instance to modifyuser
- pass a user, if called in a user context. Otherwise pass an empty optional.- Returns:
- a
ContactModifier
associated with theContact
. - Since:
- 12.14
-
getContactRelationHandler
Build aContactRelationHandler
for the passedContact
object.- Parameters:
contact
- the instance to modifyuser
- pass a user, if called in a user context. Otherwise pass an empty optional.- Returns:
- a
ContactRelationHandler
for theContact
. - Since:
- 12.24
-