Package org.odpi.openmetadata.accessservices.digitalarchitecture.api

Interface ManageTemplates

All Known Implementing Classes:

TemplateManager

public interface ManageTemplates

The ManageTemplates is used to create and maintain templates.

Method Summary

Modifier and Type	Method	Description
void	addTemplateClassification(String userId, String elementGUID, TemplateClassificationProperties properties, Map<String,List<Map<String,String>>> specification)	Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
List<TemplateElement>	findTemplates(String userId, String searchString, String typeName, Date effectiveTime, int startFrom, int pageSize)	Find templates with the requested RegEx in the string properties of the template properties.
List<TemplateElement>	getTemplatesByName(String userId, String name, String typeName, Date effectiveTime, int startFrom, int pageSize)	Return the templates with the requested name.
List<TemplateElement>	getTemplatesForType(String userId, String typeName, Date effectiveTime, int startFrom, int pageSize)	Return a list of templates for a particular open metadata type of element.
void	removeTemplateClassification(String userId, String elementGUID)	Remove the classification that indicates that this asset can be used as a template.

Method Details

addTemplateClassification

void addTemplateClassification(String userId,
 String elementGUID,
 TemplateClassificationProperties properties,
 Map<String,List<Map<String,String>>> specification)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.

Parameters:

userId - calling user

elementGUID - unique identifier of the element to classify as a template

properties - properties of the template

specification - values required to use the template

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeTemplateClassification

void removeTemplateClassification(String userId,
 String elementGUID)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the classification that indicates that this asset can be used as a template.

Parameters:

userId - calling user

elementGUID - unique identifier of the element to declassify

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getTemplatesForType

List<TemplateElement> getTemplatesForType(String userId,
 String typeName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return a list of templates for a particular open metadata type of element.

Parameters:

userId - calling user

typeName - type name to query

effectiveTime - optional effective time

startFrom - starting element

pageSize - maximum number of elements

Returns:

list of templates

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

findTemplates

List<TemplateElement> findTemplates(String userId,
 String searchString,
 String typeName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Find templates with the requested RegEx in the string properties of the template properties.

Parameters:

userId - calling user

searchString - string to search for (regEx)

typeName - type name to query (if null, any type is returned)

effectiveTime - optional effective time

startFrom - starting element

pageSize - maximum number of elements

Returns:

list of templates

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getTemplatesByName

List<TemplateElement> getTemplatesByName(String userId,
 String name,
 String typeName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the templates with the requested name.

Parameters:

userId - calling user

name - name to search for

typeName - type name to query (if null, any type is returned)

effectiveTime - optional effective time

startFrom - starting element

pageSize - maximum number of elements

Returns:

list of templates

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem