oracle.apps.fnd.applcore.globalSearch.ui
Class SearchCategory

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.ui.SearchCategory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchCategory>

public class SearchCategory
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<SearchCategory>

A Search Category, also called a Datasource group.

Author:

David Groves <david.groves@oracle.com>

See Also:

Serialized Form

Constructor Summary

SearchCategory(java.lang.String displayName, java.lang.String name, long searchEngineInstanceId, java.lang.String scope, java.lang.String applId, long globalSearchEngineInstanceId)
Create this Search Category.

Method Summary

int	compareTo(SearchCategory thatCategory) Do comparison of this category to thatCategory based on the lowercase Display name.
boolean	equals(java.lang.Object obj)
java.lang.String	getApplId() Get the application Id.
java.lang.String	getDisplayName() Get the Display Name of the category.
long	getGlobalSearchEngineInstanceId() Get the global search engine instance id (i.e.
java.lang.String	getName() Get the internal name of the category.
java.lang.String	getPK() Get the primary key/unique identifier of this category.
java.lang.String	getScope() Get the Scope.
long	getSearchEngineInstanceId() Get the query federation search engine instance id.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchCategory

public SearchCategory(java.lang.String displayName,
                      java.lang.String name,
                      long searchEngineInstanceId,
                      java.lang.String scope,
                      java.lang.String applId,
                      long globalSearchEngineInstanceId)

Create this Search Category.

Parameters:

displayName - user recognisiable display name.

name - code name.

searchEngineInstanceId - query federation search engine instance id.

scope - GLOBAL or LOCAL scope of group.

applId - application id of group.

globalSearchEngineInstanceId - global (type 2) engine instance.

Method Detail

getPK

public java.lang.String getPK()

Get the primary key/unique identifier of this category.

Returns:

unique identifier.

getDisplayName

public java.lang.String getDisplayName()

Get the Display Name of the category. This value will be shown to the user.

Returns:

display name.

getName

public java.lang.String getName()

Get the internal name of the category. This name must be web safe as it will be used as the internal is in combo boxes etc..

Returns:

name of category.

getScope

public java.lang.String getScope()

Get the Scope.

Returns:

scope, probably GLOBAL or LOCAL.

getApplId

public java.lang.String getApplId()

Get the application Id.

Returns:

application Id.

getSearchEngineInstanceId

public long getSearchEngineInstanceId()

Get the query federation search engine instance id.

Returns:

search engine instance id.

getGlobalSearchEngineInstanceId

public long getGlobalSearchEngineInstanceId()

Get the global search engine instance id (i.e. type 2 instance id).

Returns:

global search engine instance id.

compareTo

public int compareTo(SearchCategory thatCategory)

Do comparison of this category to thatCategory based on the lowercase Display name.

Specified by:

compareTo in interface java.lang.Comparable<SearchCategory>

Parameters:

thatCategory - other category to compare.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object