Package com.esprow.oapi.repository

Interface OapiCategory

All Superinterfaces:

OapiBaseEntity

public interface OapiCategory
extends OapiBaseEntity

An element associating other elements to business areas.

The following attributes and references are supported:

• Annotation
• Component Type
• FIXML File Name
• Include File
• Name
• Section

Method Summary

Modifier and Type	Method	Description
OapiAnnotation	getAnnotation()	Returns all metadata on an element (documentation etc.).
CatComponentType	getComponentType()	Returns a type of the category components.
String	getFIXMLFileName()	Returns a FIXML category filename.
CatIncludeFile	getIncludeFile()	Returns a type of an included file.
String	getName()	Returns the name of the category.
String	getSection()	Returns an element containing multiple categories.
void	setAnnotation(OapiAnnotation value)	Set all metadata on an element (documentation etc.).
void	setComponentType(CatComponentType value)	Set a type of the category components.
void	setFIXMLFileName(String value)	Set a FIXML category filename.
void	setIncludeFile(CatIncludeFile value)	Set a type of an included file.
void	setName(String value)	Set the name of the category.
void	setSection(String value)	Set an element containing multiple categories.

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

getAnnotation

OapiAnnotation getAnnotation()

Returns all metadata on an element (documentation etc.).

Returns:

all metadata on an element (documentation etc.)

See Also:

• setAnnotation(OapiAnnotation)

setAnnotation

void setAnnotation(OapiAnnotation value)

Set all metadata on an element (documentation etc.).

Parameters:

value - the new value of the 'Annotation' containment reference.

See Also:

• getAnnotation()

getComponentType

CatComponentType getComponentType()

Returns a type of the category components. The literals are from the enumeration CatComponentType.

Returns:

a type of the category components

See Also:

• CatComponentType
• setComponentType(CatComponentType)

setComponentType

void setComponentType(CatComponentType value)

Set a type of the category components.

Parameters:

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

See Also:

• CatComponentType
• getComponentType()

getFIXMLFileName

String getFIXMLFileName()

Returns a FIXML category filename.

Returns:

a FIXML category filename

See Also:

• setFIXMLFileName(String)

setFIXMLFileName

void setFIXMLFileName(String value)

Set a FIXML category filename.

Parameters:

value - the new value of the 'FIXML File Name' attribute.

See Also:

• getFIXMLFileName()

getIncludeFile

CatIncludeFile getIncludeFile()

Returns a type of an included file. The literals are from the enumeration CatIncludeFile.

Returns:

a type of an included file

See Also:

• CatIncludeFile
• setIncludeFile(CatIncludeFile)

setIncludeFile

void setIncludeFile(CatIncludeFile value)

Set a type of an included file.

Parameters:

value - the new value of the 'Include File' attribute.

See Also:

• CatIncludeFile
• getIncludeFile()

getName

String getName()

Returns the name of the category.

Returns:

the name of the category

See Also:

• setName(String)

setName

void setName(String value)

Set the name of the category.

Parameters:

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

See Also:

• getName()

getSection

String getSection()

Returns an element containing multiple categories.

Returns:

an element containing multiple categories

See Also:

• setSection(String)

setSection

void setSection(String value)

Set an element containing multiple categories.

Parameters:

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

See Also:

• getSection()