oracle.ecsf.client
Class SearchGroup

java.lang.Object
  oracle.ecsf.client.SearchGroup

All Implemented Interfaces:

java.io.Serializable

public class SearchGroup
extends java.lang.Object
implements java.io.Serializable

SearchGroup defines meta data used by the client that represents the properties of a searchable group.

See Also:

Serialized Form

Constructor Summary

SearchGroup(java.lang.String name, java.lang.String displayName, long seiId)
Deprecated. instead, use SearchCtrl.getSearchGroup.

SearchGroup(java.lang.String name, java.lang.String displayName, long seiId, java.lang.String applId, java.lang.String scope)
a constructor

SearchGroup(java.lang.String name, java.lang.String displayName, long seiId, java.lang.String applId, java.lang.String scope, long ecsfComponentId)
a constructor

Method Summary

void	addAttribute(java.lang.String attr, java.lang.String dataType) Adds attribute mName and dataType pairs to the attribute Map
java.lang.String	getApplId() get the application id
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns a map of attribute mName and data type pairs for an advanced search SearchGroup
java.lang.String	getComponentName()
java.lang.String	getDisplayName() Returns the display mName of the search group
long	getECSFComponentId() get the remote ECSF server id for global search
java.lang.String	getName() Returns the mName of the search group
java.lang.String	getScope() get the scope of the search group
long	getSearchEngineInstanceId() Returns the search engine instance id of the search group
boolean	isEqual(SearchGroup group) Equals only if name and engine instance id are the same.
void	setApplId(java.lang.String applId) set the application id
void	setComponentName(java.lang.String componentName)
void	setECSFComponentId(long compId)
void	setScope(java.lang.String scope) set the scope of the search group
void	setSearchEngineInstanceId(long engineInstanceId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchGroup

public SearchGroup(java.lang.String name,
                   java.lang.String displayName,
                   long seiId)

Deprecated. instead, use SearchCtrl.getSearchGroup.

a constructor

Parameters:

name - a search group name string

displayName - the display name of a search group

seiId - an id of the containing search engine instance

See Also:

for more details

SearchGroup

public SearchGroup(java.lang.String name,
                   java.lang.String displayName,
                   long seiId,
                   java.lang.String applId,
                   java.lang.String scope)

a constructor

Parameters:

name - a search group name string

displayName - the display name of a search group

seiId - an id of the containing search engine instance

applId - an application id string

scope - a scope string. It can only be either "GLOBAL" or "LOCAL"

SearchGroup

public SearchGroup(java.lang.String name,
                   java.lang.String displayName,
                   long seiId,
                   java.lang.String applId,
                   java.lang.String scope,
                   long ecsfComponentId)

a constructor

Parameters:

name - a search group name string

displayName - the display name of a search group

seiId - an id of the containing search engine instance

applId - an application id string

scope - a scope string. It can only be either "GLOBAL" or "LOCAL"

ecsfComponentId - remote ECSF server id for global search

Method Detail

getName

public java.lang.String getName()

Returns the mName of the search group

Returns:

String mName

getDisplayName

public java.lang.String getDisplayName()

Returns the display mName of the search group

Returns:

String display mName

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Returns a map of attribute mName and data type pairs for an advanced search SearchGroup

Returns:

Map< String,String>

getSearchEngineInstanceId

public long getSearchEngineInstanceId()

Returns the search engine instance id of the search group

Returns:

searchEngineInstanceId

setSearchEngineInstanceId

public void setSearchEngineInstanceId(long engineInstanceId)

addAttribute

public void addAttribute(java.lang.String attr,
                         java.lang.String dataType)

Adds attribute mName and dataType pairs to the attribute Map

Parameters:

attr - attribute Name

dataType - data type

setApplId

public void setApplId(java.lang.String applId)

set the application id

Parameters:

applId - an application id string

getApplId

public java.lang.String getApplId()

get the application id

Returns:

an application id string

setScope

public void setScope(java.lang.String scope)

set the scope of the search group

Parameters:

scope - a scope string

getScope

public java.lang.String getScope()

get the scope of the search group

Returns:

a scope string

setECSFComponentId

public void setECSFComponentId(long compId)

getECSFComponentId

public long getECSFComponentId()

get the remote ECSF server id for global search

Returns:

id

isEqual

public boolean isEqual(SearchGroup group)

Equals only if name and engine instance id are the same.

Parameters:

group - The group to be tested.

Returns:

ture if two groups equal.

setComponentName

public void setComponentName(java.lang.String componentName)

getComponentName

public java.lang.String getComponentName()