io.legaldocml.akn.element

Class ScopeMod

java.lang.Object

io.legaldocml.akn.element.AbstractId

io.legaldocml.akn.element.ModificationType

io.legaldocml.akn.element.ScopeMod

All Implemented Interfaces:

AknObject, Core, Enactment, Id, IdReq, Modifiers, Period, Refers, RefersOpt, ScopeModType, AmendmentsElement, Visitable, Externalizable

public final class ScopeMod
extends ModificationType
implements ScopeModType, AmendmentsElement

The element scopeMod is a metadata element specifying an (active or passive) modification in scope for the document.

  <xsd:element name=“scopeMod”>  <xsd:complexType>  <xsd:complexContent>  <xsd:extension base=“modificationType”>  <xsd:sequence>  <xsd:element ref=“domain” minOccurs=“0” maxOccurs=“1”/>  <xsd:sequence>  <xsd:attributeGroup ref=“scopeModType”/>  <xsd:extension>  <xsd:complexContent>  <xsd:complexType>  <xsd:element> 

Author:

Jacques Militello

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.common.collect.ImmutableMap<String,AttributeGetterSetter<AknObject>>	ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
ScopeMod()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<String,AttributeGetterSetter<AknObject>>	attributes() To read attributes.
Domain	getDomain()
ScopeMods	getType()
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	setDomain(Domain domain)
void	setType(ScopeMods type)
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.ModificationType

addDestination, addSource, getExclusion, getIncomplete, getPeriod, getRefersTo, getStatus, setExclusion, setIncomplete, setPeriod, setRefersTo, setStatus

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

add, getAttributes, nestedCompare

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

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

Field Detail

ATTRIBUTES

protected static final com.google.common.collect.ImmutableMap<String,AttributeGetterSetter<AknObject>> ATTRIBUTES

Constructor Detail

ScopeMod

public ScopeMod()

Method Detail

getType

public ScopeMods getType()

Specified by:

getType in interface ScopeModType

setType

public void setType(ScopeMods type)

Specified by:

setType in interface ScopeModType

getDomain

public Domain getDomain()

setDomain

public void setDomain(Domain domain)

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 IdReq

Specified by:

write in interface Externalizable

Overrides:

write in class ModificationType

Parameters:

writer - the stream to write the object to

Throws:

IOException

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 ModificationType

Parameters:

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

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: ModificationType

To read attributes.

Specified by:

attributes in interface AknObject

Overrides:

attributes in class ModificationType