com.deiser.jira.profields.api.field.item.list

Interface ListItemService

public interface ListItemService

Service to manage the items of the list field

Method Summary

Modifier and Type	Method and Description
ListItem	create(ListItemBuilder builder) Create a new list item
void	delete(ListItem item) Delete the list item
List<ListItem>	getAllItems() Get all list items in the system.
ListItem	getItemByValue(ListField field, String value) Get the item in List by its value
ListItem	getItemByValue(ListField field, String value, com.atlassian.jira.project.Project project) Get the item in List by its value
ListItem	getItemByValue(ListField field, String value, String parentValue) Get the item in List by its value
ListItem	getItemByValue(ListField field, String value, String parentValue, com.atlassian.jira.project.Project project) Get the item in List by its value
List<ListItem>	getItems(ListField field) Get the list of items for a list field
List<ListItem>	getItems(ListField field, List<String> listParentValue, com.atlassian.jira.project.Project project) Get the list of items for a list field
ListItemBuilder	newBuilder() Get a new builder to create items for a list field
void	update(ListItem item) Change the list item

Method Detail

newBuilder

ListItemBuilder newBuilder()

Get a new builder to create items for a list field

Returns:

the list item builder

create

ListItem create(ListItemBuilder builder)

Create a new list item

Parameters:

builder - The specific builder

Returns:

The list item

getAllItems

List<ListItem> getAllItems()

Get all list items in the system. It method doesn't get external items.

Returns:

the list of items

getItems

List<ListItem> getItems(ListField field)

Get the list of items for a list field

Parameters:

field - The list field

Returns:

the list of items

getItems

List<ListItem> getItems(ListField field,
                        List<String> listParentValue,
                        com.atlassian.jira.project.Project project)

Get the list of items for a list field

Parameters:

field - The list field

listParentValue - The parent values. It's usable for multiple list and external list.

project - The project of Jira. It's usable for get items of external list.

Returns:

the list of items

update

void update(ListItem item)

Change the list item

Parameters:

item - The list item to change

delete

void delete(ListItem item)

Delete the list item

Parameters:

item - The item to delete

getItemByValue

ListItem getItemByValue(ListField field,
                        String value)

Get the item in List by its value

Parameters:

field - The list field

value - The value to find

Returns:

The item or null

getItemByValue

ListItem getItemByValue(ListField field,
                        String value,
                        com.atlassian.jira.project.Project project)

Get the item in List by its value

Parameters:

field - The list field

value - The value to find

project - Current Jira project to get items of external list.

Returns:

The item or null

getItemByValue

ListItem getItemByValue(ListField field,
                        String value,
                        String parentValue)

Get the item in List by its value

Parameters:

field - The list field

value - The value to find

parentValue - The parent value to find

Returns:

The item or null

getItemByValue

ListItem getItemByValue(ListField field,
                        String value,
                        String parentValue,
                        com.atlassian.jira.project.Project project)

Get the item in List by its value

Parameters:

field - The list field

value - The value to find

parentValue - The parent value to find

project - Current Jira project to get items of external list.

Returns:

The item or null