Package org.odpi.openmetadata.accessservices.datamanager.api

Interface DisplayApplicationInterface

public interface DisplayApplicationInterface

ApplicationInterface defines the client side interface for the Data Manager OMAS that is relevant for form assets that provide data displays and other business functions to an organization. It provides the ability to define and maintain the metadata about forms, reports and queries and the schemas (data containers and data fields) they contain.

Method Summary

Modifier and Type	Method	Description
String	createDataContainer(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String parentElementGUID, DataContainerProperties dataContainerProperties)	Create a new metadata element to represent a data container.
String	createDataContainerFromTemplate(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String parentElementGUID, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a data container using an existing metadata element as a template.
String	createDataField(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String parentElementGUID, DataFieldProperties properties)	Create a new metadata element to represent an data field.
String	createDataFieldFromTemplate(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String templateGUID, String parentElementGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a an data field using an existing data field as a template.
String	createForm(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, FormProperties formProperties)	Create a new metadata element to represent a form.
String	createFormFromTemplate(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a form using an existing metadata element as a template.
String	createQuery(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, QueryProperties queryProperties)	Create a new metadata element to represent a query.
String	createQueryFromTemplate(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a query using an existing metadata element as a template.
String	createReport(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, ReportProperties reportProperties)	Create a new metadata element to represent a report.
String	createReportFromTemplate(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a report using an existing metadata element as a template.
List<DataContainerElement>	findDataContainers(String userId, String searchString, String typeName, int startFrom, int pageSize)	Retrieve the list of data container metadata elements that contain the search string.
List<DataFieldElement>	findDataFields(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of data fields metadata elements that contain the search string.
List<FormElement>	findForms(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of form metadata elements that contain the search string.
List<QueryElement>	findQueries(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of query metadata elements that contain the search string.
List<ReportElement>	findReports(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of report metadata elements that contain the search string.
List<DataFieldElement>	getChildDataFields(String userId, String parentElementGUID, int startFrom, int pageSize)	Return the list of data fields associated with a parent element (application asset or data container or data field with a complex type).
DataContainerElement	getDataContainerByGUID(String userId, String dataContainerGUID)	Retrieve the data container metadata element with the supplied unique identifier.
List<DataContainerElement>	getDataContainerByName(String userId, String name, String typeName, int startFrom, int pageSize)	Retrieve the list of data container metadata elements with a matching qualified or display name.
ElementStub	getDataContainerParent(String userId, String dataContainerGUID)	Retrieve the header of the metadata element connected to a data container.
List<DataContainerElement>	getDataContainersForElement(String userId, String parentElementGUID, int startFrom, int pageSize)	Return the data container associated with a specific open metadata element (data asset, process or port).
DataFieldElement	getDataFieldByGUID(String userId, String guid)	Retrieve the data field metadata element with the supplied unique identifier.
List<DataFieldElement>	getDataFieldsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of data fields metadata elements with a matching qualified or display name.
FormElement	getFormByGUID(String userId, String guid)	Retrieve the form metadata element with the supplied unique identifier.
List<FormElement>	getFormsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of form metadata elements with a matching qualified or display name.
List<FormElement>	getFormsForApplication(String userId, String applicationGUID, String applicationName, int startFrom, int pageSize)	Retrieve the list of forms created by this caller.
List<QueryElement>	getQueriesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of query metadata elements with a matching qualified or display name.
List<QueryElement>	getQueriesForApplication(String userId, String applicationGUID, String applicationName, int startFrom, int pageSize)	Retrieve the list of querys created by this caller.
QueryElement	getQueryByGUID(String userId, String guid)	Retrieve the query metadata element with the supplied unique identifier.
ReportElement	getReportByGUID(String userId, String guid)	Retrieve the report metadata element with the supplied unique identifier.
List<ReportElement>	getReportsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of report metadata elements with a matching qualified or display name.
List<ReportElement>	getReportsForApplication(String userId, String applicationGUID, String applicationName, int startFrom, int pageSize)	Retrieve the list of reports created by this caller.
void	publishForm(String userId, String formGUID)	Update the zones for the form asset so that it becomes visible to consumers.
void	publishQuery(String userId, String queryGUID)	Update the zones for the query asset so that it becomes visible to consumers.
void	publishReport(String userId, String reportGUID)	Update the zones for the report asset so that it becomes visible to consumers.
void	removeDataContainer(String userId, String applicationGUID, String applicationName, String dataContainerGUID)	Remove the metadata element representing a data container.
void	removeDataField(String userId, String applicationGUID, String applicationName, String dataFieldGUID)	Remove an data field.
void	removeForm(String userId, String applicationGUID, String applicationName, String formGUID, String qualifiedName)	Remove the metadata element representing a form.
void	removeQuery(String userId, String applicationGUID, String applicationName, String queryGUID, String qualifiedName)	Remove the metadata element representing a query.
void	removeReport(String userId, String applicationGUID, String applicationName, String reportGUID, String qualifiedName)	Remove the metadata element representing a report.
void	setupSchemaType(String userId, String applicationGUID, String applicationName, boolean applicationIsHome, String relationshipTypeName, String apiParameterGUID, String schemaTypeGUID)	Connect a schema type to a data field.
void	updateDataContainer(String userId, String applicationGUID, String applicationName, String dataContainerGUID, boolean isMergeUpdate, DataContainerProperties dataContainerProperties)	Update the metadata element representing a data container.
void	updateDataField(String userId, String applicationGUID, String applicationName, String dataFieldGUID, boolean isMergeUpdate, DataFieldProperties properties)	Update the metadata element representing an data field.
void	updateForm(String userId, String applicationGUID, String applicationName, String formGUID, boolean isMergeUpdate, FormProperties formProperties)	Update the metadata element representing a form.
void	updateQuery(String userId, String applicationGUID, String applicationName, String queryGUID, boolean isMergeUpdate, QueryProperties queryProperties)	Update the metadata element representing a query.
void	updateReport(String userId, String applicationGUID, String applicationName, String reportGUID, boolean isMergeUpdate, ReportProperties reportProperties)	Update the metadata element representing a report.
void	withdrawForm(String userId, String formGUID)	Update the zones for the form asset so that it is no longer visible to consumers.
void	withdrawQuery(String userId, String queryGUID)	Update the zones for the query asset so that it is no longer visible to consumers.
void	withdrawReport(String userId, String reportGUID)	Update the zones for the report asset so that it is no longer visible to consumers.

Method Detail

createForm

String createForm(String userId,
                  String applicationGUID,
                  String applicationName,
                  boolean applicationIsHome,
                  FormProperties formProperties)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException

Create a new metadata element to represent a form.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the form be marked as owned by the event broker so others can not update?

formProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createFormFromTemplate

String createFormFromTemplate(String userId,
                              String applicationGUID,
                              String applicationName,
                              boolean applicationIsHome,
                              String templateGUID,
                              TemplateProperties templateProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Create a new metadata element to represent a form using an existing metadata element as a template.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the form be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateForm

void updateForm(String userId,
                String applicationGUID,
                String applicationName,
                String formGUID,
                boolean isMergeUpdate,
                FormProperties formProperties)
         throws InvalidParameterException,
                UserNotAuthorizedException,
                PropertyServerException

Update the metadata element representing a form.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

formGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

formProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishForm

void publishForm(String userId,
                 String formGUID)
          throws InvalidParameterException,
                 UserNotAuthorizedException,
                 PropertyServerException

Update the zones for the form asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).

Parameters:

userId - calling user

formGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawForm

void withdrawForm(String userId,
                  String formGUID)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException

Update the zones for the form asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the form is first created).

Parameters:

userId - calling user

formGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeForm

void removeForm(String userId,
                String applicationGUID,
                String applicationName,
                String formGUID,
                String qualifiedName)
         throws InvalidParameterException,
                UserNotAuthorizedException,
                PropertyServerException

Remove the metadata element representing a form.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

formGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findForms

List<FormElement> findForms(String userId,
                            String searchString,
                            int startFrom,
                            int pageSize)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Retrieve the list of form metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getFormsByName

List<FormElement> getFormsByName(String userId,
                                 String name,
                                 int startFrom,
                                 int pageSize)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Retrieve the list of form metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getFormsForApplication

List<FormElement> getFormsForApplication(String userId,
                                         String applicationGUID,
                                         String applicationName,
                                         int startFrom,
                                         int pageSize)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Retrieve the list of forms created by this caller.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the form manager (event broker)

applicationName - unique name of software server capability representing the form manager (event broker)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getFormByGUID

FormElement getFormByGUID(String userId,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Retrieve the form metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createReport

String createReport(String userId,
                    String applicationGUID,
                    String applicationName,
                    boolean applicationIsHome,
                    ReportProperties reportProperties)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

Create a new metadata element to represent a report.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the report be marked as owned by the event broker so others can not update?

reportProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createReportFromTemplate

String createReportFromTemplate(String userId,
                                String applicationGUID,
                                String applicationName,
                                boolean applicationIsHome,
                                String templateGUID,
                                TemplateProperties templateProperties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create a new metadata element to represent a report using an existing metadata element as a template.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the report be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateReport

void updateReport(String userId,
                  String applicationGUID,
                  String applicationName,
                  String reportGUID,
                  boolean isMergeUpdate,
                  ReportProperties reportProperties)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException

Update the metadata element representing a report.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

reportGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

reportProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishReport

void publishReport(String userId,
                   String reportGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException

Update the zones for the report asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).

Parameters:

userId - calling user

reportGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawReport

void withdrawReport(String userId,
                    String reportGUID)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

Update the zones for the report asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the report is first created).

Parameters:

userId - calling user

reportGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeReport

void removeReport(String userId,
                  String applicationGUID,
                  String applicationName,
                  String reportGUID,
                  String qualifiedName)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException

Remove the metadata element representing a report.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

reportGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findReports

List<ReportElement> findReports(String userId,
                                String searchString,
                                int startFrom,
                                int pageSize)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Retrieve the list of report metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getReportsByName

List<ReportElement> getReportsByName(String userId,
                                     String name,
                                     int startFrom,
                                     int pageSize)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Retrieve the list of report metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getReportsForApplication

List<ReportElement> getReportsForApplication(String userId,
                                             String applicationGUID,
                                             String applicationName,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Retrieve the list of reports created by this caller.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the report manager (event broker)

applicationName - unique name of software server capability representing the report manager (event broker)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getReportByGUID

ReportElement getReportByGUID(String userId,
                              String guid)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Retrieve the report metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createQuery

String createQuery(String userId,
                   String applicationGUID,
                   String applicationName,
                   boolean applicationIsHome,
                   QueryProperties queryProperties)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException

Create a new metadata element to represent a query.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

queryProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createQueryFromTemplate

String createQueryFromTemplate(String userId,
                               String applicationGUID,
                               String applicationName,
                               boolean applicationIsHome,
                               String templateGUID,
                               TemplateProperties templateProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a new metadata element to represent a query using an existing metadata element as a template.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateQuery

void updateQuery(String userId,
                 String applicationGUID,
                 String applicationName,
                 String queryGUID,
                 boolean isMergeUpdate,
                 QueryProperties queryProperties)
          throws InvalidParameterException,
                 UserNotAuthorizedException,
                 PropertyServerException

Update the metadata element representing a query.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

queryGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

queryProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishQuery

void publishQuery(String userId,
                  String queryGUID)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException

Update the zones for the query asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).

Parameters:

userId - calling user

queryGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawQuery

void withdrawQuery(String userId,
                   String queryGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException

Update the zones for the query asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the query is first created).

Parameters:

userId - calling user

queryGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeQuery

void removeQuery(String userId,
                 String applicationGUID,
                 String applicationName,
                 String queryGUID,
                 String qualifiedName)
          throws InvalidParameterException,
                 UserNotAuthorizedException,
                 PropertyServerException

Remove the metadata element representing a query.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

queryGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findQueries

List<QueryElement> findQueries(String userId,
                               String searchString,
                               int startFrom,
                               int pageSize)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Retrieve the list of query metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getQueriesByName

List<QueryElement> getQueriesByName(String userId,
                                    String name,
                                    int startFrom,
                                    int pageSize)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the list of query metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getQueriesForApplication

List<QueryElement> getQueriesForApplication(String userId,
                                            String applicationGUID,
                                            String applicationName,
                                            int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve the list of querys created by this caller.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the query manager (event broker)

applicationName - unique name of software server capability representing the query manager (event broker)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getQueryByGUID

QueryElement getQueryByGUID(String userId,
                            String guid)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Retrieve the query metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataContainer

String createDataContainer(String userId,
                           String applicationGUID,
                           String applicationName,
                           boolean applicationIsHome,
                           String parentElementGUID,
                           DataContainerProperties dataContainerProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Create a new metadata element to represent a data container.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

parentElementGUID - element to link the data container to

dataContainerProperties - properties about the data container to store

Returns:

unique identifier of the new data container

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataContainerFromTemplate

String createDataContainerFromTemplate(String userId,
                                       String applicationGUID,
                                       String applicationName,
                                       boolean applicationIsHome,
                                       String parentElementGUID,
                                       String templateGUID,
                                       TemplateProperties templateProperties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create a new metadata element to represent a data container using an existing metadata element as a template.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

parentElementGUID - element to link the data container to

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new data container

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDataContainer

void updateDataContainer(String userId,
                         String applicationGUID,
                         String applicationName,
                         String dataContainerGUID,
                         boolean isMergeUpdate,
                         DataContainerProperties dataContainerProperties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Update the metadata element representing a data container. It is possible to use the subtype property classes or set up specialized properties in extended properties.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

dataContainerGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

dataContainerProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDataContainer

void removeDataContainer(String userId,
                         String applicationGUID,
                         String applicationName,
                         String dataContainerGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Remove the metadata element representing a data container.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

dataContainerGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDataContainers

List<DataContainerElement> findDataContainers(String userId,
                                              String searchString,
                                              String typeName,
                                              int startFrom,
                                              int pageSize)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the list of data container metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

typeName - optional type name for the data container - used to restrict the search results

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainersForElement

List<DataContainerElement> getDataContainersForElement(String userId,
                                                       String parentElementGUID,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Return the data container associated with a specific open metadata element (data asset, process or port).

Parameters:

userId - calling user

parentElementGUID - unique identifier of the open metadata element that this data container is connected to

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

metadata element describing the data container associated with the requested parent element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainerByName

List<DataContainerElement> getDataContainerByName(String userId,
                                                  String name,
                                                  String typeName,
                                                  int startFrom,
                                                  int pageSize)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Retrieve the list of data container metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

typeName - optional type name for the data container - used to restrict the search results

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainerByGUID

DataContainerElement getDataContainerByGUID(String userId,
                                            String dataContainerGUID)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve the data container metadata element with the supplied unique identifier.

Parameters:

userId - calling user

dataContainerGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainerParent

ElementStub getDataContainerParent(String userId,
                                   String dataContainerGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Retrieve the header of the metadata element connected to a data container.

Parameters:

userId - calling user

dataContainerGUID - unique identifier of the requested metadata element

Returns:

header for parent element (data asset, process, port)

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataField

String createDataField(String userId,
                       String applicationGUID,
                       String applicationName,
                       boolean applicationIsHome,
                       String parentElementGUID,
                       DataFieldProperties properties)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Create a new metadata element to represent an data field. This describes the structure of an event supported by the form. The structure of this data field is added using SchemaAttributes. These SchemaAttributes can have a simple type or a nested structure.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the data field be marked as owned by the event broker so others can not update?

parentElementGUID - unique identifier of the parent

properties - properties about the form schema

Returns:

unique identifier of the new form schema

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataFieldFromTemplate

String createDataFieldFromTemplate(String userId,
                                   String applicationGUID,
                                   String applicationName,
                                   boolean applicationIsHome,
                                   String templateGUID,
                                   String parentElementGUID,
                                   TemplateProperties templateProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create a new metadata element to represent a an data field using an existing data field as a template.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the data field be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

parentElementGUID - unique identifier of the form where the data field is located

templateProperties - properties that override the template

Returns:

unique identifier of the new data field

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupSchemaType

void setupSchemaType(String userId,
                     String applicationGUID,
                     String applicationName,
                     boolean applicationIsHome,
                     String relationshipTypeName,
                     String apiParameterGUID,
                     String schemaTypeGUID)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Connect a schema type to a data field.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the data field be marked as owned by the event broker so others can not update?

relationshipTypeName - name of relationship to create

apiParameterGUID - unique identifier of the API parameter

schemaTypeGUID - unique identifier of the schema type to connect

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDataField

void updateDataField(String userId,
                     String applicationGUID,
                     String applicationName,
                     String dataFieldGUID,
                     boolean isMergeUpdate,
                     DataFieldProperties properties)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Update the metadata element representing an data field.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

dataFieldGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

properties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDataField

void removeDataField(String userId,
                     String applicationGUID,
                     String applicationName,
                     String dataFieldGUID)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Remove an data field.

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

dataFieldGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDataFields

List<DataFieldElement> findDataFields(String userId,
                                      String searchString,
                                      int startFrom,
                                      int pageSize)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve the list of data fields metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getChildDataFields

List<DataFieldElement> getChildDataFields(String userId,
                                          String parentElementGUID,
                                          int startFrom,
                                          int pageSize)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Return the list of data fields associated with a parent element (application asset or data container or data field with a complex type).

Parameters:

userId - calling user

parentElementGUID - unique identifier of the form to query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of metadata elements describing the data fields associated with the requested form

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataFieldsByName

List<DataFieldElement> getDataFieldsByName(String userId,
                                           String name,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Retrieve the list of data fields metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataFieldByGUID

DataFieldElement getDataFieldByGUID(String userId,
                                    String guid)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the data field metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)