com.genesyslab.ail.srl
Interface Category

All Superinterfaces:
IdObject

public interface Category
extends IdObject

A facility for the agent to categorize InteractionMailIn/InteractionMailOut or modify/update categorization made by the system (on InteractionMailIn).


Nested Class Summary
static class Category.Type
          Constants that describe the different types of categories.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 java.lang.String[] findCategories(SearchSRLTemplate aSearchTemplate)
          Returns the IDs of the Category as a Collection of Strings according to the filter.
 SearchSRLResult findCategoriesAndResponses(SearchSRLTemplate aSearchTemplate)
          Returns the IDs of the StandardResponse and Category as a SearchSRLResult according to the filter.
 java.lang.String[] findResponses(SearchSRLTemplate aSearchTemplate)
          Returns the IDs of the StandardResponse as a Collection of Strings according to the filter.
 java.util.Collection<Category> getChildrenCategories()
          Returns the child categories of this category as a Collection of Category.
 java.lang.String getDescription()
          Returns the description of this category as a String.
 java.lang.String getLang()
          Returns the language of this category as a String.
 java.util.Date getModifiedDate()
          Returns the modified date of this category as a Date.
 java.lang.String getName()
          Returns the name of this category as a String.
 java.lang.Integer getOwnerId()
          Returns the owner ID of this category as an Integer.
 Category getParentCategory()
          Returns the parent category of this category as a Category.
 java.util.Collection<StandardResponse> getStandardResponses()
          Returns the category standard responses of this category as a Collection of StandardResponses.
 java.lang.String getStatus()
          Returns the status of this category as a String.
 java.lang.Integer getTenantId()
          Returns the tenant ID of this category as an Integer.
 Category.Type getType()
          Returns the type of this category as a Category.Type.
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getParentCategory

Category getParentCategory()
Returns the parent category of this category as a Category.

Returns:
Category or null if it does not exist.

getChildrenCategories

java.util.Collection<Category> getChildrenCategories()
Returns the child categories of this category as a Collection of Category.

Returns:
Collection of Category.

getStandardResponses

java.util.Collection<StandardResponse> getStandardResponses()
Returns the category standard responses of this category as a Collection of StandardResponses.

Returns:
Collection of StandardResponse.

getDescription

java.lang.String getDescription()
Returns the description of this category as a String.

Returns:
a description as String.

getModifiedDate

java.util.Date getModifiedDate()
Returns the modified date of this category as a Date.

Returns:
a date as Date.

getName

java.lang.String getName()
Returns the name of this category as a String.

Returns:
the name of the category as String.

getStatus

java.lang.String getStatus()
Returns the status of this category as a String. Status can be: "Approved" or "Not Approved".

Returns:
status as String.

getType

Category.Type getType()
Returns the type of this category as a Category.Type.

Returns:
type as Type.

getOwnerId

java.lang.Integer getOwnerId()
Returns the owner ID of this category as an Integer.

Returns:
ownerId as Integer.

getTenantId

java.lang.Integer getTenantId()
Returns the tenant ID of this category as an Integer.

Returns:
tenantId as Integer.

getLang

java.lang.String getLang()
Returns the language of this category as a String.

Returns:
language as String.

findCategories

java.lang.String[] findCategories(SearchSRLTemplate aSearchTemplate)
Returns the IDs of the Category as a Collection of Strings according to the filter.

Parameters:
aSearchTemplate - a SearchSRLTemplate that contains the filter.
Returns:
array of Category IDs as String, empty if not found, null if error.
Since:
7.5

findResponses

java.lang.String[] findResponses(SearchSRLTemplate aSearchTemplate)
Returns the IDs of the StandardResponse as a Collection of Strings according to the filter.

Parameters:
aSearchTemplate - a SearchSRLTemplate that contains the filter.
Returns:
array of StandardResponse IDs as String, empty if not found, null if error.
Since:
7.5

findCategoriesAndResponses

SearchSRLResult findCategoriesAndResponses(SearchSRLTemplate aSearchTemplate)
Returns the IDs of the StandardResponse and Category as a SearchSRLResult according to the filter.

Parameters:
aSearchTemplate - a SearchSRLTemplate that contains the filter.
Returns:
a SearchSRLResult instance that contains: - array of Category IDs and/or, - array of StandardResponse ID. empty if not found, null if error.
Since:
7.5