com.softlayer.api.service.user.Employee Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.user;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.layout.Profile;
import com.softlayer.api.service.metric.tracking.Object;
import com.softlayer.api.service.ticket.Activity;
import com.softlayer.api.service.ticket.Attachment;
import com.softlayer.api.service.ticket.Chat;
import com.softlayer.api.service.user.Interface;
import com.softlayer.api.service.user.employee.Department;
import com.softlayer.api.service.user.permission.Action;
import com.softlayer.api.service.user.permission.Role;
import java.util.ArrayList;
import java.util.List;

/**
 * A SoftLayer_User_Employee models a single SoftLayer employee for the purposes of ticket updates created by SoftLayer employees. SoftLayer portal and API users cannot see individual employee names in ticket responses.  SoftLayer employees can be assigned to customer accounts as a personal support representative.  Employee names and email will be available if an employee is assigned to the account. 
 *
 * @see SoftLayer_User_Employee
 */
@ApiType("SoftLayer_User_Employee")
public class Employee extends Interface {

    @ApiProperty
    protected List actions;

    public List getActions() {
        if (actions == null) {
            actions = new ArrayList();
        }
        return actions;
    }

    @ApiProperty
    protected List chatTranscript;

    public List getChatTranscript() {
        if (chatTranscript == null) {
            chatTranscript = new ArrayList();
        }
        return chatTranscript;
    }

    /**
     * The department that a SoftLayer employee belongs to.
     */
    @ApiProperty
    protected Department employeeDepartment;

    public Department getEmployeeDepartment() {
        return employeeDepartment;
    }

    public void setEmployeeDepartment(Department employeeDepartment) {
        this.employeeDepartment = employeeDepartment;
    }

    @ApiProperty
    protected List layoutProfiles;

    public List getLayoutProfiles() {
        if (layoutProfiles == null) {
            layoutProfiles = new ArrayList();
        }
        return layoutProfiles;
    }

    @ApiProperty
    protected Object metricTrackingObject;

    public Object getMetricTrackingObject() {
        return metricTrackingObject;
    }

    public void setMetricTrackingObject(Object metricTrackingObject) {
        this.metricTrackingObject = metricTrackingObject;
    }

    @ApiProperty
    protected List roles;

    public List getRoles() {
        if (roles == null) {
            roles = new ArrayList();
        }
        return roles;
    }

    @ApiProperty
    protected List ticketActivities;

    public List getTicketActivities() {
        if (ticketActivities == null) {
            ticketActivities = new ArrayList();
        }
        return ticketActivities;
    }

    @ApiProperty
    protected List ticketAttachmentReferences;

