org.jboss.shrinkwrap.descriptor.api.jobXML10.Step Maven / Gradle / Ivy
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.Batchlet;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Chunk;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Partition;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.End;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Fail;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Next;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Stop;
import org.jboss.shrinkwrap.descriptor.api.jobXML.*;
import org.jboss.shrinkwrap.descriptor.api.jobXML.JslStepCommType;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Properties;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Listeners;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Batchlet;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Chunk;
import org.jboss.shrinkwrap.descriptor.api.jobXML10.Partition;/**
* This interface defines the contract for the Step xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface Step extends Child,
JslStepCommType,
Properties>,
Listeners>,
Batchlet>,
Chunk>,
Partition>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:End ElementType : end
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new end element will be created and returned.
* Otherwise, the first existing end element will be returned.
* @return the instance defined for the element end
*/
public End> getOrCreateEnd();
/**
* Creates a new end element
* @return the new created instance of End>
*/
public End> createEnd();
/**
* Returns all end elements
* @return list of end
*/
public List>> getAllEnd();
/**
* Removes all end elements
* @return the current instance of End>
*/
public Step removeAllEnd();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Fail ElementType : fail
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new fail element will be created and returned.
* Otherwise, the first existing fail element will be returned.
* @return the instance defined for the element fail
*/
public Fail> getOrCreateFail();
/**
* Creates a new fail element
* @return the new created instance of Fail>
*/
public Fail> createFail();
/**
* Returns all fail elements
* @return list of fail
*/
public List>> getAllFail();
/**
* Removes all fail elements
* @return the current instance of Fail>
*/
public Step removeAllFail();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Next ElementType : next
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new next element will be created and returned.
* Otherwise, the first existing next element will be returned.
* @return the instance defined for the element next
*/
public Next> getOrCreateNext();
/**
* Creates a new next element
* @return the new created instance of Next>
*/
public Next> createNext();
/**
* Returns all next elements
* @return list of next
*/
public List>> getAllNext();
/**
* Removes all next elements
* @return the current instance of Next>
*/
public Step removeAllNext();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Stop ElementType : stop
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new stop element will be created and returned.
* Otherwise, the first existing stop element will be returned.
* @return the instance defined for the element stop
*/
public Stop> getOrCreateStop();
/**
* Creates a new stop element
* @return the new created instance of Stop>
*/
public Stop> createStop();
/**
* Returns all stop elements
* @return list of stop
*/
public List>> getAllStop();
/**
* Removes all stop elements
* @return the current instance of Stop>
*/
public Step removeAllStop();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Properties ElementType : properties
// MaxOccurs: -1 isGeneric: true 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 Step
*/
public Step removeProperties();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Listeners ElementType : listeners
// MaxOccurs: -1 isGeneric: true 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 Step
*/
public Step removeListeners();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Batchlet ElementType : batchlet
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new batchlet element with the given value will be created.
* Otherwise, the existing batchlet element will be returned.
* @return a new or existing instance of Batchlet>
*/
public Batchlet> getOrCreateBatchlet();
/**
* Removes the batchlet element
* @return the current instance of Step
*/
public Step removeBatchlet();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Chunk ElementType : chunk
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new chunk element with the given value will be created.
* Otherwise, the existing chunk element will be returned.
* @return a new or existing instance of Chunk>
*/
public Chunk> getOrCreateChunk();
/**
* Removes the chunk element
* @return the current instance of Step
*/
public Step removeChunk();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: jsl:Partition ElementType : partition
// MaxOccurs: -1 isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new partition element with the given value will be created.
* Otherwise, the existing partition element will be returned.
* @return a new or existing instance of Partition>
*/
public Partition> getOrCreatePartition();
/**
* Removes the partition element
* @return the current instance of Step
*/
public Step removePartition();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of Step
*/
public Step 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 Step
*/
public Step removeId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: xsd:string ElementType : start-limit
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the start-limit attribute
* @param startLimit the value for the attribute start-limit
* @return the current instance of Step
*/
public Step startLimit(String startLimit);
/**
* Returns the start-limit attribute
* @return the value defined for the attribute start-limit
*/
public String getStartLimit();
/**
* Removes the start-limit attribute
* @return the current instance of Step
*/
public Step removeStartLimit();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: xsd:string ElementType : allow-start-if-complete
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the allow-start-if-complete attribute
* @param allowStartIfComplete the value for the attribute allow-start-if-complete
* @return the current instance of Step
*/
public Step allowStartIfComplete(String allowStartIfComplete);
/**
* Returns the allow-start-if-complete attribute
* @return the value defined for the attribute allow-start-if-complete
*/
public String getAllowStartIfComplete();
/**
* Removes the allow-start-if-complete attribute
* @return the current instance of Step
*/
public Step removeAllowStartIfComplete();
// --------------------------------------------------------------------------------------------------------||
// ClassName: Step ElementName: xsd:string ElementType : next
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the next attribute
* @param next the value for the attribute next
* @return the current instance of Step
*/
public Step next(String next);
/**
* Returns the next attribute
* @return the value defined for the attribute next
*/
public String getNext();
/**
* Removes the next attribute
* @return the current instance of Step
*/
public Step removeNext();
}