oracle.ifs.server

Class SearchTarget

java.lang.Object

oracle.ifs.server.SearchTarget

public final class SearchTarget
extends Object

A SearchTarget encapsulates the information about a class used for search purposes.

Author:

Dave Long

Constructor Summary

Constructors

Constructor and Description
SearchTarget(Long targetClassId, String alias, boolean isPublic) Constructs an SearchTarget.
SearchTarget(Long targetClassId, String alias, boolean isPublic, String viewName, String className) Constructs an SearchTarget.

Method Summary

Modifier and Type	Method and Description
String	getAlias() Gets the search target alias.
String	getClassName() Gets the class name of the search target.
AttributeValueTable	getSearchTargetTable() Gets the SearchTarget options table.
Long	getTargetClassId() Gets the search target class ID.
String	getViewName() Gets the view name to select against.
boolean	isPublicObjectClass() Gets whether the search target is for a PublicObject.
void	setSearchTargetTable(AttributeValueTable optsTable) Sets the SearchTarget options table.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTarget

public SearchTarget(Long targetClassId,
                    String alias,
                    boolean isPublic)

Constructs an SearchTarget.

Parameters:

targetClassId - the search target class ID

alias - the search target alias

isPublic - whether the search target is for a PublicObject

SearchTarget

public SearchTarget(Long targetClassId,
                    String alias,
                    boolean isPublic,
                    String viewName,
                    String className)

Constructs an SearchTarget.

Parameters:

targetClassId - the search target class ID

alias - the search target alias

isPublic - whether the search target is for a PublicObject

viewName - the view name to select against

className - the search target class name

Method Detail

getTargetClassId

public Long getTargetClassId()

Gets the search target class ID.

Returns:

the search target class ID

getAlias

public String getAlias()

Gets the search target alias.

Returns:

the search target alias.

isPublicObjectClass

public boolean isPublicObjectClass()

Gets whether the search target is for a PublicObject.

Returns:

true if the search target is for a PublicObject; false otherwise

getViewName

public String getViewName()

Gets the view name to select against.

Returns:

the view name to select against.

getClassName

public String getClassName()

Gets the class name of the search target.

Returns:

the class name of the search target.

getSearchTargetTable

public AttributeValueTable getSearchTargetTable()

Gets the SearchTarget options table.

Returns:

the options table

setSearchTargetTable

public void setSearchTargetTable(AttributeValueTable optsTable)

Sets the SearchTarget options table.

Parameters:

optsTable - the SearchTarget options table