|
Oracle® WebCenter Content Java API Reference for Imaging 11g Release 1 (11.1.1) E12853-03 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.imaging.Search.ParameterDefinition
public static class Search.ParameterDefinition
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.
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 |
---|
protected long searchParameterId
Constructor Detail |
---|
public Search.ParameterDefinition()
public Search.ParameterDefinition(java.lang.String parameterName)
parameterName
- The unique identification of this search parameterMethod Detail |
---|
protected void prePersist()
protected void postLoad()
public java.lang.String getOperatorText()
public Search.Operator getDefaultOperator()
Search.Operator
for this parameter.Search.Operator
for this parameter.public SearchValue getDefaultValue()
SearchValue
for this parameter.null
.public java.lang.String getName()
public java.util.List<Search.Operator> getPossibleOperators()
public java.lang.String getPrompt()
public boolean isReadOnly()
true
if this search parameter is for display only.public boolean isRequired()
true
if this search parameter is required.public void setOperatorText(java.lang.String operatorText)
operatorText
- the searchOperator text to display for this search parameter.public void setDefaultOperator(Search.Operator defaultSearchOperator)
defaultSearchOperator
- the default SearchOperator
for this search.public void setDefaultValue(SearchValue defaultValue)
defaultValue
- the default value.public void setName(java.lang.String parameterId)
parameterId
- the unique identifier.public void setPossibleOperators(java.util.List<Search.Operator> possibleOperatorsList)
Search.Operator
) for this parameter.possibleOperatorsList
- a List
of the possible search operators for this parameter.public void setPrompt(java.lang.String promptValue)
promptValue
- the prompt text.public void setReadOnly(boolean readOnly)
readOnly
- set to true
if this search parameter is for display only.public void setRequired(boolean requiredParameter)
requiredParameter
- set to true
if this search parameter is required.public NameId getPicklistApplication()
NameId
of the Application
containing the selected PickList
NameId
of the application.public void setPicklistApplication(NameId picklistApplication)
NameId
of the Application
that will serve as the PickList
for this parameter.picklistApplication
- NameId
of the Application
containing the selected PickList
public NameId getPicklistField()
NameId
of the Application$FieldDefinition
containing the selected PickList
NameId
of the Application$FieldDefinition
.public void setPicklistField(NameId picklistField)
NameId
of the Application$FieldDefinition
that will serve as the PickList
for this parameter.picklistField
- NameId
of the Application$FieldDefinition
containing the selected PickList
public void setPicklist(PickList picklist)
picklist
-
FOR INTERNAL USE ONLY
public PickList getPicklist()
protected SearchParameter getSearchParameter()
|
Oracle® WebCenter Content Java API Reference for Imaging 11g Release 1 (11.1.1) E12853-03 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |