com.ibm.websphere.wim.model
Interface SearchControl

All Superinterfaces:
Control, PropertyControl
All Known Subinterfaces:
AncestorControl, DescendantControl, GroupControl, GroupMemberControl, GroupMembershipControl, HierarchyControl, LoginControl

public interface SearchControl
extends PropertyControl

A representation of the model object 'Search Control'.

The following features are supported:

See Also:
ModelPackage.getSearchControl()
Model:
Generated:

Method Summary
 int getCountLimit()
          Returns the value of the 'Count Limit' attribute.
 java.lang.String getExpression()
          Returns the value of the 'Expression' attribute.
 java.util.List getSearchBases()
          Returns the value of the 'Search Bases' attribute list.
 int getSearchLimit()
          Returns the value of the 'Search Limit' attribute.
 int getTimeLimit()
          Returns the value of the 'Time Limit' attribute.
 boolean isReturnSubType()
          Returns the value of the 'Return Sub Type' attribute.
 boolean isSetCountLimit()
          Returns whether the value of the 'Count Limit' attribute is set.
 boolean isSetReturnSubType()
          Returns whether the value of the 'Return Sub Type' attribute is set.
 boolean isSetSearchLimit()
          Returns whether the value of the 'Search Limit' attribute is set.
 boolean isSetTimeLimit()
          Returns whether the value of the 'Time Limit' attribute is set.
 void setCountLimit(int value)
          Sets the value of the 'Count Limit' attribute.
 void setExpression(java.lang.String value)
          Sets the value of the 'Expression' attribute.
 void setReturnSubType(boolean value)
          Sets the value of the 'Return Sub Type' attribute.
 void setSearchLimit(int value)
          Sets the value of the 'Search Limit' attribute.
 void setTimeLimit(int value)
          Sets the value of the 'Time Limit' attribute.
 void unsetCountLimit()
          Unsets the value of the 'Count Limit' attribute.
 void unsetReturnSubType()
          Unsets the value of the 'Return Sub Type' attribute.
 void unsetSearchLimit()
          Unsets the value of the 'Search Limit' attribute.
 void unsetTimeLimit()
          Unsets the value of the 'Time Limit' attribute.
 
Methods inherited from interface com.ibm.websphere.wim.model.PropertyControl
getContextProperties, getProperties
 

Method Detail

getSearchBases

java.util.List getSearchBases()
Returns the value of the 'Search Bases' attribute list. The list contents are of type String.

See Also:
ModelPackage.getSearchControl_SearchBases()
Model:
type="java.lang.String" unique="false" dataType="org.eclipse.emf.ecore.xml.type.String"
Generated:
Return:
the value of the 'Search Bases' attribute list.

getCountLimit

int getCountLimit()
Returns the value of the 'Count Limit' attribute.

See Also:
isSetCountLimit(), unsetCountLimit(), setCountLimit(int), ModelPackage.getSearchControl_CountLimit()
Model:
unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Int"
Generated:
Return:
the value of the 'Count Limit' attribute.

setCountLimit

void setCountLimit(int value)
Sets the value of the 'Count Limit' attribute.

Parameters:
value - the new value of the 'Count Limit' attribute.
See Also:
isSetCountLimit(), unsetCountLimit(), getCountLimit()
Generated:

unsetCountLimit

void unsetCountLimit()
Unsets the value of the 'Count Limit' attribute.

See Also:
isSetCountLimit(), getCountLimit(), setCountLimit(int)
Generated:

isSetCountLimit

boolean isSetCountLimit()
Returns whether the value of the 'Count Limit' attribute is set.

See Also:
unsetCountLimit(), getCountLimit(), setCountLimit(int)
Generated:
Return:
whether the value of the 'Count Limit' attribute is set.

getExpression

java.lang.String getExpression()
Returns the value of the 'Expression' attribute.

See Also:
setExpression(String), ModelPackage.getSearchControl_Expression()
Model:
unique="false" dataType="org.eclipse.emf.ecore.xml.type.String"
Generated:
Return:
the value of the 'Expression' attribute.

setExpression

void setExpression(java.lang.String value)
Sets the value of the 'Expression' attribute.

Parameters:
value - the new value of the 'Expression' attribute.
See Also:
getExpression()
Generated:

isReturnSubType

boolean isReturnSubType()
Returns the value of the 'Return Sub Type' attribute. The default value is "true".

See Also:
isSetReturnSubType(), unsetReturnSubType(), setReturnSubType(boolean), ModelPackage.getSearchControl_ReturnSubType()
Model:
default="true" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean"
Generated:
Return:
the value of the 'Return Sub Type' attribute.

setReturnSubType

void setReturnSubType(boolean value)
Sets the value of the 'Return Sub Type' attribute.

Parameters:
value - the new value of the 'Return Sub Type' attribute.
See Also:
isSetReturnSubType(), unsetReturnSubType(), isReturnSubType()
Generated:

unsetReturnSubType

void unsetReturnSubType()
Unsets the value of the 'Return Sub Type' attribute.

See Also:
isSetReturnSubType(), isReturnSubType(), setReturnSubType(boolean)
Generated:

isSetReturnSubType

boolean isSetReturnSubType()
Returns whether the value of the 'Return Sub Type' attribute is set.

See Also:
unsetReturnSubType(), isReturnSubType(), setReturnSubType(boolean)
Generated:
Return:
whether the value of the 'Return Sub Type' attribute is set.

getSearchLimit

int getSearchLimit()
Returns the value of the 'Search Limit' attribute.

See Also:
isSetSearchLimit(), unsetSearchLimit(), setSearchLimit(int), ModelPackage.getSearchControl_SearchLimit()
Model:
unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Int"
Generated:
Return:
the value of the 'Search Limit' attribute.

setSearchLimit

void setSearchLimit(int value)
Sets the value of the 'Search Limit' attribute.

Parameters:
value - the new value of the 'Search Limit' attribute.
See Also:
isSetSearchLimit(), unsetSearchLimit(), getSearchLimit()
Generated:

unsetSearchLimit

void unsetSearchLimit()
Unsets the value of the 'Search Limit' attribute.

See Also:
isSetSearchLimit(), getSearchLimit(), setSearchLimit(int)
Generated:

isSetSearchLimit

boolean isSetSearchLimit()
Returns whether the value of the 'Search Limit' attribute is set.

See Also:
unsetSearchLimit(), getSearchLimit(), setSearchLimit(int)
Generated:
Return:
whether the value of the 'Search Limit' attribute is set.

getTimeLimit

int getTimeLimit()
Returns the value of the 'Time Limit' attribute. The default value is "0".

See Also:
isSetTimeLimit(), unsetTimeLimit(), setTimeLimit(int), ModelPackage.getSearchControl_TimeLimit()
Model:
default="0" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Int"
Generated:
Return:
the value of the 'Time Limit' attribute.

setTimeLimit

void setTimeLimit(int value)
Sets the value of the 'Time Limit' attribute.

Parameters:
value - the new value of the 'Time Limit' attribute.
See Also:
isSetTimeLimit(), unsetTimeLimit(), getTimeLimit()
Generated:

unsetTimeLimit

void unsetTimeLimit()
Unsets the value of the 'Time Limit' attribute.

See Also:
isSetTimeLimit(), getTimeLimit(), setTimeLimit(int)
Generated:

isSetTimeLimit

boolean isSetTimeLimit()
Returns whether the value of the 'Time Limit' attribute is set.

See Also:
unsetTimeLimit(), getTimeLimit(), setTimeLimit(int)
Generated:
Return:
whether the value of the 'Time Limit' attribute is set.