|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface SRLManager
The library of StandardResponse.
Manager of the Standard Response Library.
| Nested Class Summary | |
|---|---|
static class |
SRLManager.ResponseType
This enum lists the possible response types that an agent can work out. |
| Method Summary | |
|---|---|
void |
addSRLListener(SRLListener listener)
Adds a SRLListener to the listener list for events on SRL updates. |
boolean |
addStandardResponseFavorite(java.lang.String user_name,
java.lang.String standard_response_id)
Adds a StandardResponse to the favorites of this
Agent. |
SearchSRLTemplate |
createSearchSRLTemplate()
Creates an empty SearchSRLTemplate instance. |
SearchSRLResult |
findCategoriesResponsesFromRoots(java.lang.Boolean categoryOnly,
SearchSRLTemplate aSearchTemplate)
Returns the IDs of the
StandardResponse and Category instance that belong to the root categories and match
the given filter. |
java.util.Collection |
getCategoriesRoot()
Returns the Collection of the Category. |
Category |
getCategory(java.lang.String category_id)
Returns the Category instance for the given category ID. |
StandardResponse |
getStandardResponse(java.lang.String standard_response_dbid)
Returns the StandardResponse instance for the
given standard response ID (ContactServerID). |
java.util.Collection |
getStandardResponseFavoriteIds(java.lang.String user_name)
Returns the IDs of the
StandardResponse of a specific Agent
as a Collection of Strings. |
java.util.Collection |
getStandardResponseFavorites(java.lang.String user_name)
Returns the StandardResponse of a specific
Agent as a Collection of
Strings. |
java.util.Collection |
getStandardResponses(java.lang.String category_id)
Returns the StandardResponse that belong to the given category. |
void |
removeSRLListener(SRLListener listener)
Removes a SRLListener from the listener list for SRL events. |
boolean |
removeStandardResponseFavorite(java.lang.String user_name,
java.lang.String standard_response_id)
Removes a StandardResponse from the favorites of
this Agent. |
void |
responseUsed(Agent agent,
java.lang.String standardResponseId,
InteractionMultimedia interaction,
SRLManager.ResponseType feedbackType)
Notifies and qualifies the usage of a standard response. |
java.lang.String[] |
searchInStandardResponseFavorites(java.lang.String user_name,
SearchSRLTemplate aSearchTemplate)
Returns the IDs of the
StandardResponse as a Collection of Strings
according to the given filter. |
| Method Detail |
|---|
boolean addStandardResponseFavorite(java.lang.String user_name,
java.lang.String standard_response_id)
StandardResponse to the favorites of this
Agent.
user_name - the name of the Agentstandard_response_id - the ID of the StandardResponse
boolean removeStandardResponseFavorite(java.lang.String user_name,
java.lang.String standard_response_id)
StandardResponse from the favorites of
this Agent.
user_name - the name of the Agentstandard_response_id - the ID of the StandardResponse
java.util.Collection getStandardResponseFavorites(java.lang.String user_name)
StandardResponse of a specific
Agent as a Collection of
Strings.
user_name - the agent, the responses of whom are
requested.
StandardResponsejava.util.Collection getStandardResponseFavoriteIds(java.lang.String user_name)
IDs of the
StandardResponse of a specific Agent
as a Collection of Strings.
user_name - the agent, the response IDs of whom are
requested.
StandardResponse IDs
as String
java.lang.String[] searchInStandardResponseFavorites(java.lang.String user_name,
SearchSRLTemplate aSearchTemplate)
IDs of the
StandardResponse as a Collection of Strings
according to the given filter.
user_name - the agent, the response IDs of whom are requested.aSearchTemplate - a SearchSRLTemplate instance that contains the filter.
StandardResponse IDs
as String, empty if not found, null if error.java.util.Collection getCategoriesRoot()
Collection of the Category.
Categorys.
java.util.Collection getStandardResponses(java.lang.String category_id)
throws RequestFailedException
StandardResponse that belong to the given category.
category_id - the category ID.
StandardResponses
RequestFailedException - if the service cannot fulfill the request.Category getCategory(java.lang.String category_id)
Category instance for the given category ID.
category_id - the category ID.
Category or null.StandardResponse getStandardResponse(java.lang.String standard_response_dbid)
StandardResponse instance for the
given standard response ID (ContactServerID).
standard_response_dbid - the standard response ContactServerID.
StandardResponse or null
void responseUsed(Agent agent,
java.lang.String standardResponseId,
InteractionMultimedia interaction,
SRLManager.ResponseType feedbackType)
agent - the concerned AgentstandardResponseId - the ID of the Standard Responseinteraction - the concerned InteractionMultimediafeedbackType - ResponseType value.
SearchSRLResult findCategoriesResponsesFromRoots(java.lang.Boolean categoryOnly,
SearchSRLTemplate aSearchTemplate)
IDs of the
StandardResponse and Category instance that belong to the root categories and match
the given filter.
categoryOnly - aSearchTemplate - a SearchSRLTemplate that contains the filter.
SearchSRLResult instance according to the categoryOnly parameter:Category IDs and/or,
of StandardResponse ID.SearchSRLTemplate createSearchSRLTemplate()
SearchSRLTemplate instance.
SearchSRLTemplate instance.void addSRLListener(SRLListener listener)
SRLListener to the listener list for events on SRL updates.
void removeSRLListener(SRLListener listener)
SRLListener from the listener list for SRL events.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||