public class ProjectCFType extends AbstractSingleFieldType<Project> implements SortableCustomField<org.ofbiz.core.entity.GenericValue>, ProjectImportableCustomField, RestAwareCustomFieldType, RestCustomFieldTypeOperations
Modifier and Type | Class and Description |
---|---|
static interface |
ProjectCFType.Visitor<T> |
AbstractCustomFieldType.VisitorBase<X>
customFieldValuePersister, FIELD_TYPE_DATE, FIELD_TYPE_NUMBER, FIELD_TYPE_STRING, FIELD_TYPE_TEXT, genericConfigManager, log
DEFAULT_VALUE_TYPE, RESOURCE_PREVIEW
Constructor and Description |
---|
ProjectCFType(CustomFieldValuePersister customFieldValuePersister,
ProjectConverter projectConverter,
PermissionManager permissionManager,
JiraAuthenticationContext jiraAuthenticationContext,
GenericConfigManager genericConfigManager,
JiraBaseUrls jiraBaseUrls,
ProjectManager projectManager) |
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.
|
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).
|
createValue, getChangelogValue, getDefaultValue, getJsonDefaultValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, getValueFromIssue, getValueFromIssue, remove, setDefaultValue, updateValue, validateFromParams
assertObjectImplementsType, availableForBulkEdit, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, init, isRenderable, valuesEqual
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getJsonDefaultValue
public ProjectCFType(CustomFieldValuePersister customFieldValuePersister, ProjectConverter projectConverter, PermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext, GenericConfigManager genericConfigManager, JiraBaseUrls jiraBaseUrls, ProjectManager projectManager)
public int compare(@Nonnull org.ofbiz.core.entity.GenericValue customFieldObjectValue1, @Nonnull org.ofbiz.core.entity.GenericValue customFieldObjectValue2, FieldConfig fieldConfig)
SortableCustomField
compare
in interface SortableCustomField<org.ofbiz.core.entity.GenericValue>
customFieldObjectValue1
- Never nullcustomFieldObjectValue2
- Never null@Nonnull protected PersistenceFieldType getDatabaseType()
AbstractSingleFieldType
getDatabaseType
in class AbstractSingleFieldType<Project>
PersistenceFieldType
types.protected Object getDbValueFromObject(Project customFieldObject)
AbstractSingleFieldType
AbstractSingleFieldType.getDatabaseType()
getDbValueFromObject
in class AbstractSingleFieldType<Project>
customFieldObject
- the Transport Objectprotected Project getObjectFromDbValue(@Nonnull Object databaseValue) throws FieldValidationException
AbstractSingleFieldType
getObjectFromDbValue
in class AbstractSingleFieldType<Project>
databaseValue
- - String, Double or Date objects as returned from AbstractSingleFieldType.getDbValueFromObject(Object)
FieldValidationException
- if field validation fails.public String getStringFromSingularObject(Project customFieldObject)
CustomFieldType
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
getStringFromSingularObject
in interface CustomFieldType<Project,Project>
customFieldObject
- the objectpublic Project getSingularObjectFromString(String string) throws FieldValidationException
CustomFieldType
getSingularObjectFromString
in interface CustomFieldType<Project,Project>
string
- the StringFieldValidationException
- if the string is an invalid representation of the Object.@Nonnull public List<FieldConfigItemType> getConfigurationItemTypes()
CustomFieldType
FieldConfigItemType
objects. Can not be immutable.
This opens up possibilities for configurable custom fields.getConfigurationItemTypes
in interface CustomFieldType<Project,Project>
getConfigurationItemTypes
in class AbstractCustomFieldType<Project,Project>
FieldConfigItemType
public String getChangelogString(CustomField field, Project value)
CustomFieldType
getChangelogString
in interface CustomFieldType<Project,Project>
getChangelogString
in class AbstractCustomFieldType<Project,Project>
field
- CustomField that the value belongs tovalue
- Transport Object representing the value instance of the CustomField@Nonnull public Map<String,Object> getVelocityParameters(Issue issue, CustomField field, FieldLayoutItem fieldLayoutItem)
CustomFieldType
The values are added to the context for all velocity views (edit, search, view, xml)
getVelocityParameters
in interface CustomFieldType<Project,Project>
getVelocityParameters
in class AbstractCustomFieldType<Project,Project>
issue
- The issue currently in context (Note: this will be null in cases like 'default value')field
- CustomFieldfieldLayoutItem
- FieldLayoutItemMap
of parameters to add to the velocity context, or an empty Map otherwise (never null)public ProjectCustomFieldImporter getProjectImporter()
ProjectImportableCustomField
getProjectImporter
in interface ProjectImportableCustomField
public Object accept(AbstractCustomFieldType.VisitorBase visitor)
accept
in class AbstractSingleFieldType<Project>
public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
RestAwareCustomFieldType
getFieldTypeInfo
in interface RestAwareCustomFieldType
fieldTypeInfoContext
- context information for generating the FieldTypeInfo
.public JsonType getJsonSchema(CustomField customField)
RestAwareCustomFieldType
getJsonSchema
in interface RestAwareCustomFieldType
public FieldJsonRepresentation getJsonFromIssue(CustomField field, Issue issue, boolean renderedVersionRequested, @Nullable FieldLayoutItem fieldLayoutItem)
RestAwareCustomFieldType
getJsonFromIssue
in interface RestAwareCustomFieldType
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.public RestFieldOperationsHandler getRestFieldOperation(CustomField field)
RestCustomFieldTypeOperations
getRestFieldOperation
in interface RestCustomFieldTypeOperations
field
- the Custom FieldCopyright © 2002-2015 Atlassian. All Rights Reserved.