io.legaldocml.akn.element

Class Step

java.lang.Object

io.legaldocml.akn.element.AbstractId

io.legaldocml.akn.element.AnyOtherType

io.legaldocml.akn.element.Step

All Implemented Interfaces:

AknObject, Actor, Agent, Core, Date, Id, IdOpt, Link, LinkOpt, Outcome, Role, Visitable, Externalizable

public final class Step
extends AnyOtherType
implements Role, Date, Outcome, Actor, Agent

The element step is a metadata element specifying facts about a workflow step occurred to the document. For each event, a date, a type, an agent (and the corresponding role) that generated the action must be referenced. The outcome, too, can be specified.

  <xsd:element name=“step”>  <xsd:complexType>  <xsd:complexContent>  <xsd:extension base=“anyOtherType”>  <xsd:attributeGroup ref=“date”/>  <xsd:attributeGroup ref=“agent”/>  <xsd:attributeGroup ref=“actor”/>  <xsd:attributeGroup ref=“role”/>  <xsd:attributeGroup ref=“outcome”/>  <xsd:extension>  <xsd:complexContent>  <xsd:complexType>  <xsd:element> 

Author:

Jacques Militello

Constructor Summary

Constructors

Constructor and Description
Step()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<String,AttributeGetterSetter<AknObject>>	attributes() To read attributes.
String	getActor()
RoleRef	getAs()
AgentRef	getBy()
OffsetDateTime	getDate()
ConceptRef	getOutcome()
String	name() Name of this object (the name of the xml element)
void	read(XmlReader reader) The object implements the read method to restore its contents by calling the methods of Input.
void	setActor(String actor)
void	setAs(RoleRef as)
void	setBy(AgentRef by)
void	setDate(OffsetDateTime date)
void	setOutcome(ConceptRef outcome)
void	write(XmlWriter writer) The object implements the write method to save its contents by calling the methods of Output.

Methods inherited from class io.legaldocml.akn.element.AnyOtherType

accept, add, add, getHref, setHref

Methods inherited from class io.legaldocml.akn.element.AbstractId

getEid, getEvolvingId, getGUID, getId, getWid, setEid, setEvolvingId, setGUID, setId, setWid, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.legaldocml.akn.AknObject

compare, nestedCompare

Methods inherited from interface io.legaldocml.akn.visitor.Visitable

accept

Methods inherited from interface io.legaldocml.akn.attribute.Core

getAttributes, nestedCompare

Methods inherited from interface io.legaldocml.akn.attribute.Id

getEid, getEvolvingId, getGUID, getId, getWid, setEid, setEvolvingId, setGUID, setId, setWid

Constructor Detail

Step

public Step()

Method Detail

getDate

public OffsetDateTime getDate()

Specified by:

getDate in interface Date

setDate

public void setDate(OffsetDateTime date)

Specified by:

setDate in interface Date

getAs

public RoleRef getAs()

Specified by:

getAs in interface Role

setAs

public void setAs(RoleRef as)

Specified by:

setAs in interface Role

getOutcome

public ConceptRef getOutcome()

Specified by:

getOutcome in interface Outcome

setOutcome

public void setOutcome(ConceptRef outcome)

Specified by:

setOutcome in interface Outcome

getActor

public String getActor()

Specified by:

getActor in interface Actor

setActor

public void setActor(String actor)

Specified by:

setActor in interface Actor

getBy

public AgentRef getBy()

Specified by:

getBy in interface Agent

setBy

public void setBy(AgentRef by)

Specified by:

setBy in interface Agent

read

public void read(XmlReader reader)

The object implements the read method to restore its contents by calling the methods of Input.

Specified by:

read in interface Externalizable

Overrides:

read in class AnyOtherType

Parameters:

reader - the stream to read data from in order to restore the object

write

public void write(XmlWriter writer)
           throws IOException

The object implements the write method to save its contents by calling the methods of Output.

Specified by:

write in interface Core

Specified by:

write in interface IdOpt

Specified by:

write in interface Externalizable

Overrides:

write in class AnyOtherType

Parameters:

writer - the stream to write the object to

Throws:

IOException

name

public String name()

Name of this object (the name of the xml element)

Specified by:

name in interface AknObject

attributes

public com.google.common.collect.ImmutableMap<String,AttributeGetterSetter<AknObject>> attributes()

Description copied from class: AnyOtherType

To read attributes.

Specified by:

attributes in interface AknObject

Overrides:

attributes in class AnyOtherType