ICustomizationField (Step Enterprise 3.14.0 API)

All Superinterfaces:

com4j.Com4jObject

All Known Subinterfaces:

ICustomizationField2, ICustomizationField3
```
public interface ICustomizationField
extends com4j.Com4jObject
```
Services for customizing project fields.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`columnName()` The column name.
`String`	`columnType()` The database column type: char, date, memo, number, or time.
`void`	`columnType(String pVal)` The database column type: char, date, memo, number, or time.
`String`	`defaultValue()` The default value of the field.
`void`	`defaultValue(String pVal)` The default value of the field.
`String`	`editMask()` The input mask for string fields.
`void`	`editMask(String pVal)` The input mask for string fields.
`String`	`editStyle()` For HP use.
`void`	`editStyle(String pVal)` For HP use.
`int`	`fieldSize()` The size of the field in the database.
`void`	`fieldSize(int pVal)` The size of the field in the database.
`int`	`grantModifyMask()` The bit mask that indicates which user groups can modify the field.
`void`	`grantModifyMask(int pVal)` The bit mask that indicates which user groups can modify the field.
`boolean`	`isActive()` Indicates if the field is active.
`void`	`isActive(boolean pVal)` Indicates if the field is active.
`boolean`	`isByCode()` Indicates if the field stores the Tree Node ID, rather than the passed value.
`void`	`isByCode(boolean pVal)` Indicates if the field stores the Tree Node ID, rather than the passed value.
`boolean`	`isCanFilter()` Checks if the field is filter-enabled.
`void`	`isCanFilter(boolean pVal)` Checks if the field is filter-enabled.
`boolean`	`isCustomizable()` Indicates if the field is displayed in the customization user interface.
`void`	`isCustomizable(boolean pVal)` Indicates if the field is displayed in the customization user interface.
`boolean`	`isEdit()` Indicates if the field can be edited.
`void`	`isEdit(boolean pVal)` Indicates if the field can be edited.
`boolean`	`isHistory()` Indicates if change history is stored for the field.
`void`	`isHistory(boolean pVal)` Indicates if change history is stored for the field.
`boolean`	`isKeepValue()` For HP use.
`void`	`isKeepValue(boolean pVal)` For HP use.
`boolean`	`isKey()` Checks if the field is a database key field.
`void`	`isKey(boolean pVal)` Checks if the field is a database key field.
`boolean`	`isMail()` Indicates if Users on the list to be notified of changes are notified when this field is changed.
`void`	`isMail(boolean pVal)` Indicates if Users on the list to be notified of changes are notified when this field is changed.
`boolean`	`isRequired()` Checks if the field is required.
`void`	`isRequired(boolean pVal)` Checks if the field is required.
`boolean`	`isSystem()` Checks if the field is a system field.
`void`	`isSystem(boolean pVal)` Checks if the field is a system field.
`boolean`	`isToSum()` For HP use.
`void`	`isToSum(boolean pVal)` For HP use.
`boolean`	`isTransitionLogic()` Indicates if the field has transition logic.
`void`	`isTransitionLogic(boolean pVal)` Indicates if the field has transition logic.
`boolean`	`isVerify()` Indicates if the field requires verification.
`void`	`isVerify(boolean pVal)` Indicates if the field requires verification.
`int`	`isVisibleInNewBug()` Indicates if the field is visible for the specified groups in a new defect form.
`void`	`isVisibleInNewBug(int pVal)` Indicates if the field is visible for the specified groups in a new defect form.
`int`	`keyOrder()` The position of the field in multi-field database key (1-based).
`void`	`keyOrder(int pVal)` The position of the field in multi-field database key (1-based).
`com4j.Com4jObject`	`list()` The CustomizationList assigned to the field.
`void`	`list(com4j.Com4jObject pVal)` The CustomizationList assigned to the field.
`boolean`	`newCreated()` Indicates if the field was created but not posted to the server.
`void`	`newCreated(boolean pVal)` Indicates if the field was created but not posted to the server.
`int`	`ownerSensibleMask()` The bit mask that indicates for which groups this field can be modified only by its owner.
`void`	`ownerSensibleMask(int pVal)` The bit mask that indicates for which groups this field can be modified only by its owner.
`Object`	`rootId()` If the field contains a list, the ID of the list root node.
`void`	`rootId(Object pVal)` If the field contains a list, the ID of the list root node.
`String`	`tableName()` The name of the table that stores the active field.
`int`	`type()` The Field type.
`void`	`type(int pVal)` The Field type.
`boolean`	`updated()` Indicates if the object has been modified since the last download from the server.
`void`	`updated(boolean pVal)` Indicates if the object has been modified since the last download from the server.
`String`	`userColumnType()` The user column type: char, number, date, memo, or empty string.
`void`	`userColumnType(String pVal)` The user column type: char, number, date, memo, or empty string.
`String`	`userLabel()` A user-defined field label.
`void`	`userLabel(String pVal)` A user-defined field label.
`boolean`	`versionControl()` Indicates if the field is under version control.
`void`	`versionControl(boolean pVal)` Indicates if the field is under version control.
`int`	`visibleForGroups()` The bit mask that indicates which user groups can see this field.
`void`	`visibleForGroups(int pVal)` The bit mask that indicates which user groups can see this field.

Methods inherited from interface com4j.Com4jObject
advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

- Method Detail
  - userLabel
```
String userLabel()
```
    A user-defined field label.
    
    Getter method for the COM property "UserLabel"
    
    Returns:
    
    Returns a value of type java.lang.String
  - userLabel
```
void userLabel(String pVal)
```
    A user-defined field label.
    
    Setter method for the COM property "UserLabel"
    
    Parameters:
    
    pVal - Mandatory java.lang.String parameter.
  - tableName
```
String tableName()
```
    The name of the table that stores the active field.
    
    Getter method for the COM property "TableName"
    
    Returns:
    
    Returns a value of type java.lang.String
  - editStyle
```
String editStyle()
```
    For HP use. The field's edit mask.
    
    Getter method for the COM property "EditStyle"
    
    Returns:
    
    Returns a value of type java.lang.String
  - editStyle
```
void editStyle(String pVal)
```
    For HP use. The field's edit mask.
    
    Setter method for the COM property "EditStyle"
    
    Parameters:
    
    pVal - Mandatory java.lang.String parameter.
  - isSystem
```
boolean isSystem()
```
    Checks if the field is a system field.
    
    Getter method for the COM property "IsSystem"
    
    Returns:
    
    Returns a value of type boolean
  - isSystem
```
void isSystem(boolean pVal)
```
    Checks if the field is a system field.
    
    Setter method for the COM property "IsSystem"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isCanFilter
```
boolean isCanFilter()
```
    Checks if the field is filter-enabled.
    
    Getter method for the COM property "IsCanFilter"
    
    Returns:
    
    Returns a value of type boolean
  - isCanFilter
```
void isCanFilter(boolean pVal)
```
    Checks if the field is filter-enabled.
    
    Setter method for the COM property "IsCanFilter"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isKey
```
boolean isKey()
```
    Checks if the field is a database key field.
    
    Getter method for the COM property "IsKey"
    
    Returns:
    
    Returns a value of type boolean
  - isKey
```
void isKey(boolean pVal)
```
    Checks if the field is a database key field.
    
    Setter method for the COM property "IsKey"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - keyOrder
```
int keyOrder()
```
    The position of the field in multi-field database key (1-based).
    
    Getter method for the COM property "KeyOrder"
    
    Returns:
    
    Returns a value of type int
  - keyOrder
```
void keyOrder(int pVal)
```
    The position of the field in multi-field database key (1-based).
    
    Setter method for the COM property "KeyOrder"
    
    Parameters:
    
    pVal - Mandatory int parameter.
  - isActive
```
boolean isActive()
```
    Indicates if the field is active. Inactive user-defined fields are not visible in the user interface.
    
    Getter method for the COM property "IsActive"
    
    Returns:
    
    Returns a value of type boolean
  - isActive
```
void isActive(boolean pVal)
```
    Indicates if the field is active. Inactive user-defined fields are not visible in the user interface.
    
    Setter method for the COM property "IsActive"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isEdit
```
boolean isEdit()
```
    Indicates if the field can be edited.
    
    Getter method for the COM property "IsEdit"
    
    Returns:
    
    Returns a value of type boolean
  - isEdit
```
void isEdit(boolean pVal)
```
    Indicates if the field can be edited.
    
    Setter method for the COM property "IsEdit"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isHistory
```
boolean isHistory()
```
    Indicates if change history is stored for the field.
    
    Getter method for the COM property "IsHistory"
    
    Returns:
    
    Returns a value of type boolean
  - isHistory
```
void isHistory(boolean pVal)
```
    Indicates if change history is stored for the field.
    
    Setter method for the COM property "IsHistory"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isMail
```
boolean isMail()
```
    Indicates if Users on the list to be notified of changes are notified when this field is changed.
    
    Getter method for the COM property "IsMail"
    
    Returns:
    
    Returns a value of type boolean
  - isMail
```
void isMail(boolean pVal)
```
    Indicates if Users on the list to be notified of changes are notified when this field is changed.
    
    Setter method for the COM property "IsMail"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isVerify
```
boolean isVerify()
```
    Indicates if the field requires verification.
    
    Getter method for the COM property "IsVerify"
    
    Returns:
    
    Returns a value of type boolean
  - isVerify
```
void isVerify(boolean pVal)
```
    Indicates if the field requires verification.
    
    Setter method for the COM property "IsVerify"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isByCode
```
boolean isByCode()
```
    Indicates if the field stores the Tree Node ID, rather than the passed value.
    
    Getter method for the COM property "IsByCode"
    
    Returns:
    
    Returns a value of type boolean
  - isByCode
```
void isByCode(boolean pVal)
```
    Indicates if the field stores the Tree Node ID, rather than the passed value.
    
    Setter method for the COM property "IsByCode"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isRequired
```
boolean isRequired()
```
    Checks if the field is required.
    
    Getter method for the COM property "IsRequired"
    
    Returns:
    
    Returns a value of type boolean
  - isRequired
```
void isRequired(boolean pVal)
```
    Checks if the field is required.
    
    Setter method for the COM property "IsRequired"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - userColumnType
```
String userColumnType()
```
    The user column type: char, number, date, memo, or empty string.
    
    Getter method for the COM property "UserColumnType"
    
    Returns:
    
    Returns a value of type java.lang.String
  - userColumnType
```
void userColumnType(String pVal)
```
    The user column type: char, number, date, memo, or empty string.
    
    Setter method for the COM property "UserColumnType"
    
    Parameters:
    
    pVal - Mandatory java.lang.String parameter.
  - isKeepValue
```
boolean isKeepValue()
```
    For HP use. Indicates if the last value for the field is stored.
    
    Getter method for the COM property "IsKeepValue"
    
    Returns:
    
    Returns a value of type boolean
  - isKeepValue
```
void isKeepValue(boolean pVal)
```
    For HP use. Indicates if the last value for the field is stored.
    
    Setter method for the COM property "IsKeepValue"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - isCustomizable
```
boolean isCustomizable()
```
    Indicates if the field is displayed in the customization user interface.
    
    Getter method for the COM property "IsCustomizable"
    
    Returns:
    
    Returns a value of type boolean
  - isCustomizable
```
void isCustomizable(boolean pVal)
```
    Indicates if the field is displayed in the customization user interface.
    
    Setter method for the COM property "IsCustomizable"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - fieldSize
```
int fieldSize()
```
    The size of the field in the database. For BLOB fields, the size is -1.
    
    Getter method for the COM property "FieldSize"
    
    Returns:
    
    Returns a value of type int
  - fieldSize
```
void fieldSize(int pVal)
```
    The size of the field in the database. For BLOB fields, the size is -1.
    
    Setter method for the COM property "FieldSize"
    
    Parameters:
    
    pVal - Mandatory int parameter.
  - columnName
```
String columnName()
```
    The column name.
    
    Getter method for the COM property "ColumnName"
    
    Returns:
    
    Returns a value of type java.lang.String
  - columnType
```
String columnType()
```
    The database column type: char, date, memo, number, or time.
    
    Getter method for the COM property "ColumnType"
    
    Returns:
    
    Returns a value of type java.lang.String
  - columnType
```
void columnType(String pVal)
```
    The database column type: char, date, memo, number, or time.
    
    Setter method for the COM property "ColumnType"
    
    Parameters:
    
    pVal - Mandatory java.lang.String parameter.
  - editMask
```
String editMask()
```
    The input mask for string fields.
    
    Getter method for the COM property "EditMask"
    
    Returns:
    
    Returns a value of type java.lang.String
  - editMask
```
void editMask(String pVal)
```
    The input mask for string fields.
    
    Setter method for the COM property "EditMask"
    
    Parameters:
    
    pVal - Mandatory java.lang.String parameter.
  - list
```
com4j.Com4jObject list()
```
    The CustomizationList assigned to the field.
    
    Getter method for the COM property "List"
    
    Returns:
    
    Returns a value of type com4j.Com4jObject
  - list
```
void list(com4j.Com4jObject pVal)
```
    The CustomizationList assigned to the field.
    
    Setter method for the COM property "List"
    
    Parameters:
    
    pVal - Mandatory com4j.Com4jObject parameter.
  - rootId
```
Object rootId()
```
    If the field contains a list, the ID of the list root node. If not, RootId is NULL.
    
    Getter method for the COM property "RootId"
    
    Returns:
    
    Returns a value of type java.lang.Object
  - rootId
```
void rootId(Object pVal)
```
    If the field contains a list, the ID of the list root node. If not, RootId is NULL.
    
    Setter method for the COM property "RootId"
    
    Parameters:
    
    pVal - Mandatory java.lang.Object parameter.
  - type
```
int type()
```
    The Field type.
    
    Getter method for the COM property "Type"
    
    Returns:
    
    Returns a value of type int
  - type
```
void type(int pVal)
```
    The Field type.
    
    Setter method for the COM property "Type"
    
    Parameters:
    
    pVal - Mandatory int parameter.
  - updated
```
boolean updated()
```
    Indicates if the object has been modified since the last download from the server.
    
    Getter method for the COM property "Updated"
    
    Returns:
    
    Returns a value of type boolean
  - updated
```
void updated(boolean pVal)
```
    Indicates if the object has been modified since the last download from the server.
    
    Setter method for the COM property "Updated"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - grantModifyMask
```
int grantModifyMask()
```
    The bit mask that indicates which user groups can modify the field.
    
    Getter method for the COM property "GrantModifyMask"
    
    Returns:
    
    Returns a value of type int
  - grantModifyMask
```
void grantModifyMask(int pVal)
```
    The bit mask that indicates which user groups can modify the field.
    
    Setter method for the COM property "GrantModifyMask"
    
    Parameters:
    
    pVal - Mandatory int parameter.
  - ownerSensibleMask
```
int ownerSensibleMask()
```
    The bit mask that indicates for which groups this field can be modified only by its owner.
    
    Getter method for the COM property "OwnerSensibleMask"
    
    Returns:
    
    Returns a value of type int
  - ownerSensibleMask
```
void ownerSensibleMask(int pVal)
```
    The bit mask that indicates for which groups this field can be modified only by its owner.
    
    Setter method for the COM property "OwnerSensibleMask"
    
    Parameters:
    
    pVal - Mandatory int parameter.
  - isVisibleInNewBug
```
int isVisibleInNewBug()
```
    Indicates if the field is visible for the specified groups in a new defect form.
    
    Getter method for the COM property "IsVisibleInNewBug"
    
    Returns:
    
    Returns a value of type int
  - isVisibleInNewBug
```
void isVisibleInNewBug(int pVal)
```
    Indicates if the field is visible for the specified groups in a new defect form.
    
    Setter method for the COM property "IsVisibleInNewBug"
    
    Parameters:
    
    pVal - Mandatory int parameter.
  - isTransitionLogic
```
boolean isTransitionLogic()
```
    Indicates if the field has transition logic.
    
    Getter method for the COM property "IsTransitionLogic"
    
    Returns:
    
    Returns a value of type boolean
  - isTransitionLogic
```
void isTransitionLogic(boolean pVal)
```
    Indicates if the field has transition logic.
    
    Setter method for the COM property "IsTransitionLogic"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - defaultValue
```
String defaultValue()
```
    The default value of the field.
    
    Getter method for the COM property "DefaultValue"
    
    Returns:
    
    Returns a value of type java.lang.String
  - defaultValue
```
void defaultValue(String pVal)
```
    The default value of the field.
    
    Setter method for the COM property "DefaultValue"
    
    Parameters:
    
    pVal - Mandatory java.lang.String parameter.
  - isToSum
```
boolean isToSum()
```
    For HP use. Indicates if a summation of the field can be obtained for graph presentation.
    
    Getter method for the COM property "IsToSum"
    
    Returns:
    
    Returns a value of type boolean
  - isToSum
```
void isToSum(boolean pVal)
```
    For HP use. Indicates if a summation of the field can be obtained for graph presentation.
    
    Setter method for the COM property "IsToSum"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - visibleForGroups
```
int visibleForGroups()
```
    The bit mask that indicates which user groups can see this field.
    
    Getter method for the COM property "VisibleForGroups"
    
    Returns:
    
    Returns a value of type int
  - visibleForGroups
```
void visibleForGroups(int pVal)
```
    The bit mask that indicates which user groups can see this field.
    
    Setter method for the COM property "VisibleForGroups"
    
    Parameters:
    
    pVal - Mandatory int parameter.
  - versionControl
```
boolean versionControl()
```
    Indicates if the field is under version control.
    
    Getter method for the COM property "VersionControl"
    
    Returns:
    
    Returns a value of type boolean
  - versionControl
```
void versionControl(boolean pVal)
```
    Indicates if the field is under version control.
    
    Setter method for the COM property "VersionControl"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - newCreated
```
boolean newCreated()
```
    Indicates if the field was created but not posted to the server.
    
    Getter method for the COM property "NewCreated"
    
    Returns:
    
    Returns a value of type boolean
  - newCreated
```
void newCreated(boolean pVal)
```
    Indicates if the field was created but not posted to the server.
    
    Setter method for the COM property "NewCreated"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.

Interface ICustomizationField

Method Summary

Methods inherited from interface com4j.Com4jObject

Method Detail

userLabel

userLabel

tableName

editStyle

editStyle

isSystem

isSystem

isCanFilter

isCanFilter

isKey

isKey

keyOrder

keyOrder

isActive

isActive

isEdit

isEdit

isHistory

isHistory

isMail

isMail

isVerify

isVerify

isByCode

isByCode

isRequired

isRequired

userColumnType

userColumnType

isKeepValue

isKeepValue

isCustomizable

isCustomizable

fieldSize

fieldSize

columnName

columnType

columnType

editMask

editMask

list

list

rootId

rootId

type

type

updated

updated

grantModifyMask

grantModifyMask

ownerSensibleMask

ownerSensibleMask

isVisibleInNewBug

isVisibleInNewBug

isTransitionLogic

isTransitionLogic

defaultValue

defaultValue

isToSum

isToSum

visibleForGroups

visibleForGroups

versionControl

versionControl

newCreated

newCreated