com.atlassian.jira.issue.customfields.impl

Class ProjectCFType

java.lang.Object

com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<T,T>

com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType<Project>

com.atlassian.jira.issue.customfields.impl.ProjectCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType<Project,Project>, SortableCustomField<org.ofbiz.core.entity.GenericValue>, ExportableCustomFieldType, RestAwareCustomFieldType, RestCustomFieldTypeOperations

public class ProjectCFType
extends AbstractSingleFieldType<Project>
implements SortableCustomField<org.ofbiz.core.entity.GenericValue>, ProjectImportableCustomField, RestAwareCustomFieldType, RestCustomFieldTypeOperations, ExportableCustomFieldType

Custom Field Type to select a Project on this JIRA instance.

Transport Object Type

GenericValue

Database Storage Type

Long of Project ID

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProjectCFType.Visitor<T>

Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

AbstractCustomFieldType.VisitorBase<X>

Field Summary

Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType

customFieldValuePersister, FIELD_TYPE_DATE, FIELD_TYPE_NUMBER, FIELD_TYPE_STRING, FIELD_TYPE_TEXT, genericConfigManager, log

Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

DEFAULT_VALUE_TYPE, RESOURCE_PREVIEW

Constructor Summary

Constructors

Constructor and Description
ProjectCFType(CustomFieldValuePersister customFieldValuePersister, ProjectConverter projectConverter, PermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext, GenericConfigManager genericConfigManager, JiraBaseUrls jiraBaseUrls, ProjectManager projectManager)

Method Summary

Modifier and Type	Method and Description
Object	accept(AbstractCustomFieldType.VisitorBase visitor)
int	compare(org.ofbiz.core.entity.GenericValue customFieldObjectValue1, org.ofbiz.core.entity.GenericValue customFieldObjectValue2, FieldConfig fieldConfig) Compares the two custom field objects.
String	getChangelogString(CustomField field, Project value) Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.
List<FieldConfigItemType>	getConfigurationItemTypes() Returns a List of FieldConfigItemType objects.
protected PersistenceFieldType	getDatabaseType() Type of database field needed to store this field.
protected Object	getDbValueFromObject(Project customFieldObject) Returns the database representation of the Java object as stored for that CustomField.
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.
FieldJsonRepresentation	getJsonFromIssue(CustomField field, Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem) Return a JsonData representation of the field value
JsonType	getJsonSchema(CustomField customField) Return a description of the shape of this field when represented as JSON.
protected Project	getObjectFromDbValue(Object databaseValue) Returns the Transport Object for the given Custom Field value as represented by the value stored in the database
ProjectCustomFieldImporter	getProjectImporter() Returns the object that will perform the actual project import functions for the custom field type.
FieldExportParts	getRepresentationFromIssue(Issue issue, CustomFieldExportContext context) Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.
RestFieldOperationsHandler	getRestFieldOperation(CustomField field) Returns the RestFieldOperationsHandler for this field.
Project	getSingularObjectFromString(String string) Returns a Singular Object, given the string value as passed by the presentation tier.
String	getStringFromSingularObject(Project customFieldObject) Returns the String representation of a single value within the CustomFieldType.
Map<String,Object>	getVelocityParameters(Issue issue, CustomField field, FieldLayoutItem fieldLayoutItem) The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).

Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType

createValue, getChangelogValue, getDefaultValue, getJsonDefaultValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, getValueFromIssue, getValueFromIssue, remove, setDefaultValue, updateValue, validateFromParams

Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

assertObjectImplementsType, availableForBulkEdit, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, init, isRenderable, valuesEqual

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations

getJsonDefaultValue

Methods inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

getCloneOptionConfiguration, getCloneValue, isUserInputRequiredForMove

Constructor Detail

ProjectCFType

public ProjectCFType(CustomFieldValuePersister customFieldValuePersister,
                     ProjectConverter projectConverter,
                     PermissionManager permissionManager,
                     JiraAuthenticationContext jiraAuthenticationContext,
                     GenericConfigManager genericConfigManager,
                     JiraBaseUrls jiraBaseUrls,
                     ProjectManager projectManager)

Method Detail

compare

public int compare(@Nonnull
                   org.ofbiz.core.entity.GenericValue customFieldObjectValue1,
                   @Nonnull
                   org.ofbiz.core.entity.GenericValue customFieldObjectValue2,
                   FieldConfig fieldConfig)

Description copied from interface: SortableCustomField

Compares the two custom field objects.

Specified by:

compare in interface SortableCustomField<org.ofbiz.core.entity.GenericValue>

Parameters:

customFieldObjectValue1 - Never null

customFieldObjectValue2 - Never null

Returns:

0, 1 or -1

getDatabaseType

@Nonnull
protected PersistenceFieldType getDatabaseType()

Description copied from class: AbstractSingleFieldType

Type of database field needed to store this field.

Specified by:

getDatabaseType in class AbstractSingleFieldType<Project>

Returns:

One of the predefined PersistenceFieldType types.

getDbValueFromObject

protected Object getDbValueFromObject(Project customFieldObject)

Description copied from class: AbstractSingleFieldType

Returns the database representation of the Java object as stored for that CustomField. (eg. ProjectId if the Value represents a project). Must be compatable with type returned by AbstractSingleFieldType.getDatabaseType()

Specified by:

getDbValueFromObject in class AbstractSingleFieldType<Project>

Parameters:

customFieldObject - the Transport Object

Returns:

String, Double or Date

getObjectFromDbValue

