com.sendsafely.ContactGroup Maven / Gradle / Ivy

Go to download
package com.sendsafely;

import java.util.ArrayList;
import java.util.List;

import com.sendsafely.dto.ContactGroupMember;

/**
 * A java bean containing the information for a contact group.
 * A ContactGroup contains information about a contact group including the following,
 * contactGroupId, contactGroupName, ContactGroupUsers, and users.
 * Only the Getters should be used from this object, since the server will populate the object. 
 * Updating the setters will not change any state on the server and should be avoided.
 *
 */
public class ContactGroup {
	private String contactGroupId;
	private String contactGroupName;
	private boolean contactGroupIsOrganizationGroup;
	private List users = new ArrayList(0);
	
	/**
	 * @description Get the contact group id
	 * @returnType String
	 * @return contactGroupId The id representation of the contact group.
	 */
	public String getContactGroupId() {
		return contactGroupId;
	}
	
	/**
	 * @description Set internally by the API
	 * @param contactGroupId
	 */
	public void setContactGroupId(String contactGroupId) {
		this.contactGroupId = contactGroupId;
	}
	
	/**
	 * @description Get the contact group Name
	 * @returnType String
	 * @return A string of contactGroupName
	 */
	public String getContactGroupName() {
		return contactGroupName;
	}
	
	/**
	 * @description Set internally by the API
	 * @param contactGroupName
	 */
	public void setContactGroupName(String contactGroupName) {
		this.contactGroupName = contactGroupName;
	}
	
	/**
	 * @description Get a list of users
	 * @returnType List
	 * @return A list of ContactGrouMember.
	 */
	public List getContactGroupMembers() {
		return users;
	}
	
	/**
	 * @description Set internally by the API
	 * @param users
	 */
	public void setContactGroupMembers(List users) {
		this.users = users;
	}

	/**
	 * @description Gets the status of if it's an enterprise contact group.
	 * @returnType boolean
	 * @return is enterprise contact group
	 */
	public boolean getContactGroupIsOrganizationGroup() {
		return contactGroupIsOrganizationGroup;
	}

	/**
	 * Sets the value for if the group is an enterprise contact group.
	 * @param contactGroupIsOrganizationGroup
	 */
	public void setContactGroupIsOrganizationGroup(boolean contactGroupIsOrganizationGroup) {
		this.contactGroupIsOrganizationGroup = contactGroupIsOrganizationGroup;
	}
	
	
}