public class CharacterFieldLimit extends FieldLimit implements Cloneable, Serializable
CharacterFieldLimit
class defines the value limits for a character field (DataType.CHAR
)
.Constructor and Description |
---|
CharacterFieldLimit() |
CharacterFieldLimit(int max,
int menustyle,
int qbe,
String menu,
String pattern,
int FTSOption)
Constructs a new
CharLimitInfo object |
CharacterFieldLimit(int max,
int menustyle,
int qbe,
String menu,
String pattern,
int FTSOption,
int lengthUnits)
Constructs a new
CharLimitInfo object |
CharacterFieldLimit(int max,
int menustyle,
int qbe,
String menu,
String pattern,
int FTSOption,
int lengthUnits,
int storageOptionForCLOB)
Constructs a new
CharLimitInfo object |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Clone implementation that returns an Object with data cloned from self
|
boolean |
equals(Object obj)
Use this method for checking equality between the current object and the
provided one.
|
String |
getCharMenu()
Returns the name of the character menu attached to the field
|
int |
getFullTextOption()
Returns the Full Text Search option on the field
|
int |
getLengthUnits()
Returns the field length unit, one of
Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
Constants.AR_LENGTH_UNIT_CHAR -- count in server characters
|
int |
getMaxLength()
Returns the maximum field length
|
int |
getMenuStyle()
Returns the menu style(append or overwrite with new menu selections)
|
String |
getPattern()
Returns the field character pattern
|
int |
getQBEMatch()
Returns operation to use from QBE type operation
|
int |
getStorageOptionForCLOB()
Returns the CLOB Storage Option, one of
Constants.AR_STORE_OPT_DEF -- Default - Use the Server's Default Behavior
Constants.AR_STORE_OPT_INROW -- In-Row
Constants.AR_STORE_OPT_OUTROW -- Out-of-Row
|
int |
hashCode()
Returns the hash code value for this instance of the current class.
|
void |
setCharMenu(String menu)
Sets the name of the character menu attached to the field
|
void |
setFullTextOption(int FTSOption)
Sets the Full Text Search option on the field.
|
void |
setLengthUnits(int lengthUnits)
Sets the length units.
|
void |
setMaxLength(int max)
Sets the maximum field length
|
void |
setMenuStyle(int menustyle)
Sets the menu style (append or overwrite with new menu selections).
|
void |
setPattern(String pattern)
Sets the field character pattern
|
void |
setQBEMatch(int qbe)
Sets operation to use from QBE type operation.
|
void |
setStorageOptionForCLOB(int storageOptionForCLOB)
Sets the CLOB Storage Option.
|
String |
toString()
Returns a string description of the object.
|
getDataType
public CharacterFieldLimit()
public CharacterFieldLimit(int max, int menustyle, int qbe, String menu, String pattern, int FTSOption)
CharLimitInfo
objectmax
- Maximum field length. Specify zero to indicate no maximum.menustyle
- Value to indicate whether selecting from a menu appends or overwrites text already in the field.qbe
- Default query-by-example qualification type.menu
- Name of character menu to attach.pattern
- Field character pattern.FTSOption
- Value to indicate whether field is indexed for Full Text Search.public CharacterFieldLimit(int max, int menustyle, int qbe, String menu, String pattern, int FTSOption, int lengthUnits)
CharLimitInfo
objectmax
- Maximum field length. Specify zero to indicate no maximum.menustyle
- Value to indicate whether selecting from a menu appends or overwrites text already in the field.qbe
- Default query-by-example qualification type.menu
- Name of character menu to attach.pattern
- Field character pattern.FTSOption
- Value to indicate whether field is indexed for Full Text Search.lengthUnits
- Server's field length unit, one of
Constants.AR_LENGTH_UNIT_BYTE
-- count in bytes
Constants.AR_LENGTH_UNIT_CHAR
-- count in server characters
public CharacterFieldLimit(int max, int menustyle, int qbe, String menu, String pattern, int FTSOption, int lengthUnits, int storageOptionForCLOB)
CharLimitInfo
objectmax
- Maximum field length. Specify zero to indicate no maximum.menustyle
- Value to indicate whether selecting from a menu appends or overwrites text already in the field.qbe
- Default query-by-example qualification type.menu
- Name of character menu to attach.pattern
- Field character pattern.FTSOption
- Value to indicate whether field is indexed for Full Text Search.lengthUnits
- Server's field length unit, one of
Constants.AR_LENGTH_UNIT_BYTE
-- count in bytes
Constants.AR_LENGTH_UNIT_CHAR
-- count in server characters
Constants.AR_STORE_OPT_DEF
-- Default - Use the Server's Default Behavior
Constants.AR_STORE_OPT_INROW
-- In-Row
Constants.AR_STORE_OPT_OUTROW
-- Out-of-Row
public void setMaxLength(int max)
public void setLengthUnits(int lengthUnits)
Constants.AR_LENGTH_UNIT_BYTE
-- count in bytes
Constants.AR_LENGTH_UNIT_CHAR
-- count in server characters
public void setStorageOptionForCLOB(int storageOptionForCLOB)
Constants.AR_STORE_OPT_DEF
-- Default - Use the Server's Default Behavior
Constants.AR_STORE_OPT_INROW
-- In-Row
Constants.AR_STORE_OPT_OUTROW
-- Out-of-Row
public void setMenuStyle(int menustyle)
Constants.AR_MENU_APPEND
-- append/overwrite.
Constants.AR_MENU_OVERWRITE
-- New items dropped from menu
public void setQBEMatch(int qbe)
Constants.AR_QBE_MATCH_ANYWHERE
-- LIKE "%value%"
Constants.AR_QBE_MATCH_LEADING
-- LIKE "value%"
Constants.AR_QBE_MATCH_EQUAL
-- = "value"
public void setCharMenu(String menu)
public void setPattern(String pattern)
public void setFullTextOption(int FTSOption)
public int getMaxLength()
public int getLengthUnits()
Constants.AR_LENGTH_UNIT_BYTE
-- count in bytes
Constants.AR_LENGTH_UNIT_CHAR
-- count in server characters
public int getStorageOptionForCLOB()
Constants.AR_STORE_OPT_DEF
-- Default - Use the Server's Default Behavior
Constants.AR_STORE_OPT_INROW
-- In-Row
Constants.AR_STORE_OPT_OUTROW
-- Out-of-Row
public int getMenuStyle()
public int getQBEMatch()
public String getCharMenu()
public String getPattern()
public int getFullTextOption()
public Object clone() throws CloneNotSupportedException
clone
in class FieldLimit
CloneNotSupportedException
public String toString()
toString
in class FieldLimit
public int hashCode()
hashCode
in class FieldLimit
public boolean equals(Object obj)
equals
in class FieldLimit
obj
- the object that we are comparing to? Copyright 2013 BMC Software, Inc.