    public List getTicketAttachmentReferences() {
        if (ticketAttachmentReferences == null) {
            ticketAttachmentReferences = new ArrayList();
        }
        return ticketAttachmentReferences;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected String displayName;

    public String getDisplayName() {
        return displayName;
    }

    public void setDisplayName(String displayName) {
        displayNameSpecified = true;
        this.displayName = displayName;
    }

    protected boolean displayNameSpecified;

    public boolean isDisplayNameSpecified() {
        return displayNameSpecified;
    }

    public void unsetDisplayName() {
        displayName = null;
        displayNameSpecified = false;
    }

    /**
     * A SoftLayer employee's email address. Email addresses are only visible to [[SoftLayer_Account|SoftLayer Accounts]] that are assigned to an employee 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String email;

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        emailSpecified = true;
        this.email = email;
    }

    protected boolean emailSpecified;

    public boolean isEmailSpecified() {
        return emailSpecified;
    }

    public void unsetEmail() {
        email = null;
        emailSpecified = false;
    }

    /**
     * A SoftLayer employee's [[SoftLayer_User_Employee_Department|department]] id. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long employeeDepartmentId;

    public Long getEmployeeDepartmentId() {
        return employeeDepartmentId;
    }

    public void setEmployeeDepartmentId(Long employeeDepartmentId) {
        employeeDepartmentIdSpecified = true;
        this.employeeDepartmentId = employeeDepartmentId;
    }

    protected boolean employeeDepartmentIdSpecified;

    public boolean isEmployeeDepartmentIdSpecified() {
        return employeeDepartmentIdSpecified;
    }

    public void unsetEmployeeDepartmentId() {
        employeeDepartmentId = null;
        employeeDepartmentIdSpecified = false;
    }

    /**
     * A SoftLayer employee's first name. First names are only visible to [[SoftLayer_Account|SoftLayer Accounts]] that are assigned to an employee 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String firstName;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        firstNameSpecified = true;
        this.firstName = firstName;
    }

    protected boolean firstNameSpecified;

    public boolean isFirstNameSpecified() {
        return firstNameSpecified;
    }

    public void unsetFirstName() {
        firstName = null;
        firstNameSpecified = false;
    }

    /**
     * A SoftLayer employee's last name. Last names are only visible to [[SoftLayer_Account|SoftLayer Accounts]] that are assigned to an employee 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String lastName;

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        lastNameSpecified = true;
        this.lastName = lastName;
    }

    protected boolean lastNameSpecified;

    public boolean isLastNameSpecified() {
        return lastNameSpecified;
    }

    public void unsetLastName() {
        lastName = null;
        lastNameSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected String officePhone;

    public String getOfficePhone() {
        return officePhone;
    }

    public void setOfficePhone(String officePhone) {
        officePhoneSpecified = true;
        this.officePhone = officePhone;
    }

    protected boolean officePhoneSpecified;

    public boolean isOfficePhoneSpecified() {
        return officePhoneSpecified;
    }

    public void unsetOfficePhone() {
        officePhone = null;
        officePhoneSpecified = false;
    }

    /**
     * A representation of a SoftLayer employee's username. In all cases this should simply state "Employee".
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        usernameSpecified = true;
        this.username = username;
    }

    protected boolean usernameSpecified;

    public boolean isUsernameSpecified() {
        return usernameSpecified;
    }

    public void unsetUsername() {
        username = null;
        usernameSpecified = false;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long actionCount;

    public Long getActionCount() {
        return actionCount;
    }

    public void setActionCount(Long actionCount) {
        this.actionCount = actionCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long chatTranscriptCount;

    public Long getChatTranscriptCount() {
        return chatTranscriptCount;
    }

    public void setChatTranscriptCount(Long chatTranscriptCount) {
        this.chatTranscriptCount = chatTranscriptCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long layoutProfileCount;

    public Long getLayoutProfileCount() {
        return layoutProfileCount;
    }

    public void setLayoutProfileCount(Long layoutProfileCount) {
        this.layoutProfileCount = layoutProfileCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long roleCount;

    public Long getRoleCount() {
        return roleCount;
    }

    public void setRoleCount(Long roleCount) {
        this.roleCount = roleCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long ticketActivityCount;

    public Long getTicketActivityCount() {
        return ticketActivityCount;
    }

    public void setTicketActivityCount(Long ticketActivityCount) {
        this.ticketActivityCount = ticketActivityCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long ticketAttachmentReferenceCount;

    public Long getTicketAttachmentReferenceCount() {
        return ticketAttachmentReferenceCount;
    }

    public void setTicketAttachmentReferenceCount(Long ticketAttachmentReferenceCount) {
        this.ticketAttachmentReferenceCount = ticketAttachmentReferenceCount;
    }

    public static class Mask extends Interface.Mask {

        public com.softlayer.api.service.user.permission.Action.Mask actions() {
            return withSubMask("actions", com.softlayer.api.service.user.permission.Action.Mask.class);
        }

        public com.softlayer.api.service.ticket.Chat.Mask chatTranscript() {
            return withSubMask("chatTranscript", com.softlayer.api.service.ticket.Chat.Mask.class);
        }

        public com.softlayer.api.service.user.employee.Department.Mask employeeDepartment() {
            return withSubMask("employeeDepartment", com.softlayer.api.service.user.employee.Department.Mask.class);
        }

        public com.softlayer.api.service.layout.Profile.Mask layoutProfiles() {
            return withSubMask("layoutProfiles", com.softlayer.api.service.layout.Profile.Mask.class);
        }

        public com.softlayer.api.service.metric.tracking.Object.Mask metricTrackingObject() {
            return withSubMask("metricTrackingObject", com.softlayer.api.service.metric.tracking.Object.Mask.class);
        }

        public com.softlayer.api.service.user.permission.Role.Mask roles() {
            return withSubMask("roles", com.softlayer.api.service.user.permission.Role.Mask.class);
        }

        public com.softlayer.api.service.ticket.Activity.Mask ticketActivities() {
            return withSubMask("ticketActivities", com.softlayer.api.service.ticket.Activity.Mask.class);
        }

        public com.softlayer.api.service.ticket.Attachment.Mask ticketAttachmentReferences() {
            return withSubMask("ticketAttachmentReferences", com.softlayer.api.service.ticket.Attachment.Mask.class);
        }

        public Mask displayName() {
            withLocalProperty("displayName");
            return this;
        }

        public Mask email() {
            withLocalProperty("email");
            return this;
        }

        public Mask employeeDepartmentId() {
            withLocalProperty("employeeDepartmentId");
            return this;
        }

        public Mask firstName() {
            withLocalProperty("firstName");
            return this;
        }

        public Mask lastName() {
            withLocalProperty("lastName");
            return this;
        }

        public Mask officePhone() {
            withLocalProperty("officePhone");
            return this;
        }

        public Mask username() {
            withLocalProperty("username");
            return this;
        }

        public Mask actionCount() {
            withLocalProperty("actionCount");
            return this;
        }

        public Mask chatTranscriptCount() {
            withLocalProperty("chatTranscriptCount");
            return this;
        }

        public Mask layoutProfileCount() {
            withLocalProperty("layoutProfileCount");
            return this;
        }

        public Mask roleCount() {
            withLocalProperty("roleCount");
            return this;
        }

        public Mask ticketActivityCount() {
            withLocalProperty("ticketActivityCount");
            return this;
        }

        public Mask ticketAttachmentReferenceCount() {
            withLocalProperty("ticketAttachmentReferenceCount");
            return this;
        }

    }

}