com.versionone.om

Class Member

java.lang.Object

com.versionone.om.Entity

com.versionone.om.BaseAsset

com.versionone.om.Member

public class Member
extends BaseAsset

Represents a user or member in the VersionOne system.

Field Summary

Fields inherited from class com.versionone.om.BaseAsset

STATE_ACTIVE, STATE_CLOSED

Fields inherited from class com.versionone.om.Entity

ASSET_STATE_VALUE, ASSET_VALUE, CHANGE_DATE_UTC, CONTENT_TYPE_VALUE, CONTENT_VALUE, CREATE_DATE_UTC, DELETE_OPERATION, DESCRIPTION_VALUE, FILENAME_VALUE, NAME_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
Conversation	createConversation(Member author, String content) Creates conversation which mentioned this member.
Conversation	createConversation(Member author, String content, Map<String,Object> attributes) Creates conversation which mentioned this asset.
Conversation	createConversation(String content) Creates conversation with this member as author.
Collection<Project>	getAssignedProjects() Gets Projects this member is assigned to.
Role	getDefaultRole()
Collection<Effort>	getEffortRecords(EffortFilter filter) A collection of Effort Records that belong to this member.
String	getEmail()
Collection<Expression>	getExpressions()
boolean	getNotifyViaEmail() A flag indicating whether this member desires to receive e-mail notifications.
Collection<Epic>	getOwnedEpics(EpicFilter filter) Epics owned by this member.
Collection<Issue>	getOwnedIssues(IssueFilter filter) A read-only collection of Issues owned by this member.
Collection<PrimaryWorkitem>	getOwnedPrimaryWorkitems(PrimaryWorkitemFilter filter) Gets Stories and Defects owned by this member.
Collection<Request>	getOwnedRequests(RequestFilter filter) A read-only collection of Requests owned by this member.
Collection<SecondaryWorkitem>	getOwnedSecondaryWorkitems(SecondaryWorkitemFilter filter) Tasks and Tests owned by this member.
Collection<Theme>	getOwnedThemes(ThemeFilter filter) A collection of Themes owned by this member.
String	getPhone()
boolean	getSendConversationEmails() Get conversation email notifications status.
String	getShortName()
Double	getTotalDetailEstimate(WorkitemFilter filter) Return the total detail estimate for all workitems owned by this member optionally filtered.
Double	getTotalDone(WorkitemFilter filter) Return the total done for all workitems owned by this member optionally filtered.
Double	getTotalEstimate(PrimaryWorkitemFilter filter) Return the total estimate for all stories and defects owned by this member optionally filtered.
Double	getTotalToDo(WorkitemFilter filter) Return the total to do for all workitems owned by this member optionally filtered.
String	getUsername()
void	setDefaultRole(Role defaultRole)
void	setEmail(String value)
void	setNotifyViaEmail(boolean value)
void	setPassword(String value)
void	setPhone(String value)
void	setSendConversationEmails(boolean status) Turn conversation notifications by email on or off.
void	setShortName(String shortName)
void	setUsername(String value)

Methods inherited from class com.versionone.om.BaseAsset

canClose, canDelete, canReactivate, close, createAttachment, createAttachment, createLink, createLink, createNote, createNote, delete, getAttachments, getCustomDropdown, getCustomField, getDescription, getLinks, getMentionedInExpressions, getName, getNotes, getURL, isActive, isClosed, reactivate, setDescription, setName

Methods inherited from class com.versionone.om.Entity

equals, get, getChangeComment, getChangeDate, getChangedBy, getCreateComment, getCreateDate, getCreatedBy, getID, getInstance, hashCode, save, save, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getShortName

public String getShortName()

Returns:

The short or abbreviated name of the user or member. This name is often used in the owner's dropdown.

setShortName

public void setShortName(String shortName)

Parameters:

shortName - The short or abbreviated name of the user or member. This name is often used in the owner's dropdown.

getDefaultRole

public Role getDefaultRole()

Returns:

The default role of the user or member. Determines the member's permissions when assigned to a project. Also determines the member's global privileges.

setDefaultRole

public void setDefaultRole(Role defaultRole)

Parameters:

defaultRole - The default role of the user or member. Determines the member's permissions when assigned to a project. Also determines the member's global privileges.

getUsername

public String getUsername()

Returns:

The username this user or member uses to login to the VersionOne system.

setUsername

public void setUsername(String value)

Parameters:

value - The username this user or member uses to login to the VersionOne system.

setPassword

public void setPassword(String value)

Parameters:

value - The password this user or member uses to login to the VersionOne system. This is a write-only property.

getEmail

public String getEmail()

