com.bmc.arsys.api

Class CharacterFieldLimit

java.lang.Object

com.bmc.arsys.api.FieldLimit

com.bmc.arsys.api.CharacterFieldLimit

All Implemented Interfaces:

Serializable, Cloneable

public class CharacterFieldLimit
extends FieldLimit
implements Cloneable, Serializable

The CharacterFieldLimit class defines the value limits for a character field (DataType.CHAR).

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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.

Methods inherited from class com.bmc.arsys.api.FieldLimit

getDataType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CharacterFieldLimit

public CharacterFieldLimit()

CharacterFieldLimit

public CharacterFieldLimit(int max,
                           int menustyle,
                           int qbe,
                           String menu,
                           String pattern,
                           int FTSOption)

Constructs a new CharLimitInfo object

Parameters:

max - 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.

CharacterFieldLimit

public CharacterFieldLimit(int max,
                           int menustyle,
                           int qbe,
                           String menu,
                           String pattern,
                           int FTSOption,
                           int lengthUnits)

Constructs a new CharLimitInfo object

Parameters:

max - 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

CharacterFieldLimit

public CharacterFieldLimit(int max,
                           int menustyle,
                           int qbe,
                           String menu,
                           String pattern,
                           int FTSOption,
                           int lengthUnits,
                           int storageOptionForCLOB)

Constructs a new CharLimitInfo object

Parameters:

max - 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

* @param storageOptionForCLOB 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

Method Detail

setMaxLength

public void setMaxLength(int max)

Sets the maximum field length

setLengthUnits

public void setLengthUnits(int lengthUnits)

Sets the length units. Use one of

• Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
• Constants.AR_LENGTH_UNIT_CHAR -- count in server characters

setStorageOptionForCLOB

public void setStorageOptionForCLOB(int storageOptionForCLOB)

Sets the CLOB Storage Option. Use 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

setMenuStyle

public void setMenuStyle(int menustyle)

Sets the menu style (append or overwrite with new menu selections). Use the following constants:

• Constants.AR_MENU_APPEND -- append/overwrite.
• Constants.AR_MENU_OVERWRITE -- New items dropped from menu

setQBEMatch

public void setQBEMatch(int qbe)

Sets operation to use from QBE type operation. Use the following constants:

• Constants.AR_QBE_MATCH_ANYWHERE -- LIKE "%value%"
• Constants.AR_QBE_MATCH_LEADING -- LIKE "value%"
• Constants.AR_QBE_MATCH_EQUAL -- = "value"

setCharMenu

public void setCharMenu(String menu)

Sets the name of the character menu attached to the field

setPattern

public void setPattern(String pattern)

Sets the field character pattern

setFullTextOption

public void setFullTextOption(int FTSOption)

Sets the Full Text Search option on the field. Use the following constants:

• Constants.AR_FULLTEXT_OPTIONS_NONE
• Constants.AR_FULLTEXT_OPTIONS_INDEXED
• Constants.AR_FULLTEXT_OPTIONS_LITERAL
• Constants.AR_FULLTEXT_OPTIONS_EXCLUDE_FIELD_BASED

getMaxLength

public int getMaxLength()

Returns the maximum field length

getLengthUnits

public 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

getStorageOptionForCLOB

public 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

getMenuStyle

public int getMenuStyle()

Returns the menu style(append or overwrite with new menu selections)

getQBEMatch

public int getQBEMatch()

Returns operation to use from QBE type operation

getCharMenu

public String getCharMenu()

Returns the name of the character menu attached to the field

getPattern

public String getPattern()

Returns the field character pattern

getFullTextOption

public int getFullTextOption()

Returns the Full Text Search option on the field

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class FieldLimit

Throws:

CloneNotSupportedException

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class FieldLimit

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class FieldLimit

Returns:

returns the hash code for this instance

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class FieldLimit

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal