Class TrackerField2SoapDO
java.lang.Object
com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDO
com.collabnet.ce.soap60.webservices.tracker.TrackerField2SoapDO
public class TrackerField2SoapDO
extends com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDO
A TrackerField2SoapDO defines a custom/flex field by specifying its name, type, etc.
Change History
Release: 16.7
- Added 'fieldRoleFilters' field.
- Added new static fields: USER_FILTER_EDIT_PERMISSION,USER_FILTER_ROLES
Release: 4.4
- Added userFilter and defaultUsernames
- Added new static fields: FIELD_TYPE_DATE, FIELD_TYPE_MULTISELECT_USER, FIELD_USER_FILTER_ALL, FIELD_USER_FILTER_PROJECT_MEMBER, FIELD_VALUE_TYPE_DATE, FIELD_VALUE_TYPE_USER
Release: 6.1
- Added helptext and pattern field.
- Added parentFieldId and parentChildFieldValueMap to support tracker field hierarchy.
- Since:
- 4.3-Hotfix1
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Field type is date.static final String
Field type is a folder (planning folder).static final String
Field type is a multiselect (multiple choice of values).static final String
Field type is multiselect username (multiple choice of usernames).static final String
Field type is single select (choice of values).static final String
Field type is plain text (integer or string).static final String
All users are allowed in the field of type userstatic final String
only project members are allowed in the field of type userstatic final String
Possible field value type (applies to FIELD_TYPE_DATE only).static final String
Possible field value type (applies to TEXT_FIELD only).static final String
Possible field value type (applies to TEXT_FIELD only).static final String
Possible field value type (applies to FIELD_TYPE_MULTISELECT_USER only).static final String
only project members with edit permissions are displayed in the assignedto field.static final String
All users in the filtered roles will be displayed in the assignedto field. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns 'defaultTextValue'.String[]
Returns 'defaultUsernames'.boolean
Returns 'disabled'.int
Returns 'displayLines'.int
Returns 'displaySize'.String[]
Returns 'fieldRoleFilters'.Returns 'fieldType'.Returns 'fieldValues'.Returns 'helpText'.boolean
Returns 'hiddenOnCreate'.getName()
Returns 'name'.Returns 'parentChildFieldValueMap'.Returns 'parentFieldId'.Returns 'pattern'.boolean
Returns 'required'.Returns 'userFilter'.Returns 'valueType'.static void
registerTypeMappings
(org.apache.axis.client.Call call) void
setDefaultTextValue
(String defaultTextValue) Sets 'defaultTextValue'.void
setDefaultUsernames
(String[] defaultUsernames) Sets 'defaultUsernames'.void
setDisabled
(boolean disabled) Sets 'disabled'.void
setDisplayLines
(int displayLines) Sets 'displayLines'.void
setDisplaySize
(int displaySize) Sets 'displaySize'.void
setFieldRoleFilters
(String[] fieldRoleFilters) Sets 'fieldRoleFilters'.void
setFieldType
(String fieldType) Sets 'fieldType'.void
setFieldValues
(TrackerFieldValueSoapDO[] fieldValues) Sets 'fieldValues'.void
setHelpText
(String helpText) Sets 'helpText'.void
setHiddenOnCreate
(boolean hiddenOnCreate) Sets 'hiddenOnCreate'.void
Sets 'name'.void
setParentChildFieldValueMap
(SoapNamedValues parentChildFieldValueMap) Sets 'parentChildFieldValueMap'.void
setParentFieldId
(String parentFieldId) Sets 'parentFieldId'.void
setPattern
(String pattern) Sets 'pattern'.void
setRequired
(boolean required) Sets 'required'.void
setUserFilter
(String userFilter) Sets 'userFilter'.void
setValueType
(String valueType) Sets 'valueType'.Methods inherited from class com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDO
getCreatedBy, getCreatedDate, getId, getLastModifiedBy, getLastModifiedDate, getVersion, setCreatedBy, setCreatedDate, setId, setLastModifiedBy, setLastModifiedDate, setVersion
-
Field Details
-
FIELD_TYPE_TEXT
Field type is plain text (integer or string).- See Also:
-
FIELD_TYPE_FOLDER
Field type is a folder (planning folder).- See Also:
-
FIELD_TYPE_SINGLE_SELECT
Field type is single select (choice of values).- See Also:
-
FIELD_TYPE_MULTISELECT
Field type is a multiselect (multiple choice of values).- See Also:
-
FIELD_TYPE_MULTISELECT_USER
Field type is multiselect username (multiple choice of usernames).- See Also:
-
FIELD_TYPE_DATE
Field type is date.- See Also:
-
FIELD_VALUE_TYPE_STRING
Possible field value type (applies to TEXT_FIELD only).- See Also:
-
FIELD_VALUE_TYPE_INTEGER
Possible field value type (applies to TEXT_FIELD only).- See Also:
-
FIELD_VALUE_TYPE_USER
Possible field value type (applies to FIELD_TYPE_MULTISELECT_USER only).- See Also:
-
FIELD_VALUE_TYPE_DATE
Possible field value type (applies to FIELD_TYPE_DATE only).- See Also:
-
FIELD_USER_FILTER_PROJECT_MEMBER
only project members are allowed in the field of type user- See Also:
-
FIELD_USER_FILTER_ALL
All users are allowed in the field of type user- See Also:
-
USER_FILTER_EDIT_PERMISSION
only project members with edit permissions are displayed in the assignedto field.- See Also:
-
USER_FILTER_ROLES
All users in the filtered roles will be displayed in the assignedto field.- See Also:
-
-
Constructor Details
-
TrackerField2SoapDO
public TrackerField2SoapDO()
-
-
Method Details
-
getName
Returns 'name'. Name of the field.- Returns:
- Value of 'name'.
-
setName
Sets 'name'. Name of the field.- Parameters:
name
- Value of 'name'.
-
getFieldType
Returns 'fieldType'.- Returns:
- Value of 'fieldType'.
-
setFieldType
Sets 'fieldType'.- Parameters:
fieldType
- Value of 'fieldType'.
-
getValueType
Returns 'valueType'.- Returns:
- Value of 'valueType'.
-
setValueType
Sets 'valueType'.- Parameters:
valueType
- Value of 'valueType'.
-
getRequired
public boolean getRequired()Returns 'required'. Specifies if field requires a value.- Returns:
- Value of 'required'.
-
setRequired
public void setRequired(boolean required) Sets 'required'. Specifies if field requires a value.- Parameters:
required
- Value of 'required'.
-
getDisabled
public boolean getDisabled()Returns 'disabled'. Specifies if field is disabled.- Returns:
- Value of 'disabled'.
-
setDisabled
public void setDisabled(boolean disabled) Sets 'disabled'. Specifies if field is disabled.- Parameters:
disabled
- Value of 'disabled'.
-
getHiddenOnCreate
public boolean getHiddenOnCreate()Returns 'hiddenOnCreate'. Specifies if field is hidden on create.- Returns:
- Value of 'hiddenOnCreate'.
-
setHiddenOnCreate
public void setHiddenOnCreate(boolean hiddenOnCreate) Sets 'hiddenOnCreate'. Specifies if field is hidden on create.- Parameters:
hiddenOnCreate
- Value of 'hiddenOnCreate'.
-
getFieldValues
Returns 'fieldValues'. Array of field values.- Returns:
- Value of 'fieldValues'.
-
setFieldValues
Sets 'fieldValues'. Array of field values.- Parameters:
fieldValues
- Value of 'fieldValues'.
-
getParentFieldId
Returns 'parentFieldId'. Id of the parent field.- Returns:
- Value of 'parentFieldId'.
-
setParentFieldId
Sets 'parentFieldId'. Id of the parent field.- Parameters:
parentFieldId
- Value of 'parentFieldId'.
-
getParentChildFieldValueMap
Returns 'parentChildFieldValueMap'. Mapping between parent field values and child field values.- Returns:
- Value of 'parentChildFieldValueMap'.
-
setParentChildFieldValueMap
Sets 'parentChildFieldValueMap'. Mapping between parent field values and child field values.- Parameters:
parentChildFieldValueMap
- Value of 'parentChildFieldValueMap'.
-
getDisplaySize
public int getDisplaySize()Returns 'displaySize'. The display size value for the field- Returns:
- Value of 'displaySize'.
-
setDisplaySize
public void setDisplaySize(int displaySize) Sets 'displaySize'. The display size value for the field- Parameters:
displaySize
- Value of 'displaySize'.
-
getDisplayLines
public int getDisplayLines()Returns 'displayLines'. The number of lines to display for the field- Returns:
- Value of 'displayLines'.
-
setDisplayLines
public void setDisplayLines(int displayLines) Sets 'displayLines'. The number of lines to display for the field- Parameters:
displayLines
- Value of 'displayLines'.
-
getDefaultTextValue
Returns 'defaultTextValue'.- Returns:
- Value of 'defaultTextValue'.
-
setDefaultTextValue
Sets 'defaultTextValue'.- Parameters:
defaultTextValue
- Value of 'defaultTextValue'.
-
getUserFilter
Returns 'userFilter'. FIELD_USER_FILTER_PROJECT_MEMBER or FIELD_USER_FILTER_ALL or USER_FILTER_EDIT_PERMISSION or USER_FILTER_ROLES- Returns:
- Value of 'userFilter'.
-
setUserFilter
Sets 'userFilter'. FIELD_USER_FILTER_PROJECT_MEMBER or FIELD_USER_FILTER_ALL or USER_FILTER_EDIT_PERMISSION or USER_FILTER_ROLES- Parameters:
userFilter
- Value of 'userFilter'.
-
getFieldRoleFilters
Returns 'fieldRoleFilters'. The filtered Roles List for this field (applies to 'Assigned To' field only).- Returns:
- Value of 'fieldRoleFilters'.
-
setFieldRoleFilters
Sets 'fieldRoleFilters'. The filtered Roles List for this field (applies to 'Assigned To' field only).- Parameters:
fieldRoleFilters
- Value of 'fieldRoleFilters'.
-
getDefaultUsernames
Returns 'defaultUsernames'. Array of usernames to be default value (applies to FIELD_TYPE_MULTISELECT_USER only).- Returns:
- Value of 'defaultUsernames'.
-
setDefaultUsernames
Sets 'defaultUsernames'. Array of usernames to be default value (applies to FIELD_TYPE_MULTISELECT_USER only).- Parameters:
defaultUsernames
- Value of 'defaultUsernames'.
-
getHelpText
Returns 'helpText'. The help text for the field- Returns:
- Value of 'helpText'.
-
setHelpText
Sets 'helpText'. The help text for the field- Parameters:
helpText
- Value of 'helpText'.
-
getPattern
Returns 'pattern'. The pattern used to validate the field value- Returns:
- Value of 'pattern'.
-
setPattern
Sets 'pattern'. The pattern used to validate the field value- Parameters:
pattern
- Value of 'pattern'.
-
registerTypeMappings
public static void registerTypeMappings(org.apache.axis.client.Call call)
-