How do I get all options from a CustomField select list?

Maja Stach July 28, 2013

Hello.

I'm trying to get all Values available from a CustomField of the type select List.
I need this for a ValuesGenerator in my Report-Plugin.

I tried :

CustomField division = cfManager.getCustomFieldObjectByName("Division");
		Options opt = division.getOptions(null, jcn);

and:

CustomField division = cfManager.getCustomFieldObjectByName("Division");
    	division.getPropertySet();

and then I tried to handle the PropertySet.
However I'm not even sure PropertySet or Option is what I need, somehow I don't quite grasp what the api is trying to tell me. =(

Any help?

Thanks in advance =)

2 answers

1 accepted

1 vote
Answer accepted
RambanamP
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 28, 2013

try with this code

CustomField division = cfManager.getCustomFieldObjectByName("Division");
if(division!=null){
IssueContextImpl issueContext = new IssueContextImpl(issue.getProjectObject(), issue.getIssueTypeObject());
FieldConfig fieldConfig = division.getRelevantConfig(issueContext);
OptionsManager optionsManager = (OptionsManager) ComponentManager.getComponentInstanceOfType(OptionsManager.class);
Options op=optionsManager.getOptions(fieldConfig);
}

Maja Stach July 28, 2013

This actually did the Trick! Yay! Thank you so much.
I have to be through with this till wednesday, you saved me^^

I used some random Issue... I hope that's giong to work for everything^^

Thx

Nic Brough -Adaptavist-
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
July 28, 2013

No, it won't. You'll only get the list of options for the field context for that issue. For example, if your field has options aa, bb, cc in project WRT and dd, ee, ff in project TRW, then you'll only get half the options listed, because using WRT-1 as your random issue means you get the context which contains only aa, bb and cc.

It will work fine if your field context is global though.

0 votes
Nic Brough -Adaptavist-
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
July 28, 2013

I use the code in your first block, but it's more complex than that, because you need to look at the field's context (a single field can have many different option lists).

Rather than try to explain it on long-winded English, there's code below. It assumes you're working with an issue and a custom field. I'm not sure how you'd get to the field context stuff directly without an issue, but this should get you part of the way there:

OptionsManager optionsManager = ManagerFactory.getOptionsManager();
        
CustomFieldManager cfm = ManagerFactory.getCustomFieldManager();

FieldConfig config = cf.getRelevantConfig(issue);
Options options = optionsManager.getOptions(config);
List<Option> optionList = options.getRootOptions();

for (Option foundOption : optionList) {
            //do something with the foundoption
        }

Suggest an answer

Log in or Sign up to answer