org.jboss.shrinkwrap.descriptor.api.jobXML10.JobXMLDescriptor Maven / Gradle / Ivy
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
package org.jboss.shrinkwrap.descriptor.api.jobXML10;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Properties;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Listeners;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Decision;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Flow;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Split;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Step;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
import org.jboss.shrinkwrap.descriptor.api.jobXML.*;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* JobXMLDescriptor descriptor = Descriptors.create(JobXMLDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface JobXMLDescriptor extends Descriptor, DescriptorNamespace,
JobXMLCommonDescriptor,
Listeners,
Decision,
Flow,
Split,
Step> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: jsl:Properties ElementType : properties
// MaxOccurs: -1 isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new properties element with the given value will be created.
* Otherwise, the existing properties element will be returned.
* @return a new or existing instance of Properties
*/
public Properties getOrCreateProperties();
/**
* Removes the properties element
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor removeProperties();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: jsl:Listeners ElementType : listeners
// MaxOccurs: -1 isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new listeners element with the given value will be created.
* Otherwise, the existing listeners element will be returned.
* @return a new or existing instance of Listeners
*/
public Listeners getOrCreateListeners();
/**
* Removes the listeners element
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor removeListeners();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: jsl:Decision ElementType : decision
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new decision element will be created and returned.
* Otherwise, the first existing decision element will be returned.
* @return the instance defined for the element decision
*/
public Decision getOrCreateDecision();
/**
* Creates a new decision element
* @return the new created instance of Decision
*/
public Decision createDecision();
/**
* Returns all decision elements
* @return list of decision
*/
public List> getAllDecision();
/**
* Removes all decision elements
* @return the current instance of Decision
*/
public JobXMLDescriptor removeAllDecision();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: jsl:Flow ElementType : flow
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new flow element will be created and returned.
* Otherwise, the first existing flow element will be returned.
* @return the instance defined for the element flow
*/
public Flow getOrCreateFlow();
/**
* Creates a new flow element
* @return the new created instance of Flow
*/
public Flow createFlow();
/**
* Returns all flow elements
* @return list of flow
*/
public List> getAllFlow();
/**
* Removes all flow elements
* @return the current instance of Flow
*/
public JobXMLDescriptor removeAllFlow();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: jsl:Split ElementType : split
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new split element will be created and returned.
* Otherwise, the first existing split element will be returned.
* @return the instance defined for the element split
*/
public Split getOrCreateSplit();
/**
* Creates a new split element
* @return the new created instance of Split
*/
public Split createSplit();
/**
* Returns all split elements
* @return list of split
*/
public List> getAllSplit();
/**
* Removes all split elements
* @return the current instance of Split
*/
public JobXMLDescriptor removeAllSplit();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: jsl:Step ElementType : step
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new step element will be created and returned.
* Otherwise, the first existing step element will be returned.
* @return the instance defined for the element step
*/
public Step getOrCreateStep();
/**
* Creates a new step element
* @return the new created instance of Step
*/
public Step createStep();
/**
* Returns all step elements
* @return list of step
*/
public List> getAllStep();
/**
* Removes all step elements
* @return the current instance of Step
*/
public JobXMLDescriptor removeAllStep();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: xsd:string ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
public static final String VERSION = "1.0";
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public String getVersion();
/**
* Removes the version attribute
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor removeVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor id(String id);
/**
* Returns the id attribute
* @return the value defined for the attribute id
*/
public String getId();
/**
* Removes the id attribute
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor removeId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: JobXMLDescriptor ElementName: xsd:string ElementType : restartable
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the restartable attribute
* @param restartable the value for the attribute restartable
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor restartable(String restartable);
/**
* Returns the restartable attribute
* @return the value defined for the attribute restartable
*/
public String getRestartable();
/**
* Removes the restartable attribute
* @return the current instance of JobXMLDescriptor
*/
public JobXMLDescriptor removeRestartable();
}