com.synopsys.arc.jenkins.plugins.ownership

Class OwnershipDescription

java.lang.Object

com.synopsys.arc.jenkins.plugins.ownership.OwnershipDescription

public class OwnershipDescription
extends Object

Contains description of item's ownership.

Since:

0.0.3

Author:

Oleg Nenashev

Field Summary

Fields

Modifier and Type	Field and Description
static OwnershipDescription	DISABLED_DESCR Disabled description, which means that ownership is disabled

Constructor Summary

Constructors

Constructor and Description
OwnershipDescription(boolean ownershipEnabled, String primaryOwnerId) Deprecated. Use constructor with co-owners specification
OwnershipDescription(boolean ownershipEnabled, String primaryOwnerId, Collection<String> coownersIds) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getCoownersIds() Gets list of coowners.
hudson.model.User	getPrimaryOwner() Get primary owner.
String	getPrimaryOwnerId() Gets id of primary owner.
boolean	hasPrimaryOwner()
static boolean	isEnabled(OwnershipDescription descr) Check if ownership is enabled.
boolean	isOwner(hudson.model.User user, boolean acceptCoowners) Check if User is owner.
boolean	isOwnershipEnabled() Check if ownership is enabled.
boolean	isPrimaryOwner(hudson.model.User user)
static OwnershipDescription	Parse(net.sf.json.JSONObject formData, String blockName)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DISABLED_DESCR

public static final OwnershipDescription DISABLED_DESCR

Disabled description, which means that ownership is disabled

Constructor Detail

OwnershipDescription

public OwnershipDescription(boolean ownershipEnabled,
                    String primaryOwnerId)

Deprecated. Use constructor with co-owners specification

Constructor.

Parameters:

primaryOwnerId - userId of primary owner

OwnershipDescription

public OwnershipDescription(boolean ownershipEnabled,
                    String primaryOwnerId,
                    Collection<String> coownersIds)

Constructor. Class is being used as DataBound in "OwnerNodeProperty".

Parameters:

primaryOwnerId - userId of primary owner

coownersIds - userIds of secondary owners

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isOwnershipEnabled

public boolean isOwnershipEnabled()

Check if ownership is enabled.

Returns:

true if ownership is enabled

getPrimaryOwnerId

public String getPrimaryOwnerId()

Gets id of primary owner.

Returns:

userId of primary owner

getPrimaryOwner

public hudson.model.User getPrimaryOwner()

Get primary owner.

Returns:

Primary owner's user.

getCoownersIds

public Set<String> getCoownersIds()

Gets list of coowners.

Returns:

Collection of co-owners

Parse

public static OwnershipDescription Parse(net.sf.json.JSONObject formData,
                         String blockName)

isOwner

public boolean isOwner(hudson.model.User user,
              boolean acceptCoowners)

Check if User is owner.

Parameters:

user - User to be checked

acceptCoowners - Check if user belongs to coowners

Returns:

true if User belongs to primary owners (and/or coowners)

hasPrimaryOwner

public boolean hasPrimaryOwner()

isPrimaryOwner

public boolean isPrimaryOwner(hudson.model.User user)

isEnabled

public static boolean isEnabled(OwnershipDescription descr)

Check if ownership is enabled.

Parameters:

descr - Ownership description (can be null)

Since:

0.1