Uses of Interface
io.legaldocml.akn.attribute.IdOpt

Packages that use IdOpt

Package	Description
io.legaldocml.akn.attribute
io.legaldocml.akn.element
io.legaldocml.akn.util

Uses of IdOpt in io.legaldocml.akn.attribute

Subinterfaces of IdOpt in io.legaldocml.akn.attribute

Modifier and Type	Interface and Description
interface	CoreOpt This is the list of the core attributes that all elements in the content part of the document must have.

Uses of IdOpt in io.legaldocml.akn.element

Classes in io.legaldocml.akn.element that implement IdOpt

Modifier and Type	Class and Description
class	A The element a is an HTML element and is used in Akoma Ntoso as in HTML, for the generic link to a web resource (NOT to an Akoma Ntoso document: use ref for that).
class	Abbr The element abbr is an HTML element and is used in Akoma Ntoso as in HTML, for the specification of an abbreviation or an acronym (an inline).
class	AffectedDocument The element affectedDocument is an inline element within preamble to identify the document that this amendment affects.
class	AlternativeReference The element alternativeReference contains an alternative reference (e.g., using a different namespace) for a legal reference.
class	AmendmentBody The element amendmentBody is the container of the main hierarchy of a amendment document.
class	AmendmentBodyType
class	AmendmentContent This element is a structural container for the section of an amendment containing the actual amendment text.
class	AmendmentHeading This element is a structural container for the section of an amendment containing the heading.
class	AmendmentJustification This element is a structural container for the section of an amendment containing the justification.
class	AmendmentReference This element is a structural container for the section of an amendment containing the reference.
class	Answer The element answer is a container of a single official answer to a question.
class	AnyOtherType The complex type anyOtherType defines an open content model for elements that may use elements from other namespaces.
class	Application The element application is a metadata element specifying the period of the application modification.
class	Argument the element argument is an inline element within judgments for classifying the arguments in the motivation part of the judgment.
class	Arguments This element is a structural container for the section of a judgment containing the arguments.
class	ArgumentType The complex type argumentType defines the empty content model and the list of attributes for metadata elements in the analysis section.
class	AttachmentsV2
class	B The element b is an HTML element and is used in Akoma Ntoso as in HTML, for the bold style (an inline).
class	Background This element is a structural container for the section of a judgment containing the background.
class	Basicopt the complex type basicopt defines the content model and attributes used by basic containers such as coverPage and conclusions.
class	Block The element block is a generic element for a block.
class	Blocksopt The complex type blocksopt defines the content model and attributes shared by all containers.
class	Body The element body is the container of the main hierarchy of a hierarchical document (e.g, an act or a bill).
class	BodyType the type bodyType specifies a content model of the main hierarchy of a hierarchical document (e.g, an act or a bill).
class	BooleanValueType The type booleanValueType specifies a boolean value attribute to FRBR elements.
class	Br The element br is an HTML element and is used in Akoma Ntoso as in HTML, for the breaking of a line.
class	Caption The element caption is an HTML element and is used in Akoma Ntoso as in HTML, for the caption of a table (a block).
class	Change The element change is an inline element that identifies the changes expressed in the two columns of an amendment document.
class	CollectionBody The element collectionBody is the container of a list of other documents (e.g, acts, bills, amendments, etc.) possibly interspersed with interstitial elements with content that does not form an individual document.
class	CollectionBodyType The type collectionBodyType specifies a content model of a container of a list of other documents (e.g, acts, bills, amendments, etc.) possibly interspersed with interstitial elements with content that does not form an individual document.
class	ComponentRef The element componentRef is a reference to a separate manifestation-level resource that holds the content of the component of the document not physically placed at the position specified.
class	Conclusions The element conclusion is used as a container of all concluding material (e.g. dates, signatures, formulas, etc.).
class	Condition The element condition is a metadata element specifying an open set of conditions on the modification (non managed by Akoma Ntoso).
class	CourtType The element courtType is an inline element within judgments to identify the string used by the document for the type of the court doing the judgment.
class	CoverPage The element coverPage is used as a container of the text that acts as a cover page.
class	Date The element date is an inline element to identify a date expressed in the text and to propose a normalized representation in the date attribute.
class	DebateBody The type debateBodyType specifies a content model of the main hierarchy of a debate.
class	DebateBodyType The type debateBodyType specifies a content model of the main hierarchy of a debate.
class	Decision This element is a structural container for the section of a judgment containing the decision.
class	Decoration the element decoration is an inline element to represent a decorative aspect that is present in the orignal text and that is meant as additional information to the text (e.g., the annotation ‘new’ on the side of a freshly inserted structure.
class	Def the element def is an inline element used for the definition of a term used in the rest of the document.
class	Del The element del is an inline element for the specification of editorial deletions.
class	Destination The element destination is a metadata element specifying the IRI of the destination of the modification.
class	DocAuthority The element docAuthority is an inline element within preface to identify the string used by the document detailing the Auhtority to which the document was submitted.
class	DocCommittee The element docCommittee is an inline element within preface to identify the string used by the document detailing the committee within which the document originated.
class	DocDate The element docDate is an inline element within preface to identify the string used by the document for its own date(s).
class	DocIntroducer The element docIntroducer is an inline element within preface to identify the string used by the document detailing the individual introducing of the document.
class	DocJurisdiction The element docJurisdiction is an inline element within preface to identify the string used by the document detailing the jurisdiction of the document.
class	DocketNumber The element docketNumber is an inline element within preface to identify the string used by the document for the number of the docket, case, file, etc which the document belongs to.
class	DocNumber The element docNumber is an inline element within preface to identify the string used by the document for its own number.
class	DocProponent the element docProponent is an inline element within preface to identify the string used by the document for its proponent.
class	DocPurpose The element docPurpose is an inline element within preface to identify the string used by the document detailing its own purpose
class	DocStage the element docStage is an inline element within preface to identify the string used by the document detailing the stage in which the document sits.
class	DocStatus The element docStatus is an inline element within preface to identify the string used by the document detailing the status of the document.
class	DocTitle the element docTitle is an inline element within preface to identify the string used by the document for its own title.
class	DocType The element docType is an inline element within preface to identify the string used by the document for its own type.
class	Domain The element domain is a metadata element containing (in some non-managed form) the domain to which the modification applies.
class	Duration The element duration is a metadata element specifying the period of the duration modification.
class	Efficacy The element efficacy is a metadata element specifying the period of the efficacy modification.
class	EmbeddedText the element embeddedText is an inline element containing a string used as an extract from another document.
class	Eol The element eol (end of line) is a marker for where in the original text the line breaks.
class	EolType the complex type eolType is shared by eol and eop elements as being able to specify a hyphen character and a position within the next word in which the break can happen, and the number if any, associated to the page or line at issue.
class	Eop The element eop (end of page) is a marker for where in the original text the page breaks.
class	EventRef The element eventRef is a metadata element specifying facts about an event that had an effect on the document.
class	ExtractText Deprecated.
class	FillIn the element fillIn is an inline element shown as a dotted line or any other typoaphical characteristics to represent a fill-in element in a printed form, that is as ane example of an actual form.
class	Force The element force is a metadata element specifying the period of the force modification.
class	Foreign The element foreign is a generic container for elements not belonging to the Akoma Ntoso namespace (e.g., mathematical formulas).
class	FRBRalias The element FRBRalias is the metadata property containing additional well-known names of the document in the respective level of the FRBR hierarchy <xsd:element name=“FRBRalias” type=“valueType”/>
class	FRBRauthor The element FRBRauthor is the metadata property containing a relevant author of the document in the respective level of the FRBR hierarchy.
class	FRBRauthoritative The element FRBRauthoritative is the metadata property containing a boolean value to determine whether the document contains authoritative text (i.e., content that is the official, authoritative product of an official workflow from an entity that is entrusted with generating an official, authoriative version of the document.
class	FRBRcountry The element FRBRcountry is the metadata property containing a ISO 3166-1 Alpha-2 code for the country or jurisdiction to be used in the work-level IRI of this document
class	FRBRdate The element FRBRdate is the metadata property containing a relevant date of the document in the respective level of the FRBR hierarchy.
class	FRBRformat The element FRBRformat is the metadata property containing the Internet Media Type specification for the data format to be used in the manifestation-level IRI of this document.
class	FRBRlanguage The element FRBRlanguage is the metadata property containing a RFC4646 (three-letter code) of the main human language used in the content of this expression.
class	FRBRname The element FRBRname is the metadata property containing a string for the title to be used in the work-level IRI of this document.
class	FRBRnumber The element FRBRnumber is the metadata property containing a string or number for the number to be used in the work-level IRI of this document.
class	FRBRportion The element FRBRportion is the metadata property containing the eId of the portion contained in a manifestation-level portion.
class	FRBRprescriptive The element FRBRprescriptive is the metadata property containing a boolean value to determine whether the document contains prescriptive text (i.e., text that is or might become prescriptive, such as an act or a bill) or not (such as, for instance, a non-normative resolution from an assembly.
class	FRBRsubtype The element FRBRsubtype is the metadata property containing a string for the specific subtype of the document to be used in the work-level IRI of this document
class	FRBRthis The element FRBRthis is the metadata property containing the IRI of the specific component of the document.
class	FRBRtranslation The element FRBRtranslation is the metadata property specifying the source of which this expression is a translation of.
class	FRBRuri The element FRBRuri is the metadata property containing the IRI of the whole document.
class	FRBRversionNumber The element FRBRversionNumber is the metadata property containing the value of the version number if appropriate to identify the specific expression here contained.
class	From The element from is a heading element in a debate that contains the name or role or a reference to the person doing the speech.
class	Header the element header is used as a container of all prefacing material of judgments (e.g. headers, formulas, etc.).
class	I The element i is an HTML element and is used in Akoma Ntoso as in HTML, for the italic style (an inline).
class	Img The element img is an HTML element and is used in Akoma Ntoso as in HTML, for including an image.
class	ImplicitReference The element implicitReference contains a legal reference to a document that is not explicitly mentioned in the content of the document.
class	Inline The element inline is a generic element for an inline.
class	InlineType The complex type inline defines the content model and attributes shared by all blocks and inlines.
class	Ins The element ins is an inline element for the specification of editorial insertions.
class	Introduction This element is a structural container for the section of a judgment containing introductory material.
class	JudgmentBody The element judgmentBody is the container of the main hierarchy of a judgment document.
class	JudgmentBodyType The type judgmentBodyType specifies a content model of the main hierarchy of a judgment document.
class	Keyword The element keyword is a metadata element specifying a keyword associated to the FRBR expression of the document.
class	Legislature The element legislature is an inline element within preface to identify the string used by the document for the legislature relative to the document.
class	Li The element li is an HTML element and is used in Akoma Ntoso as in HTML, for the generic list item (not a pattern).
class	ListIntroduction The element listIntroduction is an optional element of blockList before any item of the list itself.
class	ListWrapUp The element listWrapUp is an optional element of blockList after all items of the list itself.
class	MainBody The element mainContent is the container of the main part of all other document types.
class	MainContent The complex type maincontent is used by container elements that can contain basically any other Akoma Ntoso structure.
class	MarkerOpt The complex type markeropt defines the content model and attributes shared by all marker elements.
class	MetaOpt The complex type metaopt defines the content model and attributes shared by all metadata elements.
class	Motivation This element is a structural container for the section of a judgment containing the motivation.
class	Mref The element mref is an inline element containing multiple references (each in turn represented by a ref element)
class	Narrative The element narrative is a block element in a debate to mark description in the third person of events taking place in the meeting, e.g.
class	NeutralCitation The element neutralCitation is an inline element within judgments to identify the string declared by the document as being the neutral citation for the judgment.
class	New The element new is a metadata element containing (in some non-managed form) the new text of the modification.
class	NoteRef the element noteRef is a reference to a editorial note placed in the notes metadata section.
class	Num The element num is a heading element in a hierarchy that contains a number or any other ordered mechanism to identify the structure.
class	Old The element old is a metadata element containing (in some non-managed form) the old text of the modification.
class	Omissis the element omissis is an inline element for the specification of a text that substitutes a textual omission (e.g., dots, spaces, the word “omissis”, etc.
class	Opinion The element opinion is an inline element to identify where the document defines the opinion of an actor.
class	OtherAnalysis The element otherAnalysis is a metadata container of any additional metadata analysis element that does not belong to the specific categories provided before.
class	Outcome The element outcome is an inline that wraps the outcome of a vote.
class	P The element p is an HTML element and is used in Akoma Ntoso as in HTML, for the generic paragraph of text (a block).
class	PeriodType The complex type periodType defines the empty content model and the list of attributes for metadata elements in the analysis section using periods.
class	Placeholder the element placeholder is an inline element containing the text of a computable expression (e.g., ‘30 days after the publication of this act’) that can be replaced editorially with an actual value.
class	PortionBody The element portionBody is the container of a portion of another document.
class	PortionBodyType The type portionBodyType specifies a content model of a container of a portion of another document.
class	Preamble The element preamble is used as a container of the text that opens the main body of the document as a preamble.
class	Preambleopt The complex type preambleopt defines the content model and attributes used by preambles.
class	Preface The element preface is used as a container of all prefacing material (e.g. headers, formulas, etc.).
class	Prefaceopt the complex type prefaceopt defines the content model and attributes used by preface.
class	Presentation The element presentation is a metadata container of any presentation specification for the visual rendering of Akoam Ntoso elements.
class	Preservation The element preservation is the metadata property containing an arbitrary list of elements detailing the preservation actions taken for the document is the respective level of the FRBR hierarchy.
class	Previous The element previous is a metadata element referring to the element (rather than the text) of the modification in the previous version of the document.
class	Proprietary The element proprietary is a metadata container of any additional metadata property that does not belong to the Akoma Ntoso properties.
class	Publication The element publication is the metadata container specifying an official publication event for the FRBR expression of the document.
class	Question The element question is a container of a single official question as proposed by an MP to a person holding an official position.
class	QuotedText the element quotedText is an inline element containing a small string that is used either as the text being replaced, or the replacement, or the positioning at which some modification should take place.
class	RecordedTime the element recordedTime is an inline element for the specification of an explicit mention of a time (e.g., in a debate).
class	RelatedDocument The element relatedDocument is an inline element to identify the document for which this document is a report of.
class	Remark the element remark is an inline element for the specification of editorial remarks (e.g., applauses, laughters, etc.) especially within debate records/ <xsd:element name=“remark”> <xsd:complexType mixed=“true”> <xsd:complexContent> <xsd:extension base=“inline”> <xsd:attributeGroup ref=“remarkType”/> <xsd:extension> <xsd:complexContent> <xsd:complexType> <xsd:element>
class	Remedies This element is a structural container for the section of a judgment containing the remedies.
class	Restriction The element restriction specifies information about a restriction (such as a jurisdiction specification) by pointing to a specific legislative, geographic or temporal events through the refersTo attribute.
class	Result The element result is a metadata element specifying the overall result of the judgment.
class	Scene The element scene is a container of descriptions of the scene elements happening in a given moment during a debate (e.g., applauses).
class	Session The element session is an inline element within preface to identify the string used by the document for the session of the legislature relative to the document.
class	ShortTitle The element shortTitle is an inline element within preface to identify the string used by the document for the short title of the document.
class	Signature The element signature is an inline element within conclusions to identify where the document defines one of the signatures.
class	Source The element source is a metadata element specifying the IRI of the source of the modification.
class	Span The element span is an HTML element and is used in Akoma Ntoso as in HTML, for the generic inline.
class	Speech The element speech is a container of a single speech utterance in a debate.
class	SpeechType The complex type speechType defines the content model and attributes shared by all speech elements.
class	SrcType The complex type srcType defines the empty content model and the list of attributes for manifestation-level references to external resources.
class	Step The element step is a metadata element specifying facts about a workflow step occurred to the document.
class	Sub The element sub is an HTML element and is used in Akoma Ntoso as in HTML, for the subscript style (an inline).
class	Summary The element summary is a block element in a debate to mark summaries of speeches that are individually not interesting (e.g.: “Question put and agreed to”).
class	Sup The element sup is an HTML element and is used in Akoma Ntoso as in HTML, for the superscript style (an inline).
class	Td The element td is an HTML element and is used in Akoma Ntoso as in HTML, for a data cell of a table.
class	Th The element th is an HTML element and is used in Akoma Ntoso as in HTML, for a header cell of a table.
class	Time The element time is an inline element to identify a time expressed in the text and to propose a normalized representation in the time attribute.
class	TimeInterval The element timeInterval contains all the data needed to identify a specific time interval.
class	TocItem The element tocItem is a component of the table of content and contains header information about sections or parts of the rest of the document.
class	Tr
class	U The element u is an HTML element and is used in Akoma Ntoso as in HTML, for the underline style (an inline).
class	ValueType The type valueType specifies a text attribute to FRBR elements.
class	Vote The element vote is an inline that wraps either the name of the voter (when organized by choice) or the vote (when organized by name) in a voting report.
class	Wrap The element wrap is a concluding element in a hierarchy that contains paragraphs wrapping up the preceding lower hierarchical elements.

Uses of IdOpt in io.legaldocml.akn.util

Methods in io.legaldocml.akn.util with parameters of type IdOpt

Modifier and Type	Method and Description
static void	XmlWriterHelper.writeIdOpt(XmlWriter writer, IdOpt idOpt)