com.jamasoftware.contour.domain
Class DocumentField

java.lang.Object
  com.jamasoftware.contour.domain.DomainObjectBaseSupport
      com.jamasoftware.contour.domain.DomainObjectSupport
          com.jamasoftware.contour.domain.DocumentField

All Implemented Interfaces:

DomainObject, DomainObjectBase, OrganizationAware, ScopedObject, java.io.Serializable

@Entity
public class DocumentField
extends DomainObjectSupport
implements ScopedObject

Document field

Author:

Sean Tong

See Also:

Serialized Form

Field Summary

static java.lang.Integer	CATEGORY_JIRA
static java.lang.Integer	CATEGORY_RALLY
static java.lang.Integer	CATEGORY_SYSTEM
static java.lang.String	FIELD_ACTUAL_RESULTS
static java.lang.String	FIELD_ASSIGNED
static java.lang.String	FIELD_ATTACHMENT
static java.lang.String	FIELD_CHILD_DOCUMENT_TYPE
static java.lang.String	FIELD_CREATED_BY
static java.lang.String	FIELD_CREATED_DATE
static java.lang.String	FIELD_DATE_1
static java.lang.String	FIELD_DATE_2
static java.lang.String	FIELD_DATE_3
static java.lang.String	FIELD_DATE_4
static java.lang.String	FIELD_DATE_5
static java.lang.String	FIELD_DESCRIPTION
static java.lang.String	FIELD_DETAIL
static java.lang.String	FIELD_DOCUMENT_KEY
static java.lang.String	FIELD_DOCUMENT_TYPE
static java.lang.String	FIELD_DURATION
static java.lang.String	FIELD_EDITABLE
static java.lang.String	FIELD_END_DATE
static java.lang.String	FIELD_FLAG_1
static java.lang.String	FIELD_FLAG_2
static java.lang.String	FIELD_FLAG_3
static java.lang.String	FIELD_FLAG_4
static java.lang.String	FIELD_FLAG_5
static java.lang.String	FIELD_GLOBAL_SORT_ORDER
static java.lang.String	FIELD_ID
static java.lang.String	FIELD_INDENT
static java.lang.String	FIELD_ITEM_URL
static java.lang.String	FIELD_LEGACY_KEY
static java.lang.String	FIELD_LOCKED
static java.lang.String	FIELD_LOCKED_BY
static java.lang.String	FIELD_LOCKED_DATE
static java.lang.String	FIELD_LOOKUP_1
static java.lang.String	FIELD_LOOKUP_10
static java.lang.String	FIELD_LOOKUP_2
static java.lang.String	FIELD_LOOKUP_3
static java.lang.String	FIELD_LOOKUP_4
static java.lang.String	FIELD_LOOKUP_5
static java.lang.String	FIELD_LOOKUP_6
static java.lang.String	FIELD_LOOKUP_7
static java.lang.String	FIELD_LOOKUP_8
static java.lang.String	FIELD_LOOKUP_9
static java.lang.String	FIELD_MODIFIED_BY
static java.lang.String	FIELD_MODIFIED_DATE
static java.lang.String	FIELD_NAME
static java.lang.String	FIELD_ORIGINAL_ESTIMATE
static java.lang.String	FIELD_PRIORITY
static java.lang.String	FIELD_PROJECT
static java.lang.String	FIELD_RELEASE
static java.lang.String	FIELD_RELEASE_1
static java.lang.String	FIELD_RELEASE_2
static java.lang.String	FIELD_REMAINING_ESTIMATE
static java.lang.Integer	FIELD_REQUIRED The "required' field type, which doesn't mean that the user must supply a value, but that this field cannot be removed from item types that it is associated with (e.g.
static java.lang.String	FIELD_SEQUENCE
static java.lang.String	FIELD_SET_KEY
static java.lang.String	FIELD_SORT_ORDER
static java.lang.String	FIELD_START_DATE
static java.lang.String	FIELD_STATUS
static java.lang.String	FIELD_STRING_1
static java.lang.String	FIELD_STRING_10
static java.lang.String	FIELD_STRING_11
static java.lang.String	FIELD_STRING_12
static java.lang.String	FIELD_STRING_13
static java.lang.String	FIELD_STRING_14
static java.lang.String	FIELD_STRING_15
static java.lang.String	FIELD_STRING_2
static java.lang.String	FIELD_STRING_3
static java.lang.String	FIELD_STRING_4
static java.lang.String	FIELD_STRING_5
static java.lang.String	FIELD_STRING_6
static java.lang.String	FIELD_STRING_7
static java.lang.String	FIELD_STRING_8
static java.lang.String	FIELD_STRING_9
static java.lang.String	FIELD_TEST_CASE
static java.lang.String	FIELD_TEST_CASE_STATUS
static java.lang.String	FIELD_TEST_CASE_STEPS
static java.lang.String	FIELD_TEST_CYCLE
static java.lang.String	FIELD_TEST_PLAN
static java.lang.String	FIELD_TEST_RUN_SET
static java.lang.String	FIELD_TEST_RUN_STATUS
static java.lang.String	FIELD_TEST_RUN_STEPS
static java.lang.String	FIELD_TEXT_1
static java.lang.String	FIELD_TEXT_10
static java.lang.String	FIELD_TEXT_2
static java.lang.String	FIELD_TEXT_3
static java.lang.String	FIELD_TEXT_4
static java.lang.String	FIELD_TEXT_5
static java.lang.String	FIELD_TEXT_6
static java.lang.String	FIELD_TEXT_7
static java.lang.String	FIELD_TEXT_8
static java.lang.String	FIELD_TEXT_9
static java.lang.String	FIELD_TIME_SPENT
static java.lang.String	FIELD_USER_1
static java.lang.String	FIELD_USER_2
static java.util.List<java.lang.String>	RESERVED_FIELD_NAMES
static java.lang.String	SYSTEM_FIELD_PREFIX

