Package com.esprow.oapi.repository
Interface OapiDatatype
public interface OapiDatatype
A context-free value space, i.e. a domain of possible values relatively free of business semantics.
The following attributes and references are supported:
-
Method Summary
Modifier and TypeMethodDescriptiongetAdded()
Returns the protocol version where the element was added.Returns the extension pack number where the element was added.Returns all metadata on an element (documentation etc.).Returns an attribute indicating the type from which the properties are inherited.Returns a type of the change on the element.Returns the protocol version where the element became deprecated.Returns the extension pack number where the element became deprecated.getIssue()
Returns the issue associated with the element.Returns the protocol version where the element was modified for the last time.Returns a list of mappings to the standard type system datatypes.getName()
Returns a unique name of a datatype.Returns the protocol version where the element became replaced.Returns the ID of the field replacing the element.Returns the extension pack number where the element became replaced.Returns a support level of the element.Returns the protocol version where the element was updated.Returns the extension pack number where the element was updated.void
Set the protocol version where the element was added.void
setAddedEP
(BigInteger value) Set the extension pack number where the element was added.void
setAnnotation
(OapiAnnotation value) Set all metadata on an element (documentation etc.).void
setBaseType
(String value) Set an attribute indicating the type from which the properties are inherited.void
setChangeType
(ChangeType value) Set a type of the change on the element.void
setDeprecated
(String value) Set the protocol version where the element became deprecated.void
setDeprecatedEP
(BigInteger value) Set the extension pack number where the element became deprecated.void
Set the issue associated with the element.void
setLastModified
(String value) Set the protocol version where the element was modified for the last time.void
Set a unique name of a datatype.void
setReplaced
(String value) Set the protocol version where the element became replaced.void
setReplacedByField
(BigInteger value) Set the ID of the field replacing the element.void
setReplacedEP
(BigInteger value) Set the extension pack number where the element became replaced.void
setSupported
(Support value) Set a support level of the element.void
setUpdated
(String value) Set the protocol version where the element was updated.void
setUpdatedEP
(BigInteger value) Set the extension pack number where the element was updated.
-
Method Details
-
getMappedDatatypes
List<OapiMappedDatatype> getMappedDatatypes()Returns a list of mappings to the standard type system datatypes.- Returns:
- a list of mappings to the standard type system datatypes
-
getAnnotation
OapiAnnotation getAnnotation()Returns all metadata on an element (documentation etc.).- Returns:
- all metadata on an element (documentation etc.)
- See Also:
-
setAnnotation
Set all metadata on an element (documentation etc.).- Parameters:
value
- the new value of the 'Annotation' containment reference.- See Also:
-
getAdded
String getAdded()Returns the protocol version where the element was added.- Returns:
- the protocol version where the element was added
- See Also:
-
setAdded
Set the protocol version where the element was added.- Parameters:
value
- the new value of the 'Added' attribute.- See Also:
-
getAddedEP
BigInteger getAddedEP()Returns the extension pack number where the element was added.- Returns:
- the extension pack number where the element was added
- See Also:
-
setAddedEP
Set the extension pack number where the element was added.- Parameters:
value
- the new value of the 'Added EP' attribute.- See Also:
-
getBaseType
String getBaseType()Returns an attribute indicating the type from which the properties are inherited.- Returns:
- an attribute indicating the type from which the properties are inherited
- See Also:
-
setBaseType
Set an attribute indicating the type from which the properties are inherited.- Parameters:
value
- the new value of the 'Base Type' attribute.- See Also:
-
getChangeType
ChangeType getChangeType()Returns a type of the change on the element. The literals are from the enumerationChangeType
.- Returns:
- a type of the change on the element
- See Also:
-
setChangeType
Set a type of the change on the element.- Parameters:
value
- the new value of the 'Change Type' attribute.- See Also:
-
getDeprecated
String getDeprecated()Returns the protocol version where the element became deprecated.- Returns:
- the protocol version where the element became deprecated
- See Also:
-
setDeprecated
Set the protocol version where the element became deprecated.- Parameters:
value
- the new value of the 'Deprecated' attribute.- See Also:
-
getDeprecatedEP
BigInteger getDeprecatedEP()Returns the extension pack number where the element became deprecated.- Returns:
- the extension pack number where the element became deprecated
- See Also:
-
setDeprecatedEP
Set the extension pack number where the element became deprecated.- Parameters:
value
- the new value of the 'Deprecated EP' attribute.- See Also:
-
getIssue
String getIssue()Returns the issue associated with the element.- Returns:
- the issue associated with the element
- See Also:
-
setIssue
Set the issue associated with the element.- Parameters:
value
- the new value of the 'Issue' attribute.- See Also:
-
getLastModified
String getLastModified()Returns the protocol version where the element was modified for the last time.- Returns:
- the protocol version where the element was modified for the last time
- See Also:
-
setLastModified
Set the protocol version where the element was modified for the last time.- Parameters:
value
- the new value of the 'Last Modified' attribute.- See Also:
-
getName
String getName()Returns a unique name of a datatype.- Returns:
- a unique name of a datatype
- See Also:
-
setName
Set a unique name of a datatype.- Parameters:
value
- the new value of the 'Name' attribute.- See Also:
-
getReplaced
String getReplaced()Returns the protocol version where the element became replaced.- Returns:
- the protocol version where the element became replaced
- See Also:
-
setReplaced
Set the protocol version where the element became replaced.- Parameters:
value
- the new value of the 'Replaced' attribute.- See Also:
-
getReplacedByField
BigInteger getReplacedByField()Returns the ID of the field replacing the element.- Returns:
- the ID of the field replacing the element
- See Also:
-
setReplacedByField
Set the ID of the field replacing the element.- Parameters:
value
- the new value of the 'Replaced By Field' attribute.- See Also:
-
getReplacedEP
BigInteger getReplacedEP()Returns the extension pack number where the element became replaced.- Returns:
- the extension pack number where the element became replaced
- See Also:
-
setReplacedEP
Set the extension pack number where the element became replaced.- Parameters:
value
- the new value of the 'Replaced EP' attribute.- See Also:
-
getSupported
Support getSupported()Returns a support level of the element. The default value is"supported"
. The literals are from the enumerationSupport
.- Returns:
- a support level of the element
- See Also:
-
setSupported
Set a support level of the element.- Parameters:
value
- the new value of the 'Supported' attribute.- See Also:
-
getUpdated
String getUpdated()Returns the protocol version where the element was updated.- Returns:
- the protocol version where the element was updated
- See Also:
-
setUpdated
Set the protocol version where the element was updated.- Parameters:
value
- the new value of the 'Updated' attribute.- See Also:
-
getUpdatedEP
BigInteger getUpdatedEP()Returns the extension pack number where the element was updated.- Returns:
- the extension pack number where the element was updated
- See Also:
-
setUpdatedEP
Set the extension pack number where the element was updated.- Parameters:
value
- the new value of the 'Updated EP' attribute.- See Also:
-