Package com.esprow.oapi.repository

Interface OapiDocumentation

All Superinterfaces:

OapiBaseEntity

public interface OapiDocumentation
extends OapiBaseEntity

An element containing a description of its ancestor element.

The following attributes and references are supported:

• All Contents
• All Elements
• Content Type
• Lang Id
• Purpose
• Text

Method Summary

Modifier and Type	Method	Description
MixedContent	getAllContents()	Returns a list of all content present within the container, including elements and text nodes.
MixedContent	getAllElements()	Returns a list of all elements present within the container.
String	getContentType()	Returns a type of content contained in the documentation.
String	getLangId()	Returns the language of documentation.
Object	getPurpose()	Returns the purpose of documentation.
String	getText()	Returns a textual representation of the content.
void	setContentType(String value)	Set a type of content contained in the documentation.
void	setLangId(String value)	Set the language of documentation.
void	setPurpose(Object value)	Set the purpose of documentation.

Methods inherited from interface com.esprow.oapi.repository.OapiBaseEntity

getAdded, getAddedEP, getChangeType, getDeprecated, getDeprecatedEP, getIssue, getLastModified, getReplaced, getReplacedByField, getReplacedEP, getSupported, getUpdated, getUpdatedEP, setAdded, setAddedEP, setChangeType, setDeprecated, setDeprecatedEP, setIssue, setLastModified, setReplaced, setReplacedByField, setReplacedEP, setSupported, setUpdated, setUpdatedEP

Method Details

getAllContents

MixedContent getAllContents()

Returns a list of all content present within the container, including elements and text nodes.

Returns:

a list of all content present within the container, including elements and text nodes

getAllElements

MixedContent getAllElements()

Returns a list of all elements present within the container.

Returns:

a list of all elements present within the container

getContentType

String getContentType()

Returns a type of content contained in the documentation. The default value is "text/plain".

Returns:

a type of content contained in the documentation

See Also:

• setContentType(String)

setContentType

void setContentType(String value)

Set a type of content contained in the documentation.

Parameters:

value - the new value of the 'Content Type' attribute.

See Also:

• getContentType()

getLangId

String getLangId()

Returns the language of documentation.

Returns:

the language of documentation

See Also:

• setLangId(String)

setLangId

void setLangId(String value)

Set the language of documentation.

Parameters:

value - the new value of the 'Lang Id' attribute.

See Also:

• getLangId()

getPurpose

Object getPurpose()

Returns the purpose of documentation.

Returns:

the purpose of documentation

See Also:

• setPurpose(Object)

setPurpose

void setPurpose(Object value)

Set the purpose of documentation.

Parameters:

value - the new value of the 'Purpose' attribute.

See Also:

• getPurpose()

getText

String getText()

Returns a textual representation of the content.

If there are several text items in getAllContents(), their values are joined with whitespace delimiter. The resulting string is trimmed afterwards. Nested items are not processed recursively. If there is no first-level text items, an empty string is returned.

Returns:

a textual representation of the content