Package org.odpi.openmetadata.commonservices.generichandlers

Class ProjectBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

org.odpi.openmetadata.commonservices.generichandlers.ProjectBuilder

public class ProjectBuilder
extends ReferenceableBuilder

ProjectBuilder creates the parts for an entity that represents a Project.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

qualifiedName

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

errorHandler, existingClassifications, extendedProperties, instanceStatus, newClassifications, repositoryHelper, serverName, serviceName, templateProperties, typeGUID, typeName

Constructor Summary

Constructors

Constructor	Description
ProjectBuilder(String qualifiedName, String identifier, String name, String description, Date startDate, Date plannedEndDate, String projectPhase, String projectHealth, String projectStatus, int priority, Map<String,String> additionalProperties, String typeGUID, String typeName, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Create constructor
ProjectBuilder(String qualifiedName, String identifier, String name, String description, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Create constructor

Method Summary

Modifier and Type	Method	Description
InstanceProperties	getInstanceProperties(String methodName)	Return the supplied bean properties in an InstanceProperties object.
void	setCampaignClassification(String userId, String methodName)	Set up the Campaign classification for this project.
void	setProjectTypeClassification(String userId, String classificationName, String methodName)	Set up the Task classification for this project.
void	setTaskClassification(String userId, String methodName)	Set up the Task classification for this project.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

getMementoProperties, getQualifiedName, setMemento, setOwnershipClassification, setSecurityTags, setTemplate

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

getEntityClassifications, getInstanceProperties, getInstanceStatus, getTypeGUID, getTypeName, isClassificationSet, setAnchors, setClassification, setEffectivityDates, setEffectivityDates, setTemplateClassifications, setTemplateSubstitute, updateInstanceProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProjectBuilder

public ProjectBuilder(String qualifiedName,
 String identifier,
 String name,
 String description,
 Date startDate,
 Date plannedEndDate,
 String projectPhase,
 String projectHealth,
 String projectStatus,
 int priority,
 Map<String,String> additionalProperties,
 String typeGUID,
 String typeName,
 Map<String,Object> extendedProperties,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String serverName)

Create constructor

Parameters:

qualifiedName - unique name for the Project

identifier - unique identifier for the Project - typically allocated by an external system

name - name for the project

description - description of the glossary

startDate - start date of the project

plannedEndDate - planned end Date for the project

projectPhase - lifecycle phase of project

projectHealth - how well is the project tracking to plan

projectStatus - status of the project

priority - priority

additionalProperties - additional properties for a Project

typeGUID - unique identifier of this element's type

typeName - unique name of this element's type

extendedProperties - properties for a Project subtype

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ProjectBuilder

public ProjectBuilder(String qualifiedName,
 String identifier,
 String name,
 String description,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String serverName)

Create constructor

Parameters:

qualifiedName - unique name for the Project

identifier - unique identifier for the Project - typically allocated by an external system

name - name for the project

description - description of the glossary

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Details

setCampaignClassification

public void setCampaignClassification(String userId,
 String methodName)
                               throws InvalidParameterException

Set up the Campaign classification for this project.

Parameters:

userId - calling user

methodName - calling method

Throws:

InvalidParameterException - classification is not supported in the local repository, or any repository connected by an open metadata repository cohort

setTaskClassification

public void setTaskClassification(String userId,
 String methodName)
                           throws InvalidParameterException

Set up the Task classification for this project.

Parameters:

userId - calling user

methodName - calling method

Throws:

InvalidParameterException - classification is not supported in the local repository, or any repository connected by an open metadata repository cohort

setProjectTypeClassification

public void setProjectTypeClassification(String userId,
 String classificationName,
 String methodName)
                                  throws InvalidParameterException

Set up the Task classification for this project.

Parameters:

userId - calling user

classificationName - name of the classification to add

methodName - calling method

Throws:

InvalidParameterException - classification is not supported in the local repository, or any repository connected by an open metadata repository cohort

getInstanceProperties

public InstanceProperties getInstanceProperties(String methodName)
                                         throws InvalidParameterException

Return the supplied bean properties in an InstanceProperties object.

Overrides:

getInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

Throws:

InvalidParameterException - there is a problem with the properties