org.sakaiproject.citation.impl

Class BaseSearchManager.BasicSearchDatabaseHierarchy.BasicSearchCategory

java.lang.Object

org.sakaiproject.citation.impl.BaseSearchManager.BasicSearchDatabaseHierarchy.BasicSearchCategory

All Implemented Interfaces:

org.sakaiproject.citation.api.SearchCategory

Enclosing class:

BaseSearchManager.BasicSearchDatabaseHierarchy

public class BaseSearchManager.BasicSearchDatabaseHierarchy.BasicSearchCategory
extends Object
implements org.sakaiproject.citation.api.SearchCategory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSearchManager.BasicSearchDatabaseHierarchy.BasicSearchCategory(String name, String id) BasicSearchCategory constructor creates a BasicSearchCategory with the given name and id

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAlternateDatabase(org.sakaiproject.citation.api.SearchDatabase altDatabase)
protected void	addDatabase(String databaseId)
protected void	addRecommendedDatabase(String databaseId)
protected void	addSubcategory(org.sakaiproject.citation.api.SearchCategory subcategory)
List<org.sakaiproject.citation.api.SearchDatabase>	getDatabases()
String	getDescription()
String	getDisplayName()
String	getId()
List<org.sakaiproject.citation.api.SearchCategory>	getSubCategories()
boolean	hasDatabases()
boolean	hasSubCategories()
boolean	isDatabaseRecommended(String databaseId)
protected boolean	isDefault()
protected void	setDefault(boolean value)
protected void	updateDescription(String description)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseSearchManager.BasicSearchDatabaseHierarchy.BasicSearchCategory

protected BaseSearchManager.BasicSearchDatabaseHierarchy.BasicSearchCategory(String name,
                                                                  String id)

BasicSearchCategory constructor creates a BasicSearchCategory with the given name and id

Parameters:

name - display name for this category

id - unique identifier for this category

Method Detail

updateDescription

protected void updateDescription(String description)

addSubcategory

protected void addSubcategory(org.sakaiproject.citation.api.SearchCategory subcategory)

addDatabase

protected void addDatabase(String databaseId)

addRecommendedDatabase

protected void addRecommendedDatabase(String databaseId)

addAlternateDatabase

protected void addAlternateDatabase(org.sakaiproject.citation.api.SearchDatabase altDatabase)

setDefault

protected void setDefault(boolean value)

isDefault

protected boolean isDefault()

hasDatabases

public boolean hasDatabases()

Specified by:

hasDatabases in interface org.sakaiproject.citation.api.SearchCategory

getDatabases

public List<org.sakaiproject.citation.api.SearchDatabase> getDatabases()

Specified by:

getDatabases in interface org.sakaiproject.citation.api.SearchCategory

getDescription

public String getDescription()

Specified by:

getDescription in interface org.sakaiproject.citation.api.SearchCategory

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface org.sakaiproject.citation.api.SearchCategory

getId

public String getId()

Specified by:

getId in interface org.sakaiproject.citation.api.SearchCategory

hasSubCategories

public boolean hasSubCategories()

Specified by:

hasSubCategories in interface org.sakaiproject.citation.api.SearchCategory

getSubCategories

public List<org.sakaiproject.citation.api.SearchCategory> getSubCategories()

Specified by:

getSubCategories in interface org.sakaiproject.citation.api.SearchCategory

isDatabaseRecommended

public boolean isDatabaseRecommended(String databaseId)

Specified by:

isDatabaseRecommended in interface org.sakaiproject.citation.api.SearchCategory