com.dotmarketing.portlets.structure.business
Interface FieldAPI

All Known Implementing Classes:
FieldAPIImpl

public interface FieldAPI

Since:
1.6
Author:
Jason Tesser

Field Summary
static java.lang.String ELEMENT_CONSTANT
           
static java.lang.String ELEMENT_DIVIDER
           
static java.lang.String ELEMENT_FIELD
           
static java.lang.String ELEMENT_TAB
           
 
Method Summary
 boolean isAnalyze(Field field)
          Should the field be analyzed in the index
 boolean isElementConstant(Field field)
          A field that is a constant
 boolean isElementDivider(Field field)
          A field that is a divider element like Line or tab divider
 boolean isElementdotCMSTab(Field field)
          A field that is a divider element like Line or tab divider
 boolean isNumeric(Field field)
          Use to determine if the field has a numeric value.
 boolean isString(Field field)
          Use to determine if the field has a numeric value.
 boolean valueSettable(Field field)
           
 

Field Detail

ELEMENT_FIELD

static final java.lang.String ELEMENT_FIELD
See Also:
Constant Field Values

ELEMENT_DIVIDER

static final java.lang.String ELEMENT_DIVIDER
See Also:
Constant Field Values

ELEMENT_TAB

static final java.lang.String ELEMENT_TAB
See Also:
Constant Field Values

ELEMENT_CONSTANT

static final java.lang.String ELEMENT_CONSTANT
See Also:
Constant Field Values
Method Detail

valueSettable

boolean valueSettable(Field field)

isNumeric

boolean isNumeric(Field field)
Use to determine if the field has a numeric value.

Parameters:
field -
Returns:

isString

boolean isString(Field field)
Use to determine if the field has a numeric value.

Parameters:
field -
Returns:

isElementDivider

boolean isElementDivider(Field field)
A field that is a divider element like Line or tab divider

Parameters:
field -
Returns:

isElementConstant

boolean isElementConstant(Field field)
A field that is a constant

Parameters:
field -
Returns:

isElementdotCMSTab

boolean isElementdotCMSTab(Field field)
A field that is a divider element like Line or tab divider

Parameters:
field -
Returns:

isAnalyze

boolean isAnalyze(Field field)
Should the field be analyzed in the index

Parameters:
field -
Returns:


Copyright © 2010 dotCMS Inc. All Rights Reserved.