com.remedy.arsys.api
Class CharLimitInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.FieldLimitInfo
        |
        +--com.remedy.arsys.api.CharLimitInfo

All Implemented Interfaces:

java.lang.Cloneable

public class CharLimitInfo

extends FieldLimitInfo

implements java.lang.Cloneable

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

Constructor Summary

CharLimitInfo(int max, int menustyle, int qbe, NameID menu, java.lang.String pattern, int FTSOption)
Constructs a new CharLimitInfo object

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
NameID	getCharMenu() Returns the name of the character menu attached to the field
int	getFullTextOption() Returns the Full Text Search option on the field
int	getMaxLength() Returns the maximum field length
int	getMenuStyle() Returns the menu style(append or overwrite with new menu selections)
java.lang.String	getPattern() Returns the field character pattern
int	getQBEMatch() Returns operation to use from QBE type operation
void	setCharMenu(NameID 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	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(java.lang.String pattern) Sets the field character pattern
void	setQBEMatch(int qbe) Sets operation to use from QBE type operation.

Methods inherited from class com.remedy.arsys.api.FieldLimitInfo

getDataType

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CharLimitInfo

public CharLimitInfo(int max,
                     int menustyle,
                     int qbe,
                     NameID menu,
                     java.lang.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.

Method Detail

setMaxLength

public void setMaxLength(int max)

Sets the maximum field length

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(NameID menu)

Sets the name of the character menu attached to the field

setPattern

public void setPattern(java.lang.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

getMaxLength

public int getMaxLength()

Returns the maximum field length

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 NameID getCharMenu()

Returns the name of the character menu attached to the field

getPattern

public java.lang.String getPattern()

Returns the field character pattern

getFullTextOption

public int getFullTextOption()

Returns the Full Text Search option on the field

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class FieldLimitInfo