PurgeWorkStatus.java

/*
 * (C) Copyright 2016 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-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.
 *
 * Contributors:
 *     Antoine Taillefer <ataillefer@nuxeo.com>
 */
package org.nuxeo.ecm.admin.permissions;

import java.io.Serializable;

/**
 * Status of a {@link PermissionsPurgeWork}.
 *
 * @since 8.3
 */
public final class PurgeWorkStatus implements Serializable {

    private static final long serialVersionUID = -8926752003865032483L;

    private final State state;

    public enum State {
        SCHEDULED, RUNNING, COMPLETED
    }

    public PurgeWorkStatus(State state) {
        this.state = state;
    }

    public boolean isScheduled() {
        return state == State.SCHEDULED;
    }

    public boolean isRunning() {
        return state == State.RUNNING;
    }

    public boolean isComplete() {
        return state == State.COMPLETED;
    }

}