oracle.ecsf.meta
Class SearchableGroup

java.lang.Object
  oracle.ecsf.meta.SearchableGroup

All Implemented Interfaces:

java.io.Serializable

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

The SearchableGroup represents search related meta data for a business object.

See Also:

Serialized Form

Field Summary

protected static java.util.logging.Logger

sLogger

Constructor Summary

SearchableGroup(java.lang.String name)
Constructs searchable group from a name

Method Summary

void	addSearchableObject(SearchableObject so) Deprecated. if this is used, these objects are not serialized.
void	addSearchableObject(java.lang.String fullName) Associate a searchable object with this searchable group
void	clearSearchObjects()
java.lang.String	getApplId() get the application mId
java.lang.String	getDisplayName() Returns the display name of this searchable group
long	getECSFComponentId() get the remote ECSF server mId for global search
long	getEngineInstanceId()
FieldDefinition	getField(java.lang.String fieldName) Returns named field definition.
FieldDefinition	getFieldByName(java.lang.String fieldName) Returns named field definition.
java.lang.String	getId() Returns mId attribute for this group.
java.lang.String	getName() Get the name of this searchable group
java.lang.String	getScope() get the scope of the search group
java.util.List<java.lang.String>	getSearchableObjectFullNames() Get the names of searchable objects.
java.util.List<SearchableObject>	getSearchableObjects() Get a list of searchable objects for this searchable group
java.lang.String	getSearchEngineReference() Get the search engine reference for this searchable group
boolean	isDeployed()
boolean	isExternal() Return true if this group maps to a data source not created via ECSF, false otherwise
void	setApplId(java.lang.String applId) set the application mId
void	setDeployed(boolean deployed) Returns deploy status of this group.
void	setDisplayName(java.lang.String displayName) Sets the display name of this searchable group
void	setECSFComponentId(long componentId) set the remote ECSF server mId for global search
void	setEngineInstanceId(long seiId)
void	setExternal(boolean isExtern) Sets a boolean to capture if this group contains external sources
void	setId(java.lang.String id) Sets mId for this group.
void	setIsDeployed(boolean deployed)
void	setIsExternal(boolean external) Deprectated use setExertnal instead
void	setScope(java.lang.String scope) set the scope of the search group
void	setSearchEngineReference(java.lang.String seReference) Sets the reference value for this definition in a search engine.

Methods inherited from class java.lang.Object

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

Field Detail

sLogger

protected static java.util.logging.Logger sLogger

Constructor Detail

SearchableGroup

public SearchableGroup(java.lang.String name)

Constructs searchable group from a name

Parameters:

name -

Method Detail

getSearchableObjects

public java.util.List<SearchableObject> getSearchableObjects()

Get a list of searchable objects for this searchable group

Returns:

list of searchable objects.

addSearchableObject

@Deprecated
public void addSearchableObject(SearchableObject so)

Deprecated. if this is used, these objects are not serialized.

Associate a searchable object with this searchable group

Parameters:

so -

addSearchableObject

public void addSearchableObject(java.lang.String fullName)

Associate a searchable object with this searchable group

Parameters:

so - searchable object

clearSearchObjects

public void clearSearchObjects()

getField

public FieldDefinition getField(java.lang.String fieldName)

Returns named field definition.

Parameters:

fieldName - this is the column name (alias name) of the field.

Returns:

a field definition, null if not found.

getFieldByName

public FieldDefinition getFieldByName(java.lang.String fieldName)

Returns named field definition.

Parameters:

fieldName - this is the attribute name (alias name) of the field.

Returns:

a field definition, null if not found.

getName

public java.lang.String getName()

Get the name of this searchable group

Returns:

name

setEngineInstanceId

public void setEngineInstanceId(long seiId)

getEngineInstanceId

public long getEngineInstanceId()

setSearchEngineReference

public void setSearchEngineReference(java.lang.String seReference)

Sets the reference value for this definition in a search engine.

Parameters:

seReference - search engine reference

getSearchEngineReference

public java.lang.String getSearchEngineReference()

Get the search engine reference for this searchable group

Returns:

search enginer reference

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of this searchable group

Parameters:

displayName -

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of this searchable group

Returns:

displayName

setExternal

public void setExternal(boolean isExtern)

Sets a boolean to capture if this group contains external sources

Parameters:

isExtern -

setIsExternal

public void setIsExternal(boolean external)

Deprectated use setExertnal instead

Parameters:

external -

isExternal

public boolean isExternal()

Return true if this group maps to a data source not created via ECSF, false otherwise

Returns:

true if this group is external

setId

public void setId(java.lang.String id)

Sets mId for this group.

Parameters:

id - the new Id

getId

public java.lang.String getId()

Returns mId attribute for this group.

Returns:

group mId.

setApplId

public void setApplId(java.lang.String applId)

set the application mId

Parameters:

applId - an application mId string

getApplId

public java.lang.String getApplId()

get the application mId

Returns:

an application mId 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 componentId)

set the remote ECSF server mId for global search

Parameters:

componentId -

getECSFComponentId

public long getECSFComponentId()

get the remote ECSF server mId for global search

Returns:

componentId

getSearchableObjectFullNames

public java.util.List<java.lang.String> getSearchableObjectFullNames()

Get the names of searchable objects.

Returns:

a list of searchable object names.

setIsDeployed

public void setIsDeployed(boolean deployed)

Parameters:

deployed -

setDeployed

public void setDeployed(boolean deployed)

Returns deploy status of this group.

Parameters:

deployed -

isDeployed

public boolean isDeployed()