org.obiba.onyx.engine.ActionDefinition.java Source code

Introduction

Here is the source code for org.obiba.onyx.engine.ActionDefinition.java

Source

/*******************************************************************************
 * Copyright 2008(c) The OBiBa Consortium. All rights reserved.
 * 
 * This program and the accompanying materials
 * are made available under the terms of the GNU Public License v3.0.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package org.obiba.onyx.engine;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import org.springframework.context.MessageSourceResolvable;
import org.springframework.context.support.DefaultMessageSourceResolvable;

/**
 * An action definition, defines how getting information from the user to produce an {@link Action}.
 * 
 * @see ActionType
 */
/**
 * 
 */
public class ActionDefinition implements Serializable {

    private static final long serialVersionUID = 5052458659458743800L;

    private ActionType type;

    /** A unique code for this action definition */
    private String code;

    /**
     * Says if it requires operator authentication (using its password).
     */
    private boolean askPassword = false;

    /**
     * Says if it requires participant authentication (using its id).
     */
    private boolean askParticipantId = false;

    /**
     * Says if it requires that the operator be asked for a comment.
     * 
     * Note: This defaults to <code>true</code> for backward compatibility.
     */
    private boolean askComment = true;

    /**
     * Says if a comment is mandatory (ignored if askComment is <code>false</code>).
     */
    private boolean commentMandatory = true;

    /**
     * Note related to the comment. To be displayed to the user on the UI.
     */
    private String commentNote;

    /**
     * Says if a reason is mandatory.
     */
    private boolean reasonMandatory = false;

    /**
     * Specify the default reason.
     */
    private String defaultReason;

    /**
     * List of reasons to be picked-up.
     */
    private List<String> reasons;

    public ActionDefinition() {
        // no-arg constructor for XStream deserialization with PureJavaReflectionProvider
    }

    public ActionDefinition(ActionType type, String code) {
        this.type = type;
        this.code = code;
    }

    ActionDefinition(ActionDefinition rhs) {
        this.type = rhs.type;
        this.code = rhs.code;
        this.askPassword = rhs.askPassword;
        this.askParticipantId = rhs.askParticipantId;
        this.askComment = rhs.askComment;
        this.commentNote = rhs.commentNote;
        this.commentMandatory = rhs.commentMandatory;
        this.reasonMandatory = rhs.reasonMandatory;
        this.defaultReason = rhs.defaultReason;
        if (rhs.reasons != null) {
            this.reasons = new ArrayList<String>();
            this.reasons.addAll(rhs.reasons);
        }
    }

    public ActionType getType() {
        return type;
    }

    public void setType(ActionType type) {
        this.type = type;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public MessageSourceResolvable getLabel() {
        return new DefaultMessageSourceResolvable(ActionDefinitionConfiguration.calculateCodes(this, null),
                getType().toString());
    }

    public MessageSourceResolvable getDescription() {
        return new DefaultMessageSourceResolvable(
                ActionDefinitionConfiguration.calculateCodes(this, ".description"), getType().toString());
    }

    public boolean isAskPassword() {
        return askPassword;
    }

    public void setAskPassword(boolean askPassword) {
        this.askPassword = askPassword;
    }

    public boolean isAskParticipantId() {
        return askParticipantId;
    }

    public void setAskParticipantId(boolean askParticipantId) {
        this.askParticipantId = askParticipantId;
    }

    public boolean isAskComment() {
        return askComment;
    }

    public void setAskComment(boolean askComment) {
        this.askComment = askComment;
    }

    /**
     * Indicates whether the <code>ActionDefinition</code> asks anything.
     * 
     * @return <code>true</code> if something asked
     */
    public boolean somethingAsked() {
        return isAskPassword() || isAskParticipantId() || isAskComment();
    }

    public boolean isCommentMandatory() {
        return commentMandatory;
    }

    public void setCommentMandatory(boolean commentMandatory) {
        this.commentMandatory = commentMandatory;
    }

    public boolean isReasonMandatory() {
        return reasonMandatory;
    }

    public void setReasonMandatory(boolean reasonMandatory) {
        this.reasonMandatory = reasonMandatory;
    }

    public String getDefaultReason() {
        return defaultReason;
    }

    public void setDefaultReason(String defaultReason) {
        this.defaultReason = defaultReason;
    }

    public List<String> getReasons() {
        return reasons != null ? reasons : (reasons = new ArrayList<String>());
    }

    @Override
    public String toString() {
        return code.toString();
    }

    public String getCommentNote() {
        return commentNote;
    }

    public void setCommentNote(String commentNote) {
        this.commentNote = commentNote;
    }

}