Fields inherited from interface com.jamasoftware.contour.domain.DomainObjectBase

ORGANIZATION_COLUMN_NAME

Constructor Summary

DocumentField()

DocumentField(java.lang.Integer id)

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.Integer	getCategory()
java.lang.Boolean	getCustom()
java.lang.Integer	getDataTypeId()
java.lang.String	getDescription()
java.lang.String	getEditXtype()
java.lang.Integer	getFieldType()
java.lang.String	getFormXtype()
java.lang.String	getGridXtype()
java.lang.Integer	getId()
java.lang.Boolean	getIsDerived()
java.lang.String	getName()
java.lang.Integer	getOrganizationId()
java.lang.Boolean	getReadOnly()
java.lang.Integer	getRefId()
java.lang.Integer	getScopeId()
java.lang.Boolean	getUserConfigurable()
java.lang.String	getXmlToString()
int	hashCode()
static boolean	isAddableField(DocumentField field) Non-addable fields are those that aren't necessarily system-controlled (i.e.
static boolean	isCoreField(DocumentField field)
static boolean	isCoreField(java.lang.String fieldName)
static boolean	isPredefinedField(DocumentField field)
static boolean	isPredefinedField(java.lang.String fieldName) This method tells you if the field shares a name with a predefined field
static boolean	isReservedField(DocumentField field)
static boolean	isReservedField(java.lang.String fieldName)
static boolean	isReservedFieldName(java.lang.String fieldName) We use some reserved fields on the front end.
static boolean	isSystemCustomField(DocumentField field)
static boolean	isSystemCustomField(java.lang.String fieldName)
static boolean	isValidFieldForCategory(DocumentField field, DocumentType docType) This method tells you if a field is valid for a given DocumentTypeCategory.
void	setCategory(java.lang.Integer category)
void	setCustom(java.lang.Boolean custom)
void	setDataTypeId(java.lang.Integer dataType)
void	setDescription(java.lang.String description)
void	setEditXtype(java.lang.String editXtype)
void	setFieldType(java.lang.Integer fieldType)
void	setFormXtype(java.lang.String formXtype)
void	setGridXtype(java.lang.String gridXtype)
void	setId(java.lang.Integer id)
void	setIsDerived(java.lang.Boolean isDerived)
void	setName(java.lang.String name)
void	setOrganizationId(java.lang.Integer organizationId)
void	setReadOnly(java.lang.Boolean readOnly)
void	setRefId(java.lang.Integer referenceId)
void	setScopeId(java.lang.Integer scope)
void	setUserConfigurable(java.lang.Boolean userConfigurable)
java.lang.String	toString()

Methods inherited from class com.jamasoftware.contour.domain.DomainObjectSupport

getCreatedBy, getCreatedDate, getModifiedBy, getModifiedDate, setCreatedBy, setCreatedDate, setModifiedBy, setModifiedDate

Methods inherited from class com.jamasoftware.contour.domain.DomainObjectBaseSupport

isNewObject, obtainAclObjectIdentity

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SYSTEM_FIELD_PREFIX

public static final java.lang.String SYSTEM_FIELD_PREFIX

See Also:

Constant Field Values

FIELD_NAME

public static final java.lang.String FIELD_NAME

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final java.lang.String FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_STATUS

public static final java.lang.String FIELD_STATUS

See Also:

Constant Field Values

FIELD_PRIORITY

public static final java.lang.String FIELD_PRIORITY

See Also:

Constant Field Values

FIELD_ASSIGNED

public static final java.lang.String FIELD_ASSIGNED

See Also:

Constant Field Values

FIELD_RELEASE

public static final java.lang.String FIELD_RELEASE

See Also:

Constant Field Values

FIELD_DETAIL

public static final java.lang.String FIELD_DETAIL

See Also:

Constant Field Values

FIELD_CREATED_DATE

public static final java.lang.String FIELD_CREATED_DATE

See Also:

Constant Field Values

FIELD_MODIFIED_DATE

public static final java.lang.String FIELD_MODIFIED_DATE

See Also:

Constant Field Values

FIELD_CREATED_BY

public static final java.lang.String FIELD_CREATED_BY

See Also:

Constant Field Values

FIELD_MODIFIED_BY

public static final java.lang.String FIELD_MODIFIED_BY

See Also:

Constant Field Values

FIELD_ORIGINAL_ESTIMATE

public static final java.lang.String FIELD_ORIGINAL_ESTIMATE

See Also:

Constant Field Values

FIELD_REMAINING_ESTIMATE

public static final java.lang.String FIELD_REMAINING_ESTIMATE

See Also:

Constant Field Values

FIELD_TIME_SPENT

public static final java.lang.String FIELD_TIME_SPENT

See Also:

Constant Field Values

FIELD_LOOKUP_1

public static final java.lang.String FIELD_LOOKUP_1

See Also:

Constant Field Values

FIELD_LOOKUP_2

public static final java.lang.String FIELD_LOOKUP_2

See Also:

Constant Field Values

FIELD_LOOKUP_3

public static final java.lang.String FIELD_LOOKUP_3

See Also:

Constant Field Values

FIELD_LOOKUP_4

public static final java.lang.String FIELD_LOOKUP_4

See Also:

Constant Field Values

FIELD_LOOKUP_5

public static final java.lang.String FIELD_LOOKUP_5

See Also:

Constant Field Values

FIELD_LOOKUP_6

public static final java.lang.String FIELD_LOOKUP_6

See Also:

Constant Field Values

FIELD_LOOKUP_7

public static final java.lang.String FIELD_LOOKUP_7

See Also:

Constant Field Values

FIELD_LOOKUP_8

public static final java.lang.String FIELD_LOOKUP_8

See Also:

Constant Field Values

FIELD_LOOKUP_9

public static final java.lang.String FIELD_LOOKUP_9

See Also:

Constant Field Values

FIELD_LOOKUP_10

public static final java.lang.String FIELD_LOOKUP_10

See Also:

Constant Field Values

FIELD_STRING_1

public static final java.lang.String FIELD_STRING_1

See Also:

Constant Field Values

FIELD_STRING_2

public static final java.lang.String FIELD_STRING_2

See Also:

Constant Field Values

FIELD_STRING_3

public static final java.lang.String FIELD_STRING_3

See Also:

Constant Field Values

FIELD_STRING_4

public static final java.lang.String FIELD_STRING_4

