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
-
Nested Class Summary
Nested ClassesNested 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, logFields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType
DEFAULT_VALUE_TYPE, RESOURCE_PREVIEW -
Constructor Summary
ConstructorsConstructorDescriptionProjectCFType(CustomFieldValuePersister customFieldValuePersister, ProjectConverter projectConverter, PermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext, GenericConfigManager genericConfigManager, JiraBaseUrls jiraBaseUrls, ProjectManager projectManager) -
Method Summary
Modifier and TypeMethodDescriptionintcompare(org.ofbiz.core.entity.GenericValue customFieldObjectValue1, org.ofbiz.core.entity.GenericValue customFieldObjectValue2, FieldConfig fieldConfig) Compares the two custom field objects.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.Returns a List ofFieldConfigItemTypeobjects.protected PersistenceFieldTypeType of database field needed to store this field.protected ObjectgetDbValueFromObject(Project customFieldObject) Returns the database representation of the Java object as stored for that CustomField.getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.getJsonFromIssue(CustomField field, Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem) Return a JsonData representation of the field valuegetJsonSchema(CustomField customField) Return a description of the shape of this field when represented as JSON.Returns an instance ofNonNullCustomFieldProviderthat Jira will use to optimize indexing performance.protected ProjectgetObjectFromDbValue(Object databaseValue) Returns the Transport Object for the given Custom Field value as represented by the value stored in the databaseReturns the object that will perform the actual project import functions for the custom field type.getRepresentationFromIssue(Issue issue, CustomFieldExportContext context) Get the custom field representation of the issue, this object contains the column headers and values for each of theFieldExportPart.getRestFieldOperation(CustomField field) Returns the RestFieldOperationsHandler for this field.getSingularObjectFromString(String string) Returns a Singular Object, given the string value as passed by the presentation tier.getStringFromSingularObject(Project customFieldObject) Returns theStringrepresentation of a single value within the CustomFieldType.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, validateFromParamsMethods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
assertObjectImplementsType, availableForBulkEdit, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, init, isRenderable, valuesEqualMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType
areAllRequiredParametersPresent, getCloneOptionConfiguration, getCloneValue, isUserInputRequiredForMove, requiresAdditionalParamsMethods inherited from interface com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations
getJsonDefaultValue
-
Constructor Details
-
ProjectCFType
public ProjectCFType(CustomFieldValuePersister customFieldValuePersister, ProjectConverter projectConverter, PermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext, GenericConfigManager genericConfigManager, JiraBaseUrls jiraBaseUrls, ProjectManager projectManager)
-
-
Method Details
-
compare
public int compare(@Nonnull org.ofbiz.core.entity.GenericValue customFieldObjectValue1, @Nonnull org.ofbiz.core.entity.GenericValue customFieldObjectValue2, FieldConfig fieldConfig) Description copied from interface:SortableCustomFieldCompares the two custom field objects.- Specified by:
comparein interfaceSortableCustomField<org.ofbiz.core.entity.GenericValue>- Parameters:
customFieldObjectValue1- Never nullcustomFieldObjectValue2- Never null- Returns:
- 0, 1 or -1
-
getDatabaseType
Description copied from class:AbstractSingleFieldTypeType of database field needed to store this field.- Specified by:
getDatabaseTypein classAbstractSingleFieldType<Project>- Returns:
- One of the predefined
PersistenceFieldTypetypes.
-
getDbValueFromObject
Description copied from class:AbstractSingleFieldTypeReturns 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 byAbstractSingleFieldType.getDatabaseType()- Specified by:
getDbValueFromObjectin classAbstractSingleFieldType<Project>- Parameters:
customFieldObject- the Transport Object- Returns:
- String, Double or Date
-
getObjectFromDbValue
protected Project getObjectFromDbValue(@Nonnull Object databaseValue) throws FieldValidationException Description copied from class:AbstractSingleFieldTypeReturns the Transport Object for the given Custom Field value as represented by the value stored in the database- Specified by:
getObjectFromDbValuein classAbstractSingleFieldType<Project>- Parameters:
databaseValue- - String, Double or Date objects as returned fromAbstractSingleFieldType.getDbValueFromObject(Object)- Returns:
- Domain object or GenericValue
- Throws:
FieldValidationException- if field validation fails.
-
getStringFromSingularObject
Description copied from interface:CustomFieldTypeReturns theStringrepresentation 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 theCollectionorMap- Specified by:
getStringFromSingularObjectin interfaceCustomFieldType<Project,Project> - Parameters:
customFieldObject- the object- Returns:
- String representation of the Object
-
getSingularObjectFromString
Description copied from interface:CustomFieldTypeReturns 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:
getSingularObjectFromStringin interfaceCustomFieldType<Project,Project> - Parameters:
string- the String- Returns:
- singularObject instance
- Throws:
FieldValidationException- if the string is an invalid representation of the Object.
-
getConfigurationItemTypes
Description copied from interface:CustomFieldTypeReturns a List ofFieldConfigItemTypeobjects. Can not be immutable. This opens up possibilities for configurable custom fields.- Specified by:
getConfigurationItemTypesin interfaceCustomFieldType<Project,Project> - Overrides:
getConfigurationItemTypesin classAbstractCustomFieldType<Project,Project> - Returns:
- List of
FieldConfigItemType
-
getChangelogString
Description copied from interface:CustomFieldTypeReturns 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:
getChangelogStringin interfaceCustomFieldType<Project,Project> - Overrides:
getChangelogStringin classAbstractCustomFieldType<Project,Project> - Parameters:
field- CustomField that the value belongs tovalue- 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:CustomFieldTypeThe 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:
getVelocityParametersin interfaceCustomFieldType<Project,Project> - Overrides:
getVelocityParametersin classAbstractCustomFieldType<Project,Project> - Parameters:
issue- The issue currently in context (Note: this will be null in cases like 'default value')field- CustomFieldfieldLayoutItem- FieldLayoutItem- Returns:
- A
Mapof parameters to add to the velocity context, or an empty Map otherwise (never null)
-
getProjectImporter
Description copied from interface:ProjectImportableCustomFieldReturns the object that will perform the actual project import functions for the custom field type.- Specified by:
getProjectImporterin interfaceProjectImportableCustomField- Returns:
- the object that will perform the actual project import functions for the custom field type.
-
accept
- Overrides:
acceptin classAbstractSingleFieldType<Project>
-
getRepresentationFromIssue
Description copied from interface:ExportableCustomFieldTypeGet the custom field representation of the issue, this object contains the column headers and values for each of theFieldExportPart.- Specified by:
getRepresentationFromIssuein interfaceExportableCustomFieldType- Parameters:
issue- to get the representation forcontext- which contains information such as the i18nHelper and field- Returns:
- the exportable parts of this issue
-
getNonNullCustomFieldProvider
Description copied from interface:CustomFieldTypeReturns an instance ofNonNullCustomFieldProviderthat Jira will use to optimize indexing performance.- Specified by:
getNonNullCustomFieldProviderin interfaceCustomFieldType<Project,Project>
-
getFieldTypeInfo
Description copied from interface:RestAwareCustomFieldTypeReturns lower level Information about the field. This information contains allowed values and/or the autocomplete url- Specified by:
getFieldTypeInfoin interfaceRestAwareCustomFieldType- Parameters:
fieldTypeInfoContext- context information for generating theFieldTypeInfo.- Returns:
- Low level information about the field.
-
getJsonSchema
Description copied from interface:RestAwareCustomFieldTypeReturn a description of the shape of this field when represented as JSON.- Specified by:
getJsonSchemain interfaceRestAwareCustomFieldType
-
getJsonFromIssue
public FieldJsonRepresentation getJsonFromIssue(CustomField field, Issue issue, boolean renderedVersionRequested, @Nullable FieldLayoutItem fieldLayoutItem) Description copied from interface:RestAwareCustomFieldTypeReturn a JsonData representation of the field value- Specified by:
getJsonFromIssuein interfaceRestAwareCustomFieldType- Parameters:
field- configuration of the current fieldissue- to get field data fromrenderedVersionRequested- whether the use requested the return of rendered/pretty data as well as raw datafieldLayoutItem- 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
Description copied from interface:RestCustomFieldTypeOperationsReturns the RestFieldOperationsHandler for this field.- Specified by:
getRestFieldOperationin interfaceRestCustomFieldTypeOperations- Parameters:
field- the Custom Field- Returns:
- the RestFieldOperationsHandler for this field.
-