oracle.jbo.service.helper
Interface SDOAnnotationProvider

All Known Implementing Classes:

PDefSDOViewBuilderSrcImpl, SDOViewBuilderSrcImpl

public interface SDOAnnotationProvider

Since:

12.1.1.0.0

Nested Class Summary

static class

SDOAnnotationProvider.Category

Method Summary

java.lang.String	getAttributeDescription(java.lang.String attrName) Gets the description of the SDO attribute.
java.util.List<java.lang.String>	getAttributeNames() Gets the list of child attribute names contained in the SDO.
java.util.List<java.lang.String>	getCategoryValues(SDOAnnotationProvider.Category category) Gets the list of category values assigned to the SDO.
java.lang.String	getDescription() Gets the description of the SDO.
java.lang.String	getDisplayName() Gets the external (display) name of the SDO.
java.util.List<java.lang.String[]>	getDocumentation() Gets the list of documentation (and their resource locations) for the SDO.
java.util.List<java.lang.String>	getKeywords() Gets the keywords for the SDO.
java.util.List<java.lang.String[]>	getRelationships() Gets the list of relationships (name and type) from the SDO.

Method Detail

getDisplayName

java.lang.String getDisplayName()

Gets the external (display) name of the SDO.

Returns:

name of the SDO.

getDescription

java.lang.String getDescription()

Gets the description of the SDO.

Returns:

description of the SDO.

getKeywords

java.util.List<java.lang.String> getKeywords()

Gets the keywords for the SDO.

Returns:

keywords for the SDO.

getCategoryValues

java.util.List<java.lang.String> getCategoryValues(SDOAnnotationProvider.Category category)

Gets the list of category values assigned to the SDO.

Parameters:

category - category for the SDO

Returns:

list of category values assigned to the SDO.

getDocumentation

java.util.List<java.lang.String[]> getDocumentation()

Gets the list of documentation (and their resource locations) for the SDO.

Returns:

links to documentation relevant for the SDO.

getRelationships

java.util.List<java.lang.String[]> getRelationships()

Gets the list of relationships (name and type) from the SDO.

Returns:

list of relationships from the SDO.

getAttributeNames

java.util.List<java.lang.String> getAttributeNames()

Gets the list of child attribute names contained in the SDO.

Returns:

the list of attribute names for the SDO.

getAttributeDescription

java.lang.String getAttributeDescription(java.lang.String attrName)

Gets the description of the SDO attribute.

Parameters:

attrName - name of the SDO attribute

Returns:

description of the SDO attribute.