public abstract class RelocationUI extends Object implements hudson.ExtensionPoint, org.jenkins.ui.icon.IconSpec
Item
instances.Constructor and Description |
---|
RelocationUI() |
Modifier and Type | Method and Description |
---|---|
static RelocationUI |
for_(hudson.model.Item item)
Retrieves the
RelocationUI to use for the specified item. |
String |
getDisplayName()
The
Action.getDisplayName() to present for this UI. |
String |
getIconClassName() |
String |
getIconFileName()
The
Action.getIconFileName() to present for this UI. |
String |
getUrlName()
The
Action.getUrlName() to present for this UI. |
abstract boolean |
isApplicableTo(Class<? extends hudson.model.Item> itemClass)
Checks if this
RelocationUI is applicable to the specified type of item. |
abstract boolean |
isAvailable(hudson.model.Item item)
Checks if the relocation operation is currently available for the specific item
(as
Jenkins.getAuthentication() if the user is a factor). |
@Nonnull public String getDisplayName()
Action.getDisplayName()
to present for this UI.Action.getDisplayName()
to present for this UI, never null
Action.getDisplayName()
@Nonnull public String getUrlName()
Action.getUrlName()
to present for this UI.Action.getUrlName()
to present for this UI, never null
Action.getUrlName()
@Nonnull public String getIconFileName()
Action.getIconFileName()
to present for this UI.Action.getIconFileName()
to present for this UI, never null
Action.getIconFileName()
public String getIconClassName()
getIconClassName
in interface org.jenkins.ui.icon.IconSpec
public abstract boolean isAvailable(hudson.model.Item item)
Jenkins.getAuthentication()
if the user is a factor). You can assume that the current user
has RelocationAction.RELOCATE
permission.item
- the item being checked.true
if the UI is available for the current user on the specified item.public abstract boolean isApplicableTo(Class<? extends hudson.model.Item> itemClass)
RelocationUI
is applicable to the specified type of item.itemClass
- the type of item.true
if this UI is applicable to the specified type of item.ExtensionList
,
Extension.ordinal()
@CheckForNull public static RelocationUI for_(@Nonnull hudson.model.Item item)
RelocationUI
to use for the specified item.item
- the item.RelocationUI
to use or null
Copyright © 2016–2017. All rights reserved.