com.deiser.jira.profields.api.field

Interface Field

All Known Subinterfaces:

CumulativeField, DateField, DurationField, FormulaField, GroupField, GroupMultipleField, ListExtField, ListExtMultipleField, ListField, ListMultipleField, ListParentField, NumberField, PriorityField, ProjectCategoryField, ProjectCreationField, ProjectDefaultAssigneeField, ProjectDescriptionField, ProjectField, ProjectKeyField, ProjectLeadField, ProjectMultipleField, ProjectNameField, ProjectTypeField, ProjectUrlField, ScriptField, StatusField, TextField, TextMultipleField, UserField, UserMultipleField

public interface Field

Field.

Method Summary

Modifier and Type	Method and Description
Long	getCustomFieldId() Get the custom field id of the field.
String	getDescription() Get the description of the field.
com.deiser.jira.profields.impl.field.type.FieldActions	getFieldActions() Get all allowed options for action
Integer	getId() Get the id of the field.
String	getName() Get the name of the field.
com.deiser.jira.profields.impl.field.wrapper.PQLFieldToken	getPQLToken() Get the token for using in PQL.
Long	getProjectRoleId() Get the project role id of the field.
FieldType	getType() Get the type of the field.
boolean	hasCustomField() Get if the field has a custom field associated
boolean	hasParent() Get if the field has parent field
boolean	isList() Get if the field is type of list
boolean	isMultiple() Get if the field is multiple
boolean	isPredefined() Get if the field is a predefined field
boolean	isSystem() Get if the field is a system field
void	setCustomField(boolean value) Set the custom field of the field.
void	setDescription(String description) Set the description of the field.
void	setName(String name) Set the name of the field.
void	setNobodyAsProjectRole() Set nobody project role for the field.
void	setProjectRole(com.atlassian.jira.security.roles.ProjectRole role) Set the project role of the field.

Method Detail

getId

Integer getId()

Get the id of the field.

Returns:

the id of the field

getName

String getName()

Get the name of the field.

Returns:

the name of the field

getPQLToken

com.deiser.jira.profields.impl.field.wrapper.PQLFieldToken getPQLToken()

Get the token for using in PQL.

Returns:

pql Token

setName

void setName(String name)

Set the name of the field.

Parameters:

name - the name of the field.

getDescription

String getDescription()

Get the description of the field.

Returns:

the description of the field

setDescription

void setDescription(String description)

Set the description of the field.

Parameters:

description - the description of the field

getProjectRoleId

Long getProjectRoleId()

Get the project role id of the field.

Returns:

the project role id of the field

setProjectRole

void setProjectRole(com.atlassian.jira.security.roles.ProjectRole role)

Set the project role of the field.

Parameters:

role - the project role of jira for the field.

setNobodyAsProjectRole

void setNobodyAsProjectRole()

Set nobody project role for the field.

getCustomFieldId

Long getCustomFieldId()

Get the custom field id of the field.

Returns:

the custom field id of the field

setCustomField

void setCustomField(boolean value)

Set the custom field of the field.

Parameters:

value - the custom field

hasCustomField

boolean hasCustomField()

Get if the field has a custom field associated

Returns:

true if the field has a custom field associated

getType

FieldType getType()

Get the type of the field.

Returns:

the type of the field

isSystem

boolean isSystem()

Get if the field is a system field

Returns:

true if the field is a system field

isMultiple

boolean isMultiple()

Get if the field is multiple

Returns:

true if the field is multiple

isList

boolean isList()

Get if the field is type of list

Returns:

true if the field belong to list fields

hasParent

boolean hasParent()

Get if the field has parent field

Returns:

true if the field has a parent field

isPredefined

boolean isPredefined()

Get if the field is a predefined field

Returns:

true if the field is a predefined field.

getFieldActions

com.deiser.jira.profields.impl.field.type.FieldActions getFieldActions()

Get all allowed options for action

Returns:

FieldOptionsForActions