com.atlassian.jira.onboarding.basic

Class DefaultJiraFirstUseFlow

java.lang.Object

com.atlassian.jira.onboarding.basic.DefaultJiraFirstUseFlow

All Implemented Interfaces:

FirstUseFlow

public class DefaultJiraFirstUseFlow
extends Object
implements FirstUseFlow

Constructor Summary

Constructors

Constructor and Description
DefaultJiraFirstUseFlow()

Method Summary

Methods

Modifier and Type	Method and Description
String	getUrl() The location (of the web action) at which the first-use flow begins.
boolean	isApplicable(ApplicationUser user) A hook point to allow a flow to check whether it would be appropriate to put the user through it.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJiraFirstUseFlow

public DefaultJiraFirstUseFlow()

Method Detail

isApplicable

public boolean isApplicable(ApplicationUser user)

Description copied from interface: FirstUseFlow

A hook point to allow a flow to check whether it would be appropriate to put the user through it. For example, if you have a flow that only people with permission to create projects should go through, you could do that permission check here.

Specified by:

isApplicable in interface FirstUseFlow

Returns:

true if the first use flow should be activated for this user.

getUrl

@Nonnull
public String getUrl()

Description copied from interface: FirstUseFlow

The location (of the web action) at which the first-use flow begins. Any user that is eligible to be run through the flow will be directed to this URL upon logging in.

Specified by:

getUrl in interface FirstUseFlow

Returns:

the URL of the flow's starting action.