Skip navigation links

oracle.imaging
Class Search.ParameterDefinition

java.lang.Object
oracle.imaging.Search.ParameterDefinition

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Search

public static class Search.ParameterDefinition

extends java.lang.Object

implements java.io.Serializable

The ParameterDefinition class defines a parameter that is used to provide dynamic values to the search. The definition provides the defaults and the control values necessary to use a variable parameter.

See Also:

Serialized Form

Nested Class Summary

static class

Search.ParameterDefinition.SearchParameterPk FOR INTERNAL USE ONLY

Field Summary

protected long

searchParameterId

Constructor Summary

Search.ParameterDefinition()
Default Constructor

Search.ParameterDefinition(java.lang.String parameterName)
Convenience constructor

Method Summary

Search.Operator	getDefaultOperator() Gets the default Search.Operator for this parameter.
SearchValue	getDefaultValue() Gets the default SearchValue for this parameter.
java.lang.String	getName() Gets the unique name of this search parameter.
java.lang.String	getOperatorText() Gets the text that is associated with the defined search searchOperator.
PickList	getPicklist()
NameId	getPicklistApplication() Returns the NameId of the Application containing the selected PickList
NameId	getPicklistField() Returns the NameId of the Application$FieldDefinition containing the selected PickList
java.util.List<Search.Operator>	getPossibleOperators() Gets the list of the possible search operators that may be used for this parameter.
java.lang.String	getPrompt() Get the text to display for prompting the user.
protected SearchParameter	getSearchParameter()
boolean	isReadOnly() Tests if this parameter may be updated or is fixed.
boolean	isRequired() Tests if this parameter is required when the search is executed.
protected void	postLoad()
protected void	prePersist()
void	setDefaultOperator(Search.Operator defaultSearchOperator) Sets the default searchOperator for this parameter.
void	setDefaultValue(SearchValue defaultValue) Set the default value of the parameter.
void	setName(java.lang.String parameterId) Sets the unique identification of this search parameter.
void	setOperatorText(java.lang.String operatorText) Sets the text to display for the search searchOperator for this parameter.
void	setPicklist(PickList picklist) FOR INTERNAL USE ONLY
void	setPicklistApplication(NameId picklistApplication) Sets the NameId of the Application that will serve as the PickList for this parameter.
void	setPicklistField(NameId picklistField) Sets the NameId of the Application$FieldDefinition that will serve as the PickList for this parameter.
void	setPossibleOperators(java.util.List<Search.Operator> possibleOperatorsList) Sets the list of available search operators (Search.Operator) for this parameter.
void	setPrompt(java.lang.String promptValue) Sets the text to display for prompting the user.
void	setReadOnly(boolean readOnly) Sets the readOnly flag.
void	setRequired(boolean requiredParameter) Sets the flag indicating whether or not this parameter is required.

Methods inherited from class java.lang.Object

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

Field Detail

searchParameterId

protected long searchParameterId

Constructor Detail

Search.ParameterDefinition

public Search.ParameterDefinition()

Default Constructor

Search.ParameterDefinition

public Search.ParameterDefinition(java.lang.String parameterName)

Convenience constructor

Parameters:

parameterName - The unique identification of this search parameter

Method Detail

prePersist

protected void prePersist()

postLoad

protected void postLoad()

getOperatorText

public java.lang.String getOperatorText()

Gets the text that is associated with the defined search searchOperator.

Returns:

the text to display with the search parameter for the search searchOperator.

getDefaultOperator

public Search.Operator getDefaultOperator()

Gets the default Search.Operator for this parameter.

Returns:

the default Search.Operator for this parameter.

getDefaultValue

public SearchValue getDefaultValue()

Gets the default SearchValue for this parameter.

Returns:

the default value of the parameter. This may return null.

getName

public java.lang.String getName()

Gets the unique name of this search parameter.

Returns:

The name of this search parameter.

getPossibleOperators

public java.util.List<Search.Operator> getPossibleOperators()

Gets the list of the possible search operators that may be used for this parameter.

Returns:

a list of the possible search operators for this search.

getPrompt

public java.lang.String getPrompt()

Get the text to display for prompting the user.

Returns:

The prompt text.

isReadOnly

public boolean isReadOnly()

Tests if this parameter may be updated or is fixed.

Returns:

true if this search parameter is for display only.

isRequired

public boolean isRequired()

Tests if this parameter is required when the search is executed.

Returns:

true if this search parameter is required.

setOperatorText

public void setOperatorText(java.lang.String operatorText)

Sets the text to display for the search searchOperator for this parameter.

Parameters:

operatorText - the searchOperator text to display for this search parameter.

setDefaultOperator

public void setDefaultOperator(Search.Operator defaultSearchOperator)

Sets the default searchOperator for this parameter.

Parameters:

defaultSearchOperator - the default SearchOperator for this search.

setDefaultValue

public void setDefaultValue(SearchValue defaultValue)

Set the default value of the parameter.

Parameters:

defaultValue - the default value.

setName

public void setName(java.lang.String parameterId)

Sets the unique identification of this search parameter.

Parameters:

parameterId - the unique identifier.

setPossibleOperators

public void setPossibleOperators(java.util.List<Search.Operator> possibleOperatorsList)

Sets the list of available search operators (Search.Operator) for this parameter.

Parameters:

possibleOperatorsList - a List of the possible search operators for this parameter.

setPrompt

public void setPrompt(java.lang.String promptValue)

Sets the text to display for prompting the user.

Parameters:

promptValue - the prompt text.

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the readOnly flag.

Parameters:

readOnly - set to true if this search parameter is for display only.

setRequired

public void setRequired(boolean requiredParameter)

Sets the flag indicating whether or not this parameter is required.

Parameters:

requiredParameter - set to true if this search parameter is required.

getPicklistApplication

public NameId getPicklistApplication()

Returns the NameId of the Application containing the selected PickList

Returns:

NameId of the application.

setPicklistApplication

public void setPicklistApplication(NameId picklistApplication)

Sets the NameId of the Application that will serve as the PickList for this parameter.

Parameters:

picklistApplication - NameId of the Application containing the selected PickList

getPicklistField

public NameId getPicklistField()

Returns the NameId of the Application$FieldDefinition containing the selected PickList

Returns:

NameId of the Application$FieldDefinition.

setPicklistField

public void setPicklistField(NameId picklistField)

Sets the NameId of the Application$FieldDefinition that will serve as the PickList for this parameter.

Parameters:

picklistField - NameId of the Application$FieldDefinition containing the selected PickList

setPicklist

public void setPicklist(PickList picklist)

FOR INTERNAL USE ONLY

Parameters:

picklist -

FOR INTERNAL USE ONLY

getPicklist

public PickList getPicklist()

Returns:

the picklist for the parameter

getSearchParameter

protected SearchParameter getSearchParameter()

Skip navigation links