com.synopsys.arc.jenkins.plugins.ownership

Interface IOwnershipHelper<TObjectType>

Type Parameters:

TObjectType - Type of object, for which ownership should be resolved

All Known Implementing Classes:

AbstractOwnershipHelper, JobOwnerHelper, NodeOwnerHelper, NodeOwnerPropertyHelper

public interface IOwnershipHelper<TObjectType>

Adapter for typical ownership operations with different item types. Every IOwnership item should provide ownership helper.

Since:

0.0.2

Author:

Oleg Nenashev

See Also:

IOwnershipItem

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName(hudson.model.User usr) Gets User's name for visualization
String	getOwner(TObjectType item) Get ownerId of the item
String	getOwnerEmail(TObjectType item) Get e-mail of the owner
String	getOwnerLongString(TObjectType item) Get Display string of the owner (and coowners)
OwnershipDescription	getOwnershipDescription(TObjectType item) Gets ownership description of the requested item
Collection<hudson.model.User>	getPossibleOwners(TObjectType item) Get list of users, who can be item's owner
boolean	isOwnerExists(TObjectType item) Check if item has owners

Method Detail

getOwner

String getOwner(TObjectType item)

Get ownerId of the item

Parameters:

item - Item to be describes

Returns:

userId

getOwnerEmail

String getOwnerEmail(TObjectType item)

Get e-mail of the owner

Parameters:

item - Item to be describes

Returns:

Owner's e-mail

Since:

0.0.4

isOwnerExists

boolean isOwnerExists(TObjectType item)

Check if item has owners

Parameters:

item - Item to be checked

Returns:

true if item has owners

getOwnerLongString

String getOwnerLongString(TObjectType item)

Get Display string of the owner (and coowners)

Parameters:

item - Item to be described

Returns:

User description string

getOwnershipDescription

OwnershipDescription getOwnershipDescription(TObjectType item)

Gets ownership description of the requested item

Parameters:

item - Item to be described

Returns:

Ownership description

Since:

0.0.3

getPossibleOwners

Collection<hudson.model.User> getPossibleOwners(TObjectType item)

Get list of users, who can be item's owner

Parameters:

item - Item to be described

Returns:

List of users, who can be item's owner

Since:

0.0.3

getDisplayName

String getDisplayName(hudson.model.User usr)

Gets User's name for visualization

Parameters:

usr - User

Returns:

String for display