com.bmc.cmdb.api
Class CMDBCharLimit

java.lang.Object
  com.bmc.cmdb.api.CMDBAttributeLimit
      com.bmc.cmdb.api.CMDBCharLimit

public class CMDBCharLimit
extends CMDBAttributeLimit

The CMDBCharLimit class defines the limit of a character attribute.

Field Summary

Fields inherited from class com.bmc.cmdb.api.CMDBAttributeLimit

CMDB_ATTR_DATA_TYPE_ATTACH, CMDB_ATTR_DATA_TYPE_ATTACH_POOL, CMDB_ATTR_DATA_TYPE_CHAR, CMDB_ATTR_DATA_TYPE_CURRENCY, CMDB_ATTR_DATA_TYPE_DATE, CMDB_ATTR_DATA_TYPE_DECIMAL, CMDB_ATTR_DATA_TYPE_DIARY, CMDB_ATTR_DATA_TYPE_ENUM, CMDB_ATTR_DATA_TYPE_INTEGER, CMDB_ATTR_DATA_TYPE_NULL, CMDB_ATTR_DATA_TYPE_REAL, CMDB_ATTR_DATA_TYPE_TIME, CMDB_ATTR_DATA_TYPE_TIME_OF_DAY

Constructor Summary

CMDBCharLimit()
Default constructor that creates a character attribute limit with a maximum length of 254 characters.

CMDBCharLimit(int maxCharLength)
Creates a character attribute limit with the specified limit information.

CMDBCharLimit(int maxCharLength, java.lang.String formatString)
Creates a String selection attribute limit.

CMDBCharLimit(int maxCharLength, java.lang.String formatString, java.lang.String charMenu, int menuStyle, java.lang.String pattern, int qbeOption, int ftsOption)
Creates a character type attribute limit.

Method Summary

java.lang.String	getCharMenu() Gets the name of the AR System character menu attached to the underlying field of this attribute.
java.lang.String	getFormat() Gets the format of the character attribute limit.
int	getFTSOption() Gets the FTS option
int	getMaxCharLength() Gets the maximum length of the character attribute limit.
int	getMenuStyle() Gets the menu style.
java.lang.String	getPattern() Gets the pattern for the underlying field of this attribute
int	getQBEOption() Gets the QBE option
void	setCharMenu(java.lang.String charMenu) Sets the name of the AR System character menu attached to the underlying field of this attribute.
void	setFormat(java.lang.String formatString) Sets the format of the character attribute limit.
void	setFTSOption(int ftsOption) Sets the FTS option
void	setMaxCharLength(int maxCharLength) Sets the maximum length of the character attribute limit.
void	setMenuStyle(int menuStyle) Sets the menu style.
void	setPattern(java.lang.String pattern) Sets the pattern for the underlying field of this attribute
void	setQBEOption(int qbeOption) Sets the QBE option

Methods inherited from class com.bmc.cmdb.api.CMDBAttributeLimit

getDataType

Methods inherited from class java.lang.Object

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

Constructor Detail

CMDBCharLimit

public CMDBCharLimit()

Default constructor that creates a character attribute limit with a maximum length of 254 characters.

CMDBCharLimit

public CMDBCharLimit(int maxCharLength)

Creates a character attribute limit with the specified limit information.

Parameters:

maxCharLength - the maximum length of the character attribute limit

CMDBCharLimit

public CMDBCharLimit(int maxCharLength,
                     java.lang.String formatString)

Creates a String selection attribute limit.

Parameters:

maxCharLength - the maximum length of the String selection attribute limit

formatString - the maximum number of semi-colon delimited elements allowed in the attribute, formatted as Ln, where n is the maximum number of elements (for example, L3). If the attribute is a regular string, leave formatString NULL.

CMDBCharLimit

public CMDBCharLimit(int maxCharLength,
                     java.lang.String formatString,
                     java.lang.String charMenu,
                     int menuStyle,
                     java.lang.String pattern,
                     int qbeOption,
                     int ftsOption)

Creates a character type attribute limit. Allows specifying AR System centric details.

Parameters:

maxCharLength - the maximum length of the String selection attribute limit

formatString - the maximum number of semi-colon delimited elements allowed in the attribute, formatted as Ln, where n is the maximum number of elements (for example, L3). If the attribute is a regular string, leave formatString NULL.

charMenu - the name of AR System character menu attached to the underlying field of this attribute

menuStyle - applies only if menu is attached and dictates how a menu selection reflects into the value 1 = Overwrite the existig value, 2 - Append to the existing value

pattern - the AR System pattern specification for the underlying field of this attribute

qbeOption - indicates how the query should match this attribute values 1 = Anywhere, 2 - Leading, 3 - Equal

ftsOption - indicates whether the underlying field be FTS indexed 0 = No, 1 - indexed

Method Detail

getMaxCharLength

public int getMaxCharLength()

Gets the maximum length of the character attribute limit.

Returns:

maximum character length

getFormat

public java.lang.String getFormat()

Gets the format of the character attribute limit.

Returns:

format of the character attribute limit

setMaxCharLength

public void setMaxCharLength(int maxCharLength)

Sets the maximum length of the character attribute limit.

Parameters:

maxCharLength - the maximum length of the character attribute limit

setFormat

public void setFormat(java.lang.String formatString)

Sets the format of the character attribute limit.

Parameters:

formatString - the maximum number of semi-colon delimited elements allowed in the attribute, formatted as Ln, where n is the maximum number of elements (for example, L3). If the attribute is a regular string, leave formatString NULL.

getMenuStyle

public int getMenuStyle()

Gets the menu style.

Returns:

menu style

setMenuStyle

public void setMenuStyle(int menuStyle)

Sets the menu style.

Parameters:

menuStyle - applies only if menu is attached and dictates how a menu selection reflects into the value 1 = Overwrite the existig value, 2 - Append to the existing value

getCharMenu

public java.lang.String getCharMenu()

Gets the name of the AR System character menu attached to the underlying field of this attribute.

Returns:

AR System character menu attached to the underlying field

setCharMenu

public void setCharMenu(java.lang.String charMenu)

Sets the name of the AR System character menu attached to the underlying field of this attribute.

Parameters:

charMenu - the name of AR System character menu attached to the underlying field of this attribute

getPattern

public java.lang.String getPattern()

Gets the pattern for the underlying field of this attribute

Returns:

field pattern for the underlying field

setPattern

public void setPattern(java.lang.String pattern)

Sets the pattern for the underlying field of this attribute

Parameters:

pattern - the AR System pattern specification for the underlying field of this attribute

getQBEOption

public int getQBEOption()

Gets the QBE option

Returns:

QBE option

setQBEOption

public void setQBEOption(int qbeOption)

Sets the QBE option

Parameters:

qbeOption - indicates how the query should match this attribute values 1 = Anywhere, 2 - Leading, 3 - Equal

getFTSOption

public int getFTSOption()

Gets the FTS option

Returns:

FTS option

setFTSOption

public void setFTSOption(int ftsOption)

Sets the FTS option

Parameters:

ftsOption - indicates whether the underlying field be FTS indexed 0 = No, 1 = indexed