protected Project getObjectFromDbValue(@Nonnull
                                       Object databaseValue)
                                throws FieldValidationException

Description copied from class: AbstractSingleFieldType

Returns the Transport Object for the given Custom Field value as represented by the value stored in the database

Specified by:

getObjectFromDbValue in class AbstractSingleFieldType<Project>

Parameters:

databaseValue - - String, Double or Date objects as returned from AbstractSingleFieldType.getDbValueFromObject(Object)

Returns:

Domain object or GenericValue

Throws:

FieldValidationException - if field validation fails.

getStringFromSingularObject

public String getStringFromSingularObject(Project customFieldObject)

Description copied from interface: CustomFieldType

Returns the String representation of a single value within the CustomFieldType. This is the value that is passed to the presentation tier for editing. For single CustomFieldTypes the Singular Object is the same as a Transport Object. However, for multi-dimensional CustomFieldTypes, the Singular Object is the Object contained within the Collection or Map

Specified by:

getStringFromSingularObject in interface CustomFieldType<Project,Project>

Parameters:

customFieldObject - the object

Returns:

String representation of the Object

getSingularObjectFromString

public Project getSingularObjectFromString(String string)
                                    throws FieldValidationException

Description copied from interface: CustomFieldType

Returns a Singular Object, given the string value as passed by the presentation tier. Throws FieldValidationException if the string is an invalid representation of the Object.

Specified by:

getSingularObjectFromString in interface CustomFieldType<Project,Project>

Parameters:

string - the String

Returns:

singularObject instance

Throws:

FieldValidationException - if the string is an invalid representation of the Object.

getConfigurationItemTypes

@Nonnull
public List<FieldConfigItemType> getConfigurationItemTypes()

Description copied from interface: CustomFieldType

Returns a List of FieldConfigItemType objects. Can not be immutable. This opens up possibilities for configurable custom fields.

Specified by:

getConfigurationItemTypes in interface CustomFieldType<Project,Project>

Overrides:

getConfigurationItemTypes in class AbstractCustomFieldType<Project,Project>

Returns:

List of FieldConfigItemType

getChangelogString

public String getChangelogString(CustomField field,
                                 Project value)

Description copied from interface: CustomFieldType

Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.

Specified by:

getChangelogString in interface CustomFieldType<Project,Project>

Overrides:

getChangelogString in class AbstractCustomFieldType<Project,Project>

Parameters:

field - CustomField that the value belongs to

value - Transport Object representing the value instance of the CustomField

Returns:

Change log string.

getVelocityParameters

@Nonnull
public Map<String,Object> getVelocityParameters(Issue issue,
                                                         CustomField field,
                                                         FieldLayoutItem fieldLayoutItem)

Description copied from interface: CustomFieldType

The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).

The values are added to the context for all velocity views (edit, search, view, xml)

Specified by:

getVelocityParameters in interface CustomFieldType<Project,Project>

Overrides:

getVelocityParameters in class AbstractCustomFieldType<Project,Project>

Parameters:

issue - The issue currently in context (Note: this will be null in cases like 'default value')

field - CustomField

fieldLayoutItem - FieldLayoutItem

Returns:

A Map of parameters to add to the velocity context, or an empty Map otherwise (never null)

getProjectImporter

public ProjectCustomFieldImporter getProjectImporter()

Description copied from interface: ProjectImportableCustomField

Returns the object that will perform the actual project import functions for the custom field type.

Specified by:

getProjectImporter in interface ProjectImportableCustomField

Returns:

the object that will perform the actual project import functions for the custom field type.

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class AbstractSingleFieldType<Project>

getRepresentationFromIssue

public FieldExportParts getRepresentationFromIssue(Issue issue,
                                                   CustomFieldExportContext context)

Description copied from interface: ExportableCustomFieldType

Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.

Specified by:

getRepresentationFromIssue in interface ExportableCustomFieldType

Parameters:

issue - to get the representation for

context - which contains information such as the i18nHelper and field

Returns:

the exportable parts of this issue

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Description copied from interface: RestAwareCustomFieldType

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Specified by:

getFieldTypeInfo in interface RestAwareCustomFieldType

Parameters:

fieldTypeInfoContext - context information for generating the FieldTypeInfo.

Returns:

Low level information about the field.

getJsonSchema

public JsonType getJsonSchema(CustomField customField)

Description copied from interface: RestAwareCustomFieldType

Return a description of the shape of this field when represented as JSON.

Specified by:

getJsonSchema in interface RestAwareCustomFieldType

getJsonFromIssue

public FieldJsonRepresentation getJsonFromIssue(CustomField field,
                                                Issue issue,
                                                boolean renderedVersionRequested,
                                                @Nullable
                                                FieldLayoutItem fieldLayoutItem)

Description copied from interface: RestAwareCustomFieldType

Return a JsonData representation of the field value

Specified by:

getJsonFromIssue in interface RestAwareCustomFieldType

Parameters:

field - configuration of the current field

issue - to get field data from

renderedVersionRequested - whether the use requested the return of rendered/pretty data as well as raw data

fieldLayoutItem - field layout for this field.

Returns:

FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

getRestFieldOperation

public RestFieldOperationsHandler getRestFieldOperation(CustomField field)

Description copied from interface: RestCustomFieldTypeOperations

Returns the RestFieldOperationsHandler for this field.

Specified by:

getRestFieldOperation in interface RestCustomFieldTypeOperations

Parameters:

field - the Custom Field

Returns:

the RestFieldOperationsHandler for this field.