Package com.esprow.oapi.repository
Interface OapiRepository
public interface OapiRepository
The root element of an Orchestra repository XML file.
The following attributes and references are supported:
-
Method Summary
Modifier and TypeMethodDescriptionReturns a list of actors.Returns all metadata on an element (documentation etc.).Returns the application version.Returns a list of categories.Returns a list of codeSets.Returns a list of components.Returns a list of concepts.Returns a list of datatypes.Returns the override language for conditional expressions.Returns a list of fields.Returns a list of groups.getGuid()
Returns a globally unique identifier for the given schema file.Returns a list of messages.Returns the identifier and the issuer of the Orchestra file.getName()
Returns the name of the repository.Returns an associated namespace as URI.Returns a list of sections.Returns a link to the external documentation.Returns the version of the protocol specification.void
setActors
(OapiActors value) Set a list of actors.void
setAnnotation
(OapiAnnotation value) Set all metadata on an element (documentation etc.).void
setApplVerId
(String value) Set the application version.void
setCategories
(OapiCategories value) Set a list of categories.void
setCodeSets
(OapiCodeSets value) Set a list of codeSets.void
setComponents
(OapiComponents value) Set a list of components.void
setConcepts
(OapiConcepts value) Set a list of concepts.void
setDatatypes
(OapiDatatypes value) Set a list of datatypes.void
setExpressionLanguage
(String value) Set the override language for conditional expressions.void
setFields
(OapiFields value) Set a list of fields.void
setGroups
(OapiGroups value) Set a list of groups.void
Set a globally unique identifier for the given schema file.void
setLatestEP
(BigInteger value) Sets the value of the 'Latest EP
' attribute.void
setMessages
(OapiMessages value) Set a list of messages.void
Set the identifier and the issuer of the Orchestra file.void
Set the name of the repository.void
setNamespace
(String value) Set an associated namespace as URI.void
setSections
(OapiSections value) Set a list of sections.void
setSpecUrl
(String value) Set a link to the external documentation.void
setVersion
(String value) Set the version of the protocol specification.
-
Method Details
-
getMetadata
ElementOrRefinementContainer getMetadata()Returns the identifier and the issuer of the Orchestra file.- Returns:
- the identifier and the issuer of the Orchestra file
- See Also:
-
setMetadata
Set the identifier and the issuer of the Orchestra file.- Parameters:
value
- the new value of the 'Metadata' containment reference.- See Also:
-
getCategories
OapiCategories getCategories()Returns a list of categories.- Returns:
- a list of categories
- See Also:
-
setCategories
Set a list of categories.- Parameters:
value
- the new value of the 'Categories' containment reference.- See Also:
-
getSections
OapiSections getSections()Returns a list of sections.- Returns:
- a list of sections
- See Also:
-
setSections
Set a list of sections.- Parameters:
value
- the new value of the 'Sections' containment reference.- See Also:
-
getDatatypes
OapiDatatypes getDatatypes()Returns a list of datatypes.- Returns:
- a list of datatypes
- See Also:
-
setDatatypes
Set a list of datatypes.- Parameters:
value
- the new value of the 'Datatypes' containment reference.- See Also:
-
getCodeSets
OapiCodeSets getCodeSets()Returns a list of codeSets.- Returns:
- a list of codeSets
- See Also:
-
setCodeSets
Set a list of codeSets.- Parameters:
value
- the new value of the 'Code Sets' containment reference.- See Also:
-
getFields
OapiFields getFields()Returns a list of fields.- Returns:
- a list of fields
- See Also:
-
setFields
Set a list of fields.- Parameters:
value
- the new value of the 'Fields' containment reference.- See Also:
-
getActors
OapiActors getActors()Returns a list of actors.- Returns:
- a list of actors
- See Also:
-
setActors
Set a list of actors.- Parameters:
value
- the new value of the 'Actors' containment reference.- See Also:
-
getComponents
OapiComponents getComponents()Returns a list of components.- Returns:
- a list of components
- See Also:
-
setComponents
Set a list of components.- Parameters:
value
- the new value of the 'Components' containment reference.- See Also:
-
getGroups
OapiGroups getGroups()Returns a list of groups.- Returns:
- a list of groups
- See Also:
-
setGroups
Set a list of groups.- Parameters:
value
- the new value of the 'Groups' containment reference.- See Also:
-
getMessages
OapiMessages getMessages()Returns a list of messages.- Returns:
- a list of messages
- See Also:
-
setMessages
Set a list of messages.- Parameters:
value
- the new value of the 'Messages' containment reference.- See Also:
-
getConcepts
OapiConcepts getConcepts()Returns a list of concepts.- Returns:
- a list of concepts
- See Also:
-
setConcepts
Set a list of concepts.- Parameters:
value
- the new value of the 'Concepts' containment reference.- See Also:
-
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:
-
getApplVerId
String getApplVerId()Returns the application version.- Returns:
- the application version
- See Also:
-
setApplVerId
Set the application version.- Parameters:
value
- the new value of the 'Appl Ver Id' attribute.- See Also:
-
getExpressionLanguage
String getExpressionLanguage()Returns the override language for conditional expressions. The default value is"Score"
.- Returns:
- the override language for conditional expressions
- See Also:
-
setExpressionLanguage
Set the override language for conditional expressions.- Parameters:
value
- the new value of the 'Expression Language' attribute.- See Also:
-
getGuid
String getGuid()Returns a globally unique identifier for the given schema file.- Returns:
- a globally unique identifier for the given schema file
- See Also:
-
setGuid
Set a globally unique identifier for the given schema file.- Parameters:
value
- the new value of the 'Guid' attribute.- See Also:
-
getLatestEP
BigInteger getLatestEP()- See Also:
-
setLatestEP
Sets the value of the 'Latest EP
' attribute.- Parameters:
value
- the new value of the 'Latest EP' attribute.- See Also:
-
getName
String getName()Returns the name of the repository.- Returns:
- the name of the repository
- See Also:
-
setName
Set the name of the repository.- Parameters:
value
- the new value of the 'Name' attribute.- See Also:
-
getNamespace
String getNamespace()Returns an associated namespace as URI.- Returns:
- an associated namespace as URI
- See Also:
-
setNamespace
Set an associated namespace as URI.- Parameters:
value
- the new value of the 'Namespace' attribute.- See Also:
-
getSpecUrl
String getSpecUrl()Returns a link to the external documentation.- Returns:
- a link to the external documentation
- See Also:
-
setSpecUrl
Set a link to the external documentation.- Parameters:
value
- the new value of the 'Spec Url' attribute.- See Also:
-
getVersion
String getVersion()Returns the version of the protocol specification.- Returns:
- the version of the protocol specification
- See Also:
-
setVersion
Set the version of the protocol specification.- Parameters:
value
- the new value of the 'Version' attribute.- See Also:
-