See Also:

Constant Field Values

FIELD_STRING_5

public static final java.lang.String FIELD_STRING_5

See Also:

Constant Field Values

FIELD_STRING_6

public static final java.lang.String FIELD_STRING_6

See Also:

Constant Field Values

FIELD_STRING_7

public static final java.lang.String FIELD_STRING_7

See Also:

Constant Field Values

FIELD_STRING_8

public static final java.lang.String FIELD_STRING_8

See Also:

Constant Field Values

FIELD_STRING_9

public static final java.lang.String FIELD_STRING_9

See Also:

Constant Field Values

FIELD_STRING_10

public static final java.lang.String FIELD_STRING_10

See Also:

Constant Field Values

FIELD_STRING_11

public static final java.lang.String FIELD_STRING_11

See Also:

Constant Field Values

FIELD_STRING_12

public static final java.lang.String FIELD_STRING_12

See Also:

Constant Field Values

FIELD_STRING_13

public static final java.lang.String FIELD_STRING_13

See Also:

Constant Field Values

FIELD_STRING_14

public static final java.lang.String FIELD_STRING_14

See Also:

Constant Field Values

FIELD_STRING_15

public static final java.lang.String FIELD_STRING_15

See Also:

Constant Field Values

FIELD_TEXT_1

public static final java.lang.String FIELD_TEXT_1

See Also:

Constant Field Values

FIELD_TEXT_2

public static final java.lang.String FIELD_TEXT_2

See Also:

Constant Field Values

FIELD_TEXT_3

public static final java.lang.String FIELD_TEXT_3

See Also:

Constant Field Values

FIELD_TEXT_4

public static final java.lang.String FIELD_TEXT_4

See Also:

Constant Field Values

FIELD_TEXT_5

public static final java.lang.String FIELD_TEXT_5

See Also:

Constant Field Values

FIELD_TEXT_6

public static final java.lang.String FIELD_TEXT_6

See Also:

Constant Field Values

FIELD_TEXT_7

public static final java.lang.String FIELD_TEXT_7

See Also:

Constant Field Values

FIELD_TEXT_8

public static final java.lang.String FIELD_TEXT_8

See Also:

Constant Field Values

FIELD_TEXT_9

public static final java.lang.String FIELD_TEXT_9

See Also:

Constant Field Values

FIELD_TEXT_10

public static final java.lang.String FIELD_TEXT_10

See Also:

Constant Field Values

FIELD_DATE_1

public static final java.lang.String FIELD_DATE_1

See Also:

Constant Field Values

FIELD_DATE_2

public static final java.lang.String FIELD_DATE_2

See Also:

Constant Field Values

FIELD_DATE_3

public static final java.lang.String FIELD_DATE_3

See Also:

Constant Field Values

FIELD_DATE_4

public static final java.lang.String FIELD_DATE_4

See Also:

Constant Field Values

FIELD_DATE_5

public static final java.lang.String FIELD_DATE_5

See Also:

Constant Field Values

FIELD_RELEASE_1

public static final java.lang.String FIELD_RELEASE_1

See Also:

Constant Field Values

FIELD_RELEASE_2

public static final java.lang.String FIELD_RELEASE_2

See Also:

Constant Field Values

FIELD_USER_1

public static final java.lang.String FIELD_USER_1

See Also:

Constant Field Values

FIELD_USER_2

public static final java.lang.String FIELD_USER_2

See Also:

Constant Field Values

FIELD_FLAG_1

public static final java.lang.String FIELD_FLAG_1

See Also:

Constant Field Values

FIELD_FLAG_2

public static final java.lang.String FIELD_FLAG_2

See Also:

Constant Field Values

FIELD_FLAG_3

public static final java.lang.String FIELD_FLAG_3

See Also:

Constant Field Values

FIELD_FLAG_4

public static final java.lang.String FIELD_FLAG_4

See Also:

Constant Field Values

FIELD_FLAG_5

public static final java.lang.String FIELD_FLAG_5

See Also:

Constant Field Values

FIELD_ATTACHMENT

public static final java.lang.String FIELD_ATTACHMENT

See Also:

