step.core.artefacts.Artefact Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of step-core Show documentation
The newest version!
/*******************************************************************************
 * Copyright (C) 2020, exense GmbH
 *  
 * This file is part of STEP
 *  
 * STEP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * STEP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *  
 * You should have received a copy of the GNU Affero General Public License
 * along with STEP.  If not, see .
 ******************************************************************************/
package step.core.artefacts;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import step.core.artefacts.reports.ReportNode;

@Retention(RetentionPolicy.RUNTIME)
public @interface Artefact {
	String LOCATION = "step";

	String name() default ""; 

	Class report() default ReportNode.class;
	
	boolean block() default true;

	/**
	 * @return true if the artefact can be used as root artefact in Plans.
	 */
	boolean validAsRoot() default false;

	/**
	 * @return true if the artefact can be used as control within Plans
	 */
	boolean validAsControl() default true;

	/**
	 * @return true if plans with this artefact as root should be allowed for standalone execution
	 * i.e. when executing an automation package, controlling how related events are dealt with...
	 */
	boolean validForStandaloneExecution() default true;
	/**
	 * Marks the artefact as test (used in unit tests) to avoid inclusion in json schema for Yaml format
	 */
	boolean test() default false;

}