org.lastaflute.job.subsidiary.JobIdentityAttr Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lasta-job Show documentation

Job Scheduling for LastaFlute

There is a newer version: 2.0.0

/*
 * Copyright 2015-2017 the original author or authors.
 *
 * 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.
 */
package org.lastaflute.job.subsidiary;

import org.dbflute.optional.OptionalThing;
import org.lastaflute.job.key.LaJobKey;
import org.lastaflute.job.key.LaJobNote;
import org.lastaflute.job.key.LaJobUnique;

/**
 * @author jflute
 * @since 0.2.7 (2017/02/22 Wednesday)
 */
public interface JobIdentityAttr { // for internal assist

    /**
     * @return The job key auto-generated by framework when schedule registration. (NotNull)
     */
    LaJobKey getJobKey();

    /**
     * @return The optional note (title, description) of the job. (NotNull, EmptyAllowed: if both is no value)
     */
    OptionalThing getJobNote();

    /**
     * @return The optional job unique code provided by application when schedule registration. (NotNull, EmptyAllowed)
     */
    OptionalThing getJobUnique();
}