Constant Field Values

FIELD_CHILD_DOCUMENT_TYPE

public static final java.lang.String FIELD_CHILD_DOCUMENT_TYPE

See Also:

Constant Field Values

FIELD_LEGACY_KEY

public static final java.lang.String FIELD_LEGACY_KEY

See Also:

Constant Field Values

FIELD_TEST_CASE_STEPS

public static final java.lang.String FIELD_TEST_CASE_STEPS

See Also:

Constant Field Values

FIELD_TEST_CASE_STATUS

public static final java.lang.String FIELD_TEST_CASE_STATUS

See Also:

Constant Field Values

FIELD_TEST_RUN_STEPS

public static final java.lang.String FIELD_TEST_RUN_STEPS

See Also:

Constant Field Values

FIELD_END_DATE

public static final java.lang.String FIELD_END_DATE

See Also:

Constant Field Values

FIELD_START_DATE

public static final java.lang.String FIELD_START_DATE

See Also:

Constant Field Values

FIELD_ID

public static final java.lang.String FIELD_ID

See Also:

Constant Field Values

FIELD_DOCUMENT_KEY

public static final java.lang.String FIELD_DOCUMENT_KEY

See Also:

Constant Field Values

FIELD_SEQUENCE

public static final java.lang.String FIELD_SEQUENCE

See Also:

Constant Field Values

FIELD_LOCKED

public static final java.lang.String FIELD_LOCKED

See Also:

Constant Field Values

FIELD_LOCKED_BY

public static final java.lang.String FIELD_LOCKED_BY

See Also:

Constant Field Values

FIELD_LOCKED_DATE

public static final java.lang.String FIELD_LOCKED_DATE

See Also:

Constant Field Values

FIELD_EDITABLE

public static final java.lang.String FIELD_EDITABLE

See Also:

Constant Field Values

FIELD_DOCUMENT_TYPE

public static final java.lang.String FIELD_DOCUMENT_TYPE

See Also:

Constant Field Values

FIELD_GLOBAL_SORT_ORDER

public static final java.lang.String FIELD_GLOBAL_SORT_ORDER

See Also:

Constant Field Values

FIELD_SORT_ORDER

public static final java.lang.String FIELD_SORT_ORDER

See Also:

Constant Field Values

FIELD_INDENT

public static final java.lang.String FIELD_INDENT

See Also:

Constant Field Values

FIELD_PROJECT

public static final java.lang.String FIELD_PROJECT

See Also:

Constant Field Values

FIELD_DURATION

public static final java.lang.String FIELD_DURATION

See Also:

Constant Field Values

FIELD_TEST_PLAN

public static final java.lang.String FIELD_TEST_PLAN

See Also:

Constant Field Values

FIELD_TEST_CASE

public static final java.lang.String FIELD_TEST_CASE

See Also:

Constant Field Values

FIELD_TEST_CYCLE

public static final java.lang.String FIELD_TEST_CYCLE

See Also:

Constant Field Values

FIELD_TEST_RUN_SET

public static final java.lang.String FIELD_TEST_RUN_SET

See Also:

Constant Field Values

FIELD_TEST_RUN_STATUS

public static final java.lang.String FIELD_TEST_RUN_STATUS

See Also:

Constant Field Values

FIELD_ACTUAL_RESULTS

public static final java.lang.String FIELD_ACTUAL_RESULTS

See Also:

Constant Field Values

FIELD_SET_KEY

public static final java.lang.String FIELD_SET_KEY

See Also:

Constant Field Values

FIELD_ITEM_URL

public static final java.lang.String FIELD_ITEM_URL

See Also:

Constant Field Values

FIELD_REQUIRED

public static final java.lang.Integer FIELD_REQUIRED

The "required' field type, which doesn't mean that the user must supply a value, but that this field cannot be removed from item types that it is associated with (e.g. Test Case Steps on the Test Case item type).

See Also:

getFieldType()

CATEGORY_JIRA

public static final java.lang.Integer CATEGORY_JIRA

CATEGORY_SYSTEM

public static final java.lang.Integer CATEGORY_SYSTEM

CATEGORY_RALLY

