org.jboss.shrinkwrap.descriptor.api.jobXML10

Interface JobXMLDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<JobXMLDescriptor>, JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

public interface JobXMLDescriptor
extends Descriptor, DescriptorNamespace<JobXMLDescriptor>, JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

This deployment descriptor provides the functionalities as described in the specification

Example:

JobXMLDescriptor descriptor = Descriptors.create(JobXMLDescriptor.class);

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Method Summary

Modifier and Type	Method and Description
Decision<JobXMLDescriptor>	createDecision() Creates a new decision element
Flow<JobXMLDescriptor>	createFlow() Creates a new flow element
Split<JobXMLDescriptor>	createSplit() Creates a new split element
Step<JobXMLDescriptor>	createStep() Creates a new step element
List<Decision<JobXMLDescriptor>>	getAllDecision() Returns all decision elements
List<Flow<JobXMLDescriptor>>	getAllFlow() Returns all flow elements
List<Split<JobXMLDescriptor>>	getAllSplit() Returns all split elements
List<Step<JobXMLDescriptor>>	getAllStep() Returns all step elements
String	getId() Returns the id attribute
Decision<JobXMLDescriptor>	getOrCreateDecision() If not already created, a new decision element will be created and returned.
Flow<JobXMLDescriptor>	getOrCreateFlow() If not already created, a new flow element will be created and returned.
Listeners<JobXMLDescriptor>	getOrCreateListeners() If not already created, a new listeners element with the given value will be created.
Properties<JobXMLDescriptor>	getOrCreateProperties() If not already created, a new properties element with the given value will be created.
Split<JobXMLDescriptor>	getOrCreateSplit() If not already created, a new split element will be created and returned.
Step<JobXMLDescriptor>	getOrCreateStep() If not already created, a new step element will be created and returned.
String	getRestartable() Returns the restartable attribute
String	getVersion() Returns the version attribute
JobXMLDescriptor	id(String id) Sets the id attribute
JobXMLDescriptor	removeAllDecision() Removes all decision elements
JobXMLDescriptor	removeAllFlow() Removes all flow elements
JobXMLDescriptor	removeAllSplit() Removes all split elements
JobXMLDescriptor	removeAllStep() Removes all step elements
JobXMLDescriptor	removeId() Removes the id attribute
JobXMLDescriptor	removeListeners() Removes the listeners element
JobXMLDescriptor	removeProperties() Removes the properties element
JobXMLDescriptor	removeRestartable() Removes the restartable attribute
JobXMLDescriptor	removeVersion() Removes the version attribute
JobXMLDescriptor	restartable(String restartable) Sets the restartable attribute
JobXMLDescriptor	version(String version) Sets the version attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor

exportAsString, exportTo, getDescriptorName

Field Detail

VERSION

static final String VERSION

See Also:

Constant Field Values

Method Detail

getOrCreateProperties

Properties<JobXMLDescriptor> getOrCreateProperties()

If not already created, a new properties element with the given value will be created. Otherwise, the existing properties element will be returned.

Returns:

a new or existing instance of Properties

removeProperties

JobXMLDescriptor removeProperties()

Removes the properties element

Returns:

the current instance of JobXMLDescriptor

getOrCreateListeners

Listeners<JobXMLDescriptor> getOrCreateListeners()

If not already created, a new listeners element with the given value will be created. Otherwise, the existing listeners element will be returned.

Returns:

a new or existing instance of Listeners

removeListeners

JobXMLDescriptor removeListeners()

Removes the listeners element

Returns:

the current instance of JobXMLDescriptor

getOrCreateDecision

Decision<JobXMLDescriptor> getOrCreateDecision()

If not already created, a new decision element will be created and returned. Otherwise, the first existing decision element will be returned.

Returns:

the instance defined for the element decision

createDecision

Decision<JobXMLDescriptor> createDecision()

Creates a new decision element

Returns:

the new created instance of Decision

getAllDecision

List<Decision<JobXMLDescriptor>> getAllDecision()

Returns all decision elements

Returns:

list of decision

removeAllDecision

JobXMLDescriptor removeAllDecision()

Removes all decision elements

Returns:

the current instance of Decision

getOrCreateFlow

Flow<JobXMLDescriptor> getOrCreateFlow()

If not already created, a new flow element will be created and returned. Otherwise, the first existing flow element will be returned.

Returns:

the instance defined for the element flow

createFlow

Flow<JobXMLDescriptor> createFlow()

Creates a new flow element

Returns:

the new created instance of Flow

getAllFlow

List<Flow<JobXMLDescriptor>> getAllFlow()

Returns all flow elements

Returns:

list of flow

removeAllFlow

JobXMLDescriptor removeAllFlow()

Removes all flow elements

Returns:

the current instance of Flow

getOrCreateSplit

Split<JobXMLDescriptor> getOrCreateSplit()

If not already created, a new split element will be created and returned. Otherwise, the first existing split element will be returned.

Returns:

the instance defined for the element split

createSplit

Split<JobXMLDescriptor> createSplit()

Creates a new split element

Returns:

the new created instance of Split

getAllSplit

List<Split<JobXMLDescriptor>> getAllSplit()

Returns all split elements

Returns:

list of split

removeAllSplit

JobXMLDescriptor removeAllSplit()

Removes all split elements

Returns:

the current instance of Split

getOrCreateStep

Step<JobXMLDescriptor> getOrCreateStep()

If not already created, a new step element will be created and returned. Otherwise, the first existing step element will be returned.

Returns:

the instance defined for the element step

createStep

Step<JobXMLDescriptor> createStep()

Creates a new step element

Returns:

the new created instance of Step

getAllStep

List<Step<JobXMLDescriptor>> getAllStep()

Returns all step elements

Returns:

list of step

removeAllStep

JobXMLDescriptor removeAllStep()

Removes all step elements

Returns:

the current instance of Step

version

JobXMLDescriptor version(String version)

Sets the version attribute

Specified by:

version in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Parameters:

version - the value for the attribute version

Returns:

the current instance of JobXMLDescriptor

getVersion

String getVersion()

Returns the version attribute

Specified by:

getVersion in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Returns:

the value defined for the attribute version

removeVersion

JobXMLDescriptor removeVersion()

Removes the version attribute

Specified by:

removeVersion in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Returns:

the current instance of JobXMLDescriptor

id

JobXMLDescriptor id(String id)

Sets the id attribute

Specified by:

id in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Parameters:

id - the value for the attribute id

Returns:

the current instance of JobXMLDescriptor

getId

String getId()

Returns the id attribute

Specified by:

getId in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Returns:

the value defined for the attribute id

removeId

JobXMLDescriptor removeId()

Removes the id attribute

Specified by:

removeId in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Returns:

the current instance of JobXMLDescriptor

restartable

JobXMLDescriptor restartable(String restartable)

Sets the restartable attribute

Specified by:

restartable in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Parameters:

restartable - the value for the attribute restartable

Returns:

the current instance of JobXMLDescriptor

getRestartable

String getRestartable()

Returns the restartable attribute

Specified by:

getRestartable in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Returns:

the value defined for the attribute restartable

removeRestartable

JobXMLDescriptor removeRestartable()

Removes the restartable attribute

Specified by:

removeRestartable in interface JobXMLCommonDescriptor<JobXMLDescriptor,Properties<JobXMLDescriptor>,Listeners<JobXMLDescriptor>,Decision<JobXMLDescriptor>,Flow<JobXMLDescriptor>,Split<JobXMLDescriptor>,Step<JobXMLDescriptor>>

Returns:

the current instance of JobXMLDescriptor