|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CustomFields
Actions for administering the custom fields in JIRA.
Method Summary | |
---|---|
String |
addConfigurationSchemeContext(String numericCustomFieldId,
String label,
String[] issueTypeIds,
String[] projectIds)
Adds a custom field configuration scheme context. |
String |
addCustomField(String fieldType,
String fieldName)
Adds a custom field of the specified type to JIRA. |
String |
addCustomField(String fieldType,
String fieldName,
String[] issueTypeIds,
String[] projectIds)
Adds a custom field of the specified type to JIRA. |
void |
addOptions(String numericCustomFieldId,
String... options)
Add options to a customfield that supports it (i.e. |
void |
disableOptions(String numericCustomFieldId,
String... options)
disable options from a customfield that supports them (i.e. |
void |
editConfigurationSchemeContextById(String numericCustomFieldId,
String fieldConfigSchemeId,
String label,
String[] issueTypeIds,
String[] projectIds)
Alters an existing custom field configuration scheme context. |
void |
editConfigurationSchemeContextByLabel(String numericCustomFieldId,
String label,
String newLabel,
String[] issueTypeIds,
String[] projectIds)
Alters an existing custom field configuration scheme context. |
void |
editOptionValue(String numericCustomFieldId,
String option,
String newValue)
Change teh display value of an option from a customfield that supports them (i.e. |
void |
enableOptions(String numericCustomFieldId,
String... options)
enable options from a customfield that supports them (i.e. |
void |
removeConfigurationSchemeContextById(String numericCustomFieldId,
String fieldConfigSchemeId)
Removes the context from the specified custom field with the specified config scheme id. |
void |
removeConfigurationSchemeContextByLabel(String numericCustomFieldId,
String fieldConfigSchemeLabel)
Removes the context from the specified custom field with the specified config scheme id. |
void |
removeCustomField(String customFieldId)
Removes the custom field |
void |
removeGlobalContext(String numericCustomFieldId)
Removes the global context from the specified custom field's configuration schemes. |
void |
removeOptions(String numericCustomFieldId,
String... options)
Remove options from a customfield that supports them (i.e. |
String |
renameCustomField(String numericCustomFieldId,
String newCustomFieldName)
Renames the custom field. |
String |
setCustomFieldSearcher(String numericCustomFieldId,
String searcherKey)
Sets the searcher for the specified custom field. |
void |
setDefaultValue(String numericCustomFieldId,
String defValue)
Set default value for any custom field that supports default value. |
Method Detail |
---|
String addCustomField(String fieldType, String fieldName)
fieldType
- the full name of the custom field type to add e.g. com.atlassian.jira.plugin.system.customfieldtypes:userpicker
fieldName
- the name of the custom field e.g. UserCF
A formatted String containing the id of the custom field, the format used is: customfield_customfield-id
For example, customfield_10000
String addCustomField(String fieldType, String fieldName, String[] issueTypeIds, String[] projectIds)
fieldType
- the full name of the custom field type to add e.g. com.atlassian.jira.plugin.system.customfieldtypes:userpicker
fieldName
- the name of the custom field e.g. UserCF
issueTypeIds
- the ids of the issue types; must not be nullprojectIds
- the ids of the projects; must not be null
customfield_10000
String setCustomFieldSearcher(String numericCustomFieldId, String searcherKey)
numericCustomFieldId
- the numeric custom field idsearcherKey
- the full key of the searcher to use e.g. com.atlassian.jira.plugin.system.customfieldtypes:numberrange
.
Use null
to remove the searcher.
String renameCustomField(String numericCustomFieldId, String newCustomFieldName)
numericCustomFieldId
- the numeric custom field idnewCustomFieldName
- the new name for the custom field e.g. My CF
String addConfigurationSchemeContext(String numericCustomFieldId, String label, String[] issueTypeIds, String[] projectIds)
numericCustomFieldId
- the numeric custom field idlabel
- the new nameissueTypeIds
- the ids of the issue types; must not be nullprojectIds
- the ids of the projects; must not be null
10013
void editConfigurationSchemeContextById(String numericCustomFieldId, String fieldConfigSchemeId, String label, String[] issueTypeIds, String[] projectIds)
numericCustomFieldId
- the numeric custom field idfieldConfigSchemeId
- the id of the schemelabel
- the new name; use null if no update requiredissueTypeIds
- the ids of the issue types; use null if no update requiredprojectIds
- the ids of the projects; use null if no update requiredvoid editConfigurationSchemeContextByLabel(String numericCustomFieldId, String label, String newLabel, String[] issueTypeIds, String[] projectIds)
numericCustomFieldId
- the numeric custom field idlabel
- the label of the schemenewLabel
- the new name; use null if no update requiredissueTypeIds
- the ids of the issue types; use null if no update requiredprojectIds
- the ids of the projects; use null if no update requiredvoid removeGlobalContext(String numericCustomFieldId)
numericCustomFieldId
- the numeric custom field idvoid removeConfigurationSchemeContextById(String numericCustomFieldId, String fieldConfigSchemeId)
numericCustomFieldId
- the numeric custom field idfieldConfigSchemeId
- the numeric field config scheme idvoid removeConfigurationSchemeContextByLabel(String numericCustomFieldId, String fieldConfigSchemeLabel)
numericCustomFieldId
- the numeric custom field idfieldConfigSchemeLabel
- the label of the field config schemevoid removeCustomField(String customFieldId)
customFieldId
- the full custom field id e.g. customfield_10000
void addOptions(String numericCustomFieldId, String... options)
numericCustomFieldId
- the numeric customfield idoptions
- the options to addvoid setDefaultValue(String numericCustomFieldId, String defValue)
numericCustomFieldId
- the numeric customfield iddefValue
- default valuevoid disableOptions(String numericCustomFieldId, String... options)
numericCustomFieldId
- the numeric custom field idoptions
- to disablevoid enableOptions(String numericCustomFieldId, String... options)
numericCustomFieldId
- the numeric custom field idoptions
- to enablevoid removeOptions(String numericCustomFieldId, String... options)
numericCustomFieldId
- the numeric custom field idoptions
- to removevoid editOptionValue(String numericCustomFieldId, String option, String newValue)
numericCustomFieldId
- the numeric custom field idoption
- id to change
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |