com.atlassian.jira.issue.customfields.converters

Interface ProjectConverter

All Known Implementing Classes:

ProjectConverterImpl

@Internal
public interface ProjectConverter

Method Summary

Modifier and Type	Method and Description
Project	getProject(Long projectId) Get the Project for the given ID.
Project	getProject(String stringValue) Get the Project that this String value represents.
Project	getProjectObject(Long projectId) Get the Project for the given ID.
Project	getProjectObject(String stringValue) Get the Project that this String value represents.
String	getString(Project project) Get the String value that represents the given Project.

Method Detail

getString

String getString(Project project)

Get the String value that represents the given Project.

Parameters:

project - Project to convert

Returns:

the String value that represents the given Project.

getProjectObject

Project getProjectObject(String stringValue)
                  throws FieldValidationException

Get the Project that this String value represents.

Same as getProject() and exists for legacy reasons.

Parameters:

stringValue - the String representation.

Returns:

the Project that this String value represents.

Throws:

FieldValidationException - if we are unable to convert the String representation.

getProjectObject

Project getProjectObject(Long projectId)
                  throws FieldValidationException

Get the Project for the given ID. If a null projectId is passed in, then a null Project is returned.

Same as getProject() and exists for legacy reasons.

Parameters:

projectId - the Project ID.

Returns:

the Project for the given ID.

Throws:

FieldValidationException - if the Project ID is invalid.

getProject

Project getProject(String stringValue)
            throws FieldValidationException

Get the Project that this String value represents.

Parameters:

stringValue - the String representation.

Returns:

the Project that this String value represents.

Throws:

FieldValidationException - if we are unable to convert the String representation.

getProject

Project getProject(Long projectId)
            throws FieldValidationException

Get the Project for the given ID.

Parameters:

projectId - the Project ID.

Returns:

the Project for the given ID.

Throws:

FieldValidationException - if the Project ID is invalid.