com.atlassian.jira.project.type

Class ProjectTypeManagerImpl

java.lang.Object

com.atlassian.jira.project.type.ProjectTypeManagerImpl

All Implemented Interfaces:

ProjectTypeManager

public class ProjectTypeManagerImpl
extends Object
implements ProjectTypeManager

Default implementation for ProjectTypeManager

Field Summary

Fields

Modifier and Type	Field and Description
static int	INACCESSIBLE_WEIGHT

Constructor Summary

Constructors

Constructor and Description
ProjectTypeManagerImpl(JiraApplicationAdapter adapter)

Method Summary

Modifier and Type	Method and Description
io.atlassian.fugue.Option<ProjectType>	getAccessibleProjectType(ApplicationUser user, ProjectTypeKey key) Returns the project type with the given key, if it is accessible for the given user.
io.atlassian.fugue.Option<ProjectType>	getAccessibleProjectType(ProjectTypeKey key) Returns the project type with the given key, if it is accessible.
List<ProjectType>	getAllAccessibleProjectTypes() Returns all the accessible project types defined on the JIRA instance sorted by weight.
List<ProjectType>	getAllProjectTypes() Returns all the project types defined on the JIRA instance sorted by weight not taking into account whether the license to use those project types is valid or not.
io.atlassian.fugue.Option<com.atlassian.application.api.Application>	getApplicationWithType(ProjectTypeKey key) Returns the application that provides the given project type.
io.atlassian.fugue.Option<ProjectType>	getByKey(ProjectTypeKey key) Returns the project type with the given key, if it is present on the JIRA instance.
ProjectType	getInaccessibleProjectType() Returns a project type with information to be displayed to users when a specific project type is not accessible.
boolean	isProjectTypeInstalledButInaccessible(ProjectTypeKey projectTypeKey) Returns whether the project type with the given key is installed but inaccessible.
boolean	isProjectTypeUninstalled(ProjectTypeKey projectTypeKey) Returns whether the project type with the given key is uninstalled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INACCESSIBLE_WEIGHT

public static final int INACCESSIBLE_WEIGHT

See Also:

Constant Field Values

Constructor Detail

ProjectTypeManagerImpl

public ProjectTypeManagerImpl(JiraApplicationAdapter adapter)

Method Detail

getAllProjectTypes

public List<ProjectType> getAllProjectTypes()

Description copied from interface: ProjectTypeManager

Returns all the project types defined on the JIRA instance sorted by weight not taking into account whether the license to use those project types is valid or not.

Specified by:

getAllProjectTypes in interface ProjectTypeManager

Returns:

all the project types defined on the JIRA instance sorted by weight.

getAllAccessibleProjectTypes

public List<ProjectType> getAllAccessibleProjectTypes()

Description copied from interface: ProjectTypeManager

Returns all the accessible project types defined on the JIRA instance sorted by weight. A project type is considered accessible if the application that defines it is present on the JIRA instance and if there is a license for that application on the instance. This method should be used when displaying available project types to admins (e.g. project create dialog, change project type dialog)

Specified by:

getAllAccessibleProjectTypes in interface ProjectTypeManager

Returns:

all the accessible project types defined on the JIRA instance sorted by weight.

getByKey

public io.atlassian.fugue.Option<ProjectType> getByKey(ProjectTypeKey key)

Description copied from interface: ProjectTypeManager

Returns the project type with the given key, if it is present on the JIRA instance.

Specified by:

getByKey in interface ProjectTypeManager

Parameters:

key - The project type key

Returns:

The project type for the given key

getApplicationWithType

public io.atlassian.fugue.Option<com.atlassian.application.api.Application> getApplicationWithType(ProjectTypeKey key)

Description copied from interface: ProjectTypeManager

Returns the application that provides the given project type.

Specified by:

getApplicationWithType in interface ProjectTypeManager

Parameters:

key - The project type key

Returns:

The application associated to that project.

getAccessibleProjectType

public io.atlassian.fugue.Option<ProjectType> getAccessibleProjectType(ProjectTypeKey key)

Description copied from interface: ProjectTypeManager

Returns the project type with the given key, if it is accessible. A project type is considered accessible if the application that defines it is present on the JIRA instance and if there is a license for that application in the instance. Generally this method should be used when retrieving a project type for display in the application. The convention is to always display the project type if the application is licensed, even if the current user isn't licensed to access that application. Not showing the project type due to the user's individual license access should be the exception.

Specified by:

getAccessibleProjectType in interface ProjectTypeManager

Parameters:

key - The project type key

Returns:

The project type for the given key

getAccessibleProjectType

public io.atlassian.fugue.Option<ProjectType> getAccessibleProjectType(ApplicationUser user,
                                                                       ProjectTypeKey key)

Description copied from interface: ProjectTypeManager

Returns the project type with the given key, if it is accessible for the given user. A project type is considered accessible for an user if the application that defines it is present on the JIRA instance, that application has a license and the given user is licensed for that application.

Specified by:

getAccessibleProjectType in interface ProjectTypeManager

Parameters:

user - The user

key - The project type key

Returns:

The project type of the given key

getInaccessibleProjectType

public ProjectType getInaccessibleProjectType()

Description copied from interface: ProjectTypeManager

Returns a project type with information to be displayed to users when a specific project type is not accessible.

A project type might be inaccessible if the user is not licensed under the application that defines the type or if the application that defines the type is not installed on the JIRA instance.

Specified by:

getInaccessibleProjectType in interface ProjectTypeManager

Returns:

A project type encapsulating information for when a specific type is not accessible;

isProjectTypeUninstalled

public boolean isProjectTypeUninstalled(ProjectTypeKey projectTypeKey)

Description copied from interface: ProjectTypeManager

Returns whether the project type with the given key is uninstalled.

Specified by:

isProjectTypeUninstalled in interface ProjectTypeManager

Parameters:

projectTypeKey - The key of the project type for which we are performing the check.

Returns:

Whether the project type is uninstalled.

isProjectTypeInstalledButInaccessible

public boolean isProjectTypeInstalledButInaccessible(ProjectTypeKey projectTypeKey)

Description copied from interface: ProjectTypeManager

Returns whether the project type with the given key is installed but inaccessible.

Specified by:

isProjectTypeInstalledButInaccessible in interface ProjectTypeManager

Parameters:

projectTypeKey - The key of the project type for which we are performing the check.

Returns:

Whether the project type is uninstalled but inaccessible.