org.kuali.student.r2.common.infc.BulkStatus Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 The Kuali Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 *
 *  http://www.osedu.org/licenses/ECL-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.kuali.student.r2.common.infc;

/**
 * Status object returned by bulk operations to indicate the status of each item
 * within the bulk operation.
 */

public interface BulkStatus {

    /**
     * Optional id of the created object
     *
     * @name id
     * @readOnly
     */
    public String getId();    
    
    /**
     * Indicates the success or failure of the operation.
     *
     * @name Success Indicator
     * @readOnly
     * @required
     */
    public Boolean getIsSuccess();

    /**
     * Optional message indicating a reason.
     *
     * @name Message
     * @readOnly
     */
    public String getMessage();
}