Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to OMAS APIs and archive builders for sustainability #6806

Merged
merged 10 commits into from
Aug 18, 2022
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public DatabaseConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -63,7 +63,7 @@ public Database getNewBean(Class<Database> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public GlossaryTermConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -63,7 +63,7 @@ public GlossaryTerm getNewBean(Class<GlossaryTerm> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public Schema getNewBean(Class<Schema> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public AnalyticsMetadata getNewBean(EntityDetail entity, String methodName) thro
}

/**
* Using the supplied entity, return a new instance of the bean. This is used for beans that have
* Using the supplied entity, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public AssetConverter(OMRSRepositoryHelper repositoryHelper, String serviceName,
}

/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public SchemaTypeConverter(OMRSRepositoryHelper repositoryHelper, String service
}

/**
* Using the supplied entity, return a new instance of the bean. This is used for beans that have
* Using the supplied entity, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public SoftwareServerCapabilityConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -66,7 +66,7 @@ public SoftwareServerCapability getNewBean(Class<SoftwareServerCapability> b


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ OMRSMetadataCollection getOMRSMetadataCollection() {
}

/**
* Returns a list containing the type and all of the sub-types of the provided type
* Returns a list containing the type and all the sub-types of the provided type
*
* @param userId user identifier that issues the call
* @param typeDefName the type definition name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ void updateTagDescription(String userId,

/**
* Removes a tag from the repository.
* A private tag can be deleted by its creator and all of the references are lost;
* A private tag can be deleted by its creator and all the references are lost;
* a public tag can be deleted by anyone, but only if it is not attached to any referenceable.
*
* @param userId userId of user making request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

/**
* ElementVersions provides the version information for the element plus details of the creation time and last
* update time. Finally it lists all of the users that have made changes to this element.
* update time. Finally it lists all the users that have made changes to this element.
*/
@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
@JsonInclude(JsonInclude.Include.NON_NULL)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public enum AssetConsumerErrorCode implements ExceptionMessageSet
PROXY_CONNECTION_FOUND(404, "OMAS-ASSET-CONSUMER-404-006",
"Only an entity proxy for requested connection {0} is found in the open metadata server {1}, error message was: {2}",
"The system is unable to populate the requested connection object because the object stored is only a stub from a relationship.",
"Check that the connection name is correct. Check that all of the servers in the cohort are running. Retry the request when the " +
"Check that the connection name is correct. Check that all the servers in the cohort are running. Retry the request when the " +
"connection is available in the cohort."),
ASSET_NOT_FOUND(404, "OMAS-ASSET-CONSUMER-404-007",
"A connected asset is not found for connection {0}",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1310,7 +1310,7 @@ public void updateTagDescription(String userId,

/**
* Removes a tag from the repository.
* A private tag can be deleted by its creator and all of the references are lost;
* A private tag can be deleted by its creator and all the references are lost;
* a public tag can be deleted by anyone, but only if it is not attached to any referenceable.
*
* @param userId userId of user making request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public AssetConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -138,7 +138,7 @@ public B getNewBean(Class<B> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public CommentConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -117,7 +117,7 @@ public B getNewBean(Class<B> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public ElementHeaderConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -79,7 +79,7 @@ public B getNewBean(Class<B> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public InformalTagConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -107,7 +107,7 @@ public B getNewBean(Class<B> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public LikeConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -97,7 +97,7 @@ public B getNewBean(Class<B> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public MeaningConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -108,7 +108,7 @@ public B getNewBean(Class<B> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public RatingConverter(OMRSRepositoryHelper repositoryHelper,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down Expand Up @@ -107,7 +107,7 @@ public B getNewBean(Class<B> beanClass,


/**
* Using the supplied instances, return a new instance of the bean. This is used for beans that have
* Using the supplied instances, return a new instance of the bean. This is used for beans that
* contain a combination of the properties from an entity and that of a connected relationship.
*
* @param beanClass name of the class to create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ public void processUpdatedEntityEvent(String sourceName,
* @param originatorServerName name of the server that the event came from.
* @param originatorServerType type of server that the event came from.
* @param originatorOrganizationName name of the organization that owns the server that sent the event.
* @param entityProxy details of the entityProxy with the new classification added. No guarantee this is all of the classifications.
* @param entityProxy details of the entityProxy with the new classification added. No guarantee this is all the classifications.
* @param classification new classification
*/
@Override
Expand Down Expand Up @@ -184,7 +184,7 @@ public void processClassifiedEntityEvent(String sourceName,
* @param originatorServerName name of the server that the event came from.
* @param originatorServerType type of server that the event came from.
* @param originatorOrganizationName name of the organization that owns the server that sent the event.
* @param entity details of the entity with the new classification added. No guarantee this is all of the classifications.
* @param entity details of the entity with the new classification added. No guarantee this is all the classifications.
* @param classification new classification
*/
@Override
Expand Down Expand Up @@ -261,7 +261,7 @@ public void processClassifiedEntityEvent(String sourceName,
* @param originatorServerName name of the server that the event came from.
* @param originatorServerType type of server that the event came from.
* @param originatorOrganizationName name of the organization that owns the server that sent the event.
* @param entityProxy details of the entityProxy after the classification has been removed. No guarantee this is all of the classifications.
* @param entityProxy details of the entityProxy after the classification has been removed. No guarantee this is all the classifications.
* @param originalClassification classification that was removed
*/
@Override
Expand Down Expand Up @@ -300,7 +300,7 @@ public void processDeclassifiedEntityEvent(String sourceName,
* @param originatorServerName name of the server that the event came from.
* @param originatorServerType type of server that the event came from.
* @param originatorOrganizationName name of the organization that owns the server that sent the event.
* @param entity details of the entity after the classification has been removed. No guarantee this is all of the classifications.
* @param entity details of the entity after the classification has been removed. No guarantee this is all the classifications.
* @param originalClassification classification that was removed
*/
@Override
Expand Down Expand Up @@ -377,7 +377,7 @@ public void processDeclassifiedEntityEvent(String sourceName,
* @param originatorServerName name of the server that the event came from.
* @param originatorServerType type of server that the event came from.
* @param originatorOrganizationName name of the organization that owns the server that sent the event.
* @param entityProxy details of the entityProxy after the classification has been changed. No guarantee this is all of the classifications.
* @param entityProxy details of the entityProxy after the classification has been changed. No guarantee this is all the classifications.
* @param originalClassification classification that was removed
* @param classification new classification
*/
Expand Down Expand Up @@ -418,7 +418,7 @@ public void processReclassifiedEntityEvent(String sourceName,
* @param originatorServerName name of the server that the event came from.
* @param originatorServerType type of server that the event came from.
* @param originatorOrganizationName name of the organization that owns the server that sent the event.
* @param entity details of the entity after the classification has been changed. No guarantee this is all of the classifications.
* @param entity details of the entity after the classification has been changed. No guarantee this is all the classifications.
* @param originalClassification classification that was removed
* @param classification new classification
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ public GUIDResponse createTag(@PathVariable String serverName,


/**
* Removes a tag from the repository. All of the relationships to referenceables are lost.
* Removes a tag from the repository. all the relationships to referenceables are lost.
*
* @param serverName name of the server instances for this request
* @param userId String - userId of user making request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
/**
* AssetManagerOutTopicEvent provides the structure of the Asset Manager OMAS's OutTopic events. The values for elements and their classifications
* come from the events. They are not guaranteed to be current. If the latest values are required, the element should be queried from the repository
* using its GUID. The event values are useful if the third party catalog needs to maintain an exact record of all of the versions.
* using its GUID. The event values are useful if the third party catalog needs to maintain an exact record of all the versions.
*/
@JsonAutoDetect(getterVisibility = PUBLIC_ONLY, setterVisibility = PUBLIC_ONLY, fieldVisibility = NONE)
@JsonInclude(JsonInclude.Include.NON_NULL)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

/**
* ElementVersions provides the version information for the element plus details of the creation time and last
* update time. Finally it lists all of the users that have made changes to this element.
* update time. Finally it lists all the users that have made changes to this element.
*/
@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
@JsonInclude(JsonInclude.Include.NON_NULL)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/**
* ValidValuesExchangeClient provides the API operations to create and maintain lists of valid
* value definitions grouped into a valid value set. Both valid value definitions and valid value sets have
* the same attributes and so inherit from ValidValue where all of the attributes are defined.
* the same attributes and so inherit from ValidValue where all the attributes are defined.
*
* A set is just grouping of valid values. Valid value definitions and set can be nested many times in other
* valid value sets.
Expand Down
Loading