public static final java.lang.Integer CATEGORY_RALLY

RESERVED_FIELD_NAMES

public static final java.util.List<java.lang.String> RESERVED_FIELD_NAMES

Constructor Detail

DocumentField

public DocumentField()

DocumentField

public DocumentField(java.lang.Integer id)

Method Detail

isAddableField

public static boolean isAddableField(DocumentField field)

Non-addable fields are those that aren't necessarily system-controlled (i.e. have category ) and aren't core fields (i.e. fields that should be shown for any type), but nonetheless should not be able to be added by the user to their created types.

isCoreField

public static boolean isCoreField(DocumentField field)

isCoreField

public static boolean isCoreField(java.lang.String fieldName)

isReservedField

public static boolean isReservedField(DocumentField field)

isReservedField

public static boolean isReservedField(java.lang.String fieldName)

isReservedFieldName

public static boolean isReservedFieldName(java.lang.String fieldName)

We use some reserved fields on the front end. Need to disallow these from being custom field names so custom field names with reserved names don't cause problems

isValidFieldForCategory

public static boolean isValidFieldForCategory(DocumentField field,
                                              DocumentType docType)

This method tells you if a field is valid for a given DocumentTypeCategory.

isSystemCustomField

public static boolean isSystemCustomField(DocumentField field)

isSystemCustomField

public static boolean isSystemCustomField(java.lang.String fieldName)

isPredefinedField

public static boolean isPredefinedField(DocumentField field)

isPredefinedField

public static boolean isPredefinedField(java.lang.String fieldName)

This method tells you if the field shares a name with a predefined field

getId

public java.lang.Integer getId()

Specified by:

getId in interface DomainObjectBase

setId

public void setId(java.lang.Integer id)

Specified by:

setId in interface DomainObjectBase

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getScopeId

public java.lang.Integer getScopeId()

Specified by:

getScopeId in interface ScopedObject

setScopeId

public void setScopeId(java.lang.Integer scope)

Specified by:

setScopeId in interface ScopedObject

getRefId

public java.lang.Integer getRefId()

Specified by:

getRefId in interface ScopedObject

setRefId

public void setRefId(java.lang.Integer referenceId)

Specified by:

setRefId in interface ScopedObject

getOrganizationId

public java.lang.Integer getOrganizationId()

Specified by:

getOrganizationId in interface DomainObjectBase

Specified by:

getOrganizationId in interface OrganizationAware

setOrganizationId

public void setOrganizationId(java.lang.Integer organizationId)

Specified by:

setOrganizationId in interface DomainObjectBase

getDataTypeId

public java.lang.Integer getDataTypeId()

setDataTypeId

public void setDataTypeId(java.lang.Integer dataType)

getFieldType

public java.lang.Integer getFieldType()

setFieldType

public void setFieldType(java.lang.Integer fieldType)

getCustom

public java.lang.Boolean getCustom()

setCustom

public void setCustom(java.lang.Boolean custom)

getFormXtype

public java.lang.String getFormXtype()

setFormXtype

public void setFormXtype(java.lang.String formXtype)

getEditXtype

public java.lang.String getEditXtype()

setEditXtype

public void setEditXtype(java.lang.String editXtype)

getGridXtype

public java.lang.String getGridXtype()

setGridXtype

public void setGridXtype(java.lang.String gridXtype)

getReadOnly

public java.lang.Boolean getReadOnly()

setReadOnly

public void setReadOnly(java.lang.Boolean readOnly)

getCategory

public java.lang.Integer getCategory()

setCategory

public void setCategory(java.lang.Integer category)

getIsDerived

public java.lang.Boolean getIsDerived()

setIsDerived

public void setIsDerived(java.lang.Boolean isDerived)

getUserConfigurable

public java.lang.Boolean getUserConfigurable()

setUserConfigurable

public void setUserConfigurable(java.lang.Boolean userConfigurable)

getXmlToString

public java.lang.String getXmlToString()

Specified by:

getXmlToString in interface DomainObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this object.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class DomainObjectBaseSupport

hashCode

public int hashCode()

Overrides:

hashCode in class DomainObjectBaseSupport