Returns:

The Email for this member.

setEmail

public void setEmail(String value)

Parameters:

value - The Email for this member.

getPhone

public String getPhone()

Returns:

The phone number for this member.

setPhone

public void setPhone(String value)

Parameters:

value - The phone number for this member.

getAssignedProjects

public Collection<Project> getAssignedProjects()

Gets Projects this member is assigned to.

Returns:

assigned Projects.

getExpressions

public Collection<Expression> getExpressions()

Returns:

Expression messages created by the member.

getOwnedPrimaryWorkitems

public Collection<PrimaryWorkitem> getOwnedPrimaryWorkitems(PrimaryWorkitemFilter filter)

Gets Stories and Defects owned by this member.

Parameters:

filter - Criteria to filter stories and defects on. Pass a DefectFilter or StoryFilter to get only Defects or Stories, respectively.

Returns:

selected Workitems.

getOwnedSecondaryWorkitems

public Collection<SecondaryWorkitem> getOwnedSecondaryWorkitems(SecondaryWorkitemFilter filter)

Tasks and Tests owned by this member.

Parameters:

filter - Filter for Tasks and Tests.

Returns:

Collection of bases of a Tasks or Tests in the VersionOne System.

getOwnedThemes

public Collection<Theme> getOwnedThemes(ThemeFilter filter)

A collection of Themes owned by this member.

Parameters:

filter - Limit the themes returned (If null, then all items returned).

Returns:

A collection themes that belong to this member filtered by the passed in filter.

getOwnedIssues

public Collection<Issue> getOwnedIssues(IssueFilter filter)

A read-only collection of Issues owned by this member.

Parameters:

filter - Limit the issues returned (If null, then all items returned).

Returns:

A collection issues that belong to this member filtered by the passed in filter.

getOwnedRequests

public Collection<Request> getOwnedRequests(RequestFilter filter)

A read-only collection of Requests owned by this member.

Parameters:

filter - Limit the requests returned (If null, then all items returned).

Returns:

A collection requests that belong to this member filtered by the passed in filter.

getOwnedEpics

public Collection<Epic> getOwnedEpics(EpicFilter filter)

Epics owned by this member.

Parameters:

filter - Limit the epics returned (If null, then all items returned).

Returns:

A collection epics that belong to this member filtered by the passed in filter.

getEffortRecords

public Collection<Effort> getEffortRecords(EffortFilter filter)

A collection of Effort Records that belong to this member.

Parameters:

filter - Limit the efforts returned (If null, then all items returned).

Returns:

A collection efforts that belong to this member filtered by the passed in filter.

getTotalEstimate

public Double getTotalEstimate(PrimaryWorkitemFilter filter)

Return the total estimate for all stories and defects owned by this member optionally filtered.

Parameters:

filter - Criteria to filter stories and defects on. Pass a DefectFilter or StoryFilter to get only Defects or Stories, respectively.

Returns:

total estimate of selected Workitems.

getTotalDetailEstimate

public Double getTotalDetailEstimate(WorkitemFilter filter)

Return the total detail estimate for all workitems owned by this member optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

Returns:

total detail estimate of selected Workitems.

getTotalToDo

public Double getTotalToDo(WorkitemFilter filter)

Return the total to do for all workitems owned by this member optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

Returns:

total to do of selected Workitems.

getTotalDone

public Double getTotalDone(WorkitemFilter filter)

Return the total done for all workitems owned by this member optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

Returns:

total done of selected Workitems.

createConversation

public Conversation createConversation(Member author,
                              String content)

Creates conversation which mentioned this member.

Overrides:

createConversation in class BaseAsset

Parameters:

author - Author of expression in conversation.

content - Content of expression in conversation.

Returns:

Created conversation.

createConversation

public Conversation createConversation(Member author,
                              String content,
                              Map<String,Object> attributes)

Creates conversation which mentioned this asset.

Overrides:

createConversation in class BaseAsset

Parameters:

author - Author of conversation.

content - Content of conversation.

attributes - additional attributes for the Conversation.

Returns:

Created conversation

createConversation

public Conversation createConversation(String content)

Creates conversation with this member as author.

Parameters:

content - Content of conversation.

Returns:

Created conversation.

getNotifyViaEmail

public boolean getNotifyViaEmail()

A flag indicating whether this member desires to receive e-mail notifications.

setNotifyViaEmail

public void setNotifyViaEmail(boolean value)

getSendConversationEmails

public boolean getSendConversationEmails()

Get conversation email notifications status.

setSendConversationEmails

public void setSendConversationEmails(boolean status)

Turn conversation notifications by email on or off.