com.sap.portal.search.service

Class SearchCategory

java.lang.Object
  extended by com.sap.portal.search.service.SearchCategory

public class SearchCategory
extends Object

This class describes a search category used by the search provider


Constructor Summary
SearchCategory()
          Constructs a new instance
 
Method Summary
 String getDescription()
          Gets the search category Description
 String getID()
          Gets the search category ID
 List<SearchCategory> getSubcategories()
          Gets a list the search category sub categories
 String getTemplate()
          Gets the search category template
 String getTitle()
          Gets the search category Title
 void setDescription(String description)
          Sets the search category description
 void setID(String ID)
          Sets the search category ID
 void setSubcategories(List<SearchCategory> subcategories)
          Sets the search category sub Categories
 void setTemplate(String template)
          Sets the search category template
 void setTitle(String title)
          Sets the search category title
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchCategory

public SearchCategory()
Constructs a new instance

Method Detail

getID

public String getID()
Gets the search category ID

Returns:
The category ID

getTitle

public String getTitle()
Gets the search category Title

Returns:
The category title

getDescription

public String getDescription()
Gets the search category Description

Returns:
The category description that appears in the tooltip

getTemplate

public String getTemplate()
Gets the search category template

Returns:
The template of the navigation URL to the search engine

getSubcategories

public List<SearchCategory> getSubcategories()
Gets a list the search category sub categories

Returns:
A List of SearchCategory objects. Can be empty if no subcategories are defined.

setID

public void setID(String ID)
Sets the search category ID

Parameters:
ID - The category ID

setTitle

public void setTitle(String title)
Sets the search category title

Parameters:
title - The category title

setDescription

public void setDescription(String description)
Sets the search category description

Parameters:
description - The category description that appears in the tooltip

setTemplate

public void setTemplate(String template)
Sets the search category template

Parameters:
template - The template of the navigation URL to the search engine

setSubcategories

public void setSubcategories(List<SearchCategory> subcategories)
Sets the search category sub Categories

Parameters:
subcategories - A List of SearchCategory objects. Can be empty if no subcategories are defined.
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/navigation/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice