org.nakedobjects.plugins.html.request.Request Maven / Gradle / Ivy

Go to download
package org.nakedobjects.plugins.html.request;

/**
 * The Request object represents all the information collected from the user when requesting the server do
 * something.
 */
public interface Request {
    public static final String EDIT_COMMAND = "edit";
    public static final String COLLECTION_COMMAND = "collection";
    public static final String FIELD_COLLECTION_COMMAND = "fieldCollection";
    public static final String OBJECT_COMMAND = "object";
    public static final String SERVICE_COMMAND = "serviceOption";
    public static final String TASK_COMMAND = "task";
    public static final String LOGON_COMMAND = "task";

    void forward(Request object);

    String getActionId();

    /**
     * Name of a property within an object.
     */
    String getProperty();

    /**
     * The element within a collection.
     */
    String getElementId();

    /**
     * The users entry into a field on the form.
     */
    String getFieldEntry(int i);

    Request getForward();

    String getObjectId();

    /**
     * Name of the request. See the constants defined in this class.
     */
    String getRequestType();

    String getTaskId();

    /**
     * Name of the button pressed on the form.
     */
    String getButtonName();

    String getName();

}

// Copyright (c) Naked Objects Group Ltd.