oracle.ecsf.impl.action
Class SearchAction

java.lang.Object
  oracle.ecsf.impl.action.SearchAction

public class SearchAction
extends java.lang.Object

Field Summary

static java.lang.String	ACTION_TYPE_TASK
static java.lang.String	ACTION_TYPE_URL
protected boolean	mDefault
protected java.lang.String	mName
protected java.lang.String	mTitle
protected java.lang.String	mType

Constructor Summary

SearchAction()

SearchAction(java.lang.String serializedAction)

SearchAction(java.lang.String name, java.lang.String title, java.lang.String overrideTarget, java.util.Map overrideActionParams, boolean isDefault)
Creates a Search Action with overridden url or task params.

SearchAction(java.lang.String name, java.lang.String title, java.lang.String voName, java.util.Map primaryKeys, java.util.Map customAttrs, java.lang.String redirectPrefix, boolean isDefault, java.lang.String actionType)
Creates a Search Action that can be resolved to a url or to task params.

Method Summary

AbstractDocument	getDocument()
static java.util.HashMap	getFilteredStoredAttrs(SearchableObject so, java.util.HashMap<java.lang.String,java.lang.Object> referencedAttrs, java.util.Map storedAttrs) Get a set of stored Attrs that are filtered using the attrs in referencedAttrs.
java.lang.String	getName()
java.lang.String	getRedirectURL()
java.lang.String	getTitle()
java.lang.String	getType()
boolean	isDefault()
java.lang.String	serialize()
void	setDocument(AbstractDocument document)

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_TYPE_URL

public static final java.lang.String ACTION_TYPE_URL

See Also:

Constant Field Values

ACTION_TYPE_TASK

public static final java.lang.String ACTION_TYPE_TASK

See Also:

Constant Field Values

mType

protected java.lang.String mType

mDefault

protected boolean mDefault

mTitle

protected java.lang.String mTitle

mName

protected java.lang.String mName

Constructor Detail

SearchAction

public SearchAction(java.lang.String name,
                    java.lang.String title,
                    java.lang.String overrideTarget,
                    java.util.Map overrideActionParams,
                    boolean isDefault)

Creates a Search Action with overridden url or task params. Can be called by search post query process plugin, to create search actions it can set in search hits. Either overrideURL or overrideTaskParams should be non-null. The other should be null.

Parameters:

name -

title -

overrideTarget -

overrideActionParams -

isDefault -

SearchAction

public SearchAction(java.lang.String name,
                    java.lang.String title,
                    java.lang.String voName,
                    java.util.Map primaryKeys,
                    java.util.Map customAttrs,
                    java.lang.String redirectPrefix,
                    boolean isDefault,
                    java.lang.String actionType)

Creates a Search Action that can be resolved to a url or to task params.

Parameters:

name -

title -

voName -

primaryKeys -

customAttrs -

redirectPrefix -

isDefault -

actionType -

SearchAction

public SearchAction()

SearchAction

public SearchAction(java.lang.String serializedAction)

Method Detail

getFilteredStoredAttrs

public static java.util.HashMap getFilteredStoredAttrs(SearchableObject so,
                                                       java.util.HashMap<java.lang.String,java.lang.Object> referencedAttrs,
                                                       java.util.Map storedAttrs)

Get a set of stored Attrs that are filtered using the attrs in referencedAttrs.

Parameters:

so -

referencedAttrs -

storedAttrs -

Returns:

HashMap of stored attrs/values.

getName

public java.lang.String getName()

getType

public java.lang.String getType()

getTitle

public java.lang.String getTitle()

getRedirectURL

public java.lang.String getRedirectURL()
                                throws SearchException

Throws:

SearchException

isDefault

public boolean isDefault()

serialize

public java.lang.String serialize()
                           throws SearchException

Throws:

SearchException

setDocument

public void setDocument(AbstractDocument document)

getDocument

public AbstractDocument getDocument()