Package org.javastro.ivoa.entities.uws

Class ShortJobDescription

java.lang.Object

org.javastro.ivoa.entities.uws.ShortJobDescription

All Implemented Interfaces:

com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, Cloneable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public class ShortJobDescription
extends Object
implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

Java class for ShortJobDescription complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ShortJobDescription">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="phase" type="{http://www.ivoa.net/xml/UWS/v1.0}ExecutionPhase"/>
         <element name="runId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ownerId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="creationTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
       </sequence>
       <attGroup ref="{http://www.ivoa.net/xml/UWS/v1.0}reference"/>
       <attribute name="id" use="required" type="{http://www.ivoa.net/xml/UWS/v1.0}JobIdentifier" />
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShortJobDescription.Builder<_B>
class	ShortJobDescription.Modifier
static class	ShortJobDescription.PropInfo
static class	ShortJobDescription.Select
static class	ShortJobDescription.Selector<TRoot extends com.kscs.util.jaxb.Selector<TRoot,?>,TParent>

Field Summary

Fields

Modifier and Type	Field	Description
protected ShortJobDescription.Modifier	__cachedModifier__
protected LocalDateTime	creationTime	The instant at which the job was created.
protected String	href
protected String	id
protected String	ownerId	the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards.
protected ExecutionPhase	phase	the execution phase - returned at /{jobs}/{job-id}/phase
protected String	runId	this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job
protected String	type

Constructor Summary

Constructors

Constructor	Description
ShortJobDescription()	Default no-arg constructor
ShortJobDescription(ExecutionPhase phase, String runId, String ownerId, LocalDateTime creationTime, String id, String type, String href)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
static ShortJobDescription.Builder<Void>	builder()
ShortJobDescription	clone()
ShortJobDescription	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ShortJobDescription.Builder<Void>	copyExcept(ShortJobDescription _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> ShortJobDescription.Builder<_B>	copyOf(ShortJobDescription _other)
static <_B> ShortJobDescription.Builder<_B>	copyOf(ShortJobDescription _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ShortJobDescription	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ShortJobDescription.Builder<Void>	copyOnly(ShortJobDescription _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(ShortJobDescription.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(ShortJobDescription.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
ShortJobDescription	createCopy()
ShortJobDescription	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Object	createNewInstance()
boolean	equals(Object object)
LocalDateTime	getCreationTime()	The instant at which the job was created.
String	getHref()	Gets the value of the href property.
String	getId()	Gets the value of the id property.
String	getOwnerId()	the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards.
ExecutionPhase	getPhase()	the execution phase - returned at /{jobs}/{job-id}/phase
String	getRunId()	this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job
String	getType()	Gets the value of the type property.
int	hashCode()
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
ShortJobDescription.Modifier	modifier()
ShortJobDescription.Builder<Void>	newCopyBuilder()
<_B> ShortJobDescription.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> ShortJobDescription.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ShortJobDescription.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setCreationTime(LocalDateTime value)	Sets the value of the creationTime property.
void	setHref(String value)	Sets the value of the href property.
void	setId(String value)	Sets the value of the id property.
void	setOwnerId(String value)	Sets the value of the ownerId property.
void	setPhase(ExecutionPhase value)	Sets the value of the phase property.
void	setRunId(String value)	Sets the value of the runId property.
void	setType(String value)	Sets the value of the type property.
String	toString()
ShortJobDescription	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

phase

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected ExecutionPhase phase

the execution phase - returned at /{jobs}/{job-id}/phase

runId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected String runId

this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job

ownerId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected String ownerId

the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards. If there was no authenticated job creator then this should be set to NULL.

creationTime

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected LocalDateTime creationTime

The instant at which the job was created.

id

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected String id

type

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected String type

href

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected String href

__cachedModifier__

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
protected transient ShortJobDescription.Modifier __cachedModifier__

Constructor Details

ShortJobDescription

public ShortJobDescription()

Default no-arg constructor

ShortJobDescription

public ShortJobDescription(ExecutionPhase phase,
 String runId,
 String ownerId,
 LocalDateTime creationTime,
 String id,
 String type,
 String href)

Fully-initialising value constructor

Method Details

getPhase

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ExecutionPhase getPhase()

the execution phase - returned at /{jobs}/{job-id}/phase

Returns:

possible object is ExecutionPhase

setPhase

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void setPhase(ExecutionPhase value)

Sets the value of the phase property.

Parameters:

value - allowed object is ExecutionPhase

See Also:

• getPhase()

getRunId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public String getRunId()

this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job

Returns:

possible object is String

setRunId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void setRunId(String value)

Sets the value of the runId property.

Parameters:

value - allowed object is String

See Also:

• getRunId()

getOwnerId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public String getOwnerId()

the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards. If there was no authenticated job creator then this should be set to NULL.

Returns:

possible object is String

setOwnerId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void setOwnerId(String value)

Sets the value of the ownerId property.

Parameters:

value - allowed object is String

See Also:

• getOwnerId()

getCreationTime

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public LocalDateTime getCreationTime()

The instant at which the job was created.

Returns:

possible object is String

setCreationTime

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void setCreationTime(LocalDateTime value)

Sets the value of the creationTime property.

Parameters:

value - allowed object is String

See Also:

• getCreationTime()

getId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String

getType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public String getType()

Gets the value of the type property.

Returns:

possible object is String

setType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void setType(String value)

Sets the value of the type property.

Parameters:

value - allowed object is String

getHref

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public String getHref()

Gets the value of the href property.

Returns:

possible object is String

setHref

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void setHref(String value)

Sets the value of the href property.

Parameters:

value - allowed object is String

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public int hashCode()

Overrides:

hashCode in class Object

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public String toString()

Overrides:

toString in class Object

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb.lang.ToString

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb.lang.ToString

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator,
 org.jvnet.jaxb.locator.ObjectLocator rightLocator,
 Object left,
 Object right,
 org.jvnet.jaxb.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom

clone

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription clone()

Overrides:

clone in class Object

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription createCopy()

Specified by:

createCopy in interface com.kscs.util.jaxb.Copyable

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

createCopy in interface com.kscs.util.jaxb.PartialCopyable

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyExcept in interface com.kscs.util.jaxb.PartialCopyable

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyOnly in interface com.kscs.util.jaxb.PartialCopyable

modifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription.Modifier modifier()

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public <_B> void copyTo(ShortJobDescription.Builder<_B> _other)

Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public <_B> ShortJobDescription.Builder<_B> newCopyBuilder(_B _parentBuilder)

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription.Builder<Void> newCopyBuilder()

builder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static ShortJobDescription.Builder<Void> builder()

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static <_B> ShortJobDescription.Builder<_B> copyOf(ShortJobDescription _other)

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public <_B> void copyTo(ShortJobDescription.Builder<_B> _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public <_B> ShortJobDescription.Builder<_B> newCopyBuilder(_B _parentBuilder,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static <_B> ShortJobDescription.Builder<_B> copyOf(ShortJobDescription _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static ShortJobDescription.Builder<Void> copyExcept(ShortJobDescription _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public static ShortJobDescription.Builder<Void> copyOnly(ShortJobDescription _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

visit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-10-20T18:15:02+01:00")
public ShortJobDescription visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)