com.softlayer.api.service.user.customer.security.Answer 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.customer.security;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.user.Customer;
import com.softlayer.api.service.user.security.Question;
import java.util.concurrent.Future;

/**
 * The SoftLayer_User_Customer_Security_Answer type contains user's answers to security questions.
 *
 * @see SoftLayer_User_Customer_Security_Answer
 */
@ApiType("SoftLayer_User_Customer_Security_Answer")
public class Answer extends Entity {

    /**
     * The question the security answer is associated with.
     */
    @ApiProperty
    protected Question question;

    public Question getQuestion() {
        return question;
    }

    public void setQuestion(Question question) {
        this.question = question;
    }

    /**
     * The user who the security answer belongs to.
     */
    @ApiProperty
    protected Customer user;

    public Customer getUser() {
        return user;
    }

    public void setUser(Customer user) {
        this.user = user;
    }

    /**
     * A user's answer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String answer;

    public String getAnswer() {
        return answer;
    }

    public void setAnswer(String answer) {
        answerSpecified = true;
        this.answer = answer;
    }

    protected boolean answerSpecified;

    public boolean isAnswerSpecified() {
        return answerSpecified;
    }

    public void unsetAnswer() {
        answer = null;
        answerSpecified = false;
    }

    /**
     * A user's answer identifying number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * A user's question identifying number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long questionId;

    public Long getQuestionId() {
        return questionId;
    }

    public void setQuestionId(Long questionId) {
        questionIdSpecified = true;
        this.questionId = questionId;
    }

    protected boolean questionIdSpecified;

    public boolean isQuestionIdSpecified() {
        return questionIdSpecified;
    }

    public void unsetQuestionId() {
        questionId = null;
        questionIdSpecified = false;
    }

    /**
     * A user's identifying number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userId;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        userIdSpecified = true;
        this.userId = userId;
    }

    protected boolean userIdSpecified;

    public boolean isUserIdSpecified() {
        return userIdSpecified;
    }

    public void unsetUserId() {
        userId = null;
        userIdSpecified = false;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * An account's user have security answers for secondary security measures. These questions/answers can be found during login and password update. These questions/answers are also needed for password reset. 
     *
     * @see SoftLayer_User_Customer_Security_Answer
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_User_Customer_Security_Answer")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * getObject retrieves the SoftLayer_User_Customer_Security_Answer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Security_Answer service. 
         *
         * @see SoftLayer_User_Customer_Security_Answer::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Answer getObject();

        /**
         * The question the security answer is associated with.
         *
         * @see SoftLayer_User_Customer_Security_Answer::getQuestion
         */
        @ApiMethod(instanceRequired = true)
        public Question getQuestion();

        /**
         * The user who the security answer belongs to.
         *
         * @see SoftLayer_User_Customer_Security_Answer::getUser
         */
        @ApiMethod(instanceRequired = true)
        public Customer getUser();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getQuestion}
         */
        public Future getQuestion();

        /**
         * Async callback version of {@link Service#getQuestion}
         */
        public Future getQuestion(ResponseHandler callback);

        /**
         * Async version of {@link Service#getUser}
         */
        public Future getUser();

        /**
         * Async callback version of {@link Service#getUser}
         */
        public Future getUser(ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.user.security.Question.Mask question() {
            return withSubMask("question", com.softlayer.api.service.user.security.Question.Mask.class);
        }

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

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

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

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

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

    }

}