Blueprint (Oracle? Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.blueprint.Blueprint

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.Versioned
```
public class Blueprint
extends Object
implements oracle.fmwplatform.envspec.common.Versioned
```
A Blueprint is a description of the set of ‘Domain Templates’ needed to create a Domain.

Since:

12.2.1

Constructor Summary

Constructors
Constructor and Description

Blueprint()

Constructors
Constructor and Description
`Blueprint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAllExternalServices(List<String> externalServices)` Adds a list of ResourceGroupTarget strings to the list of ResourceGroupTargets in this ResourceGroup
`boolean`	`addBlueprint(Blueprint blueprint)` Adds a Blueprint to the list of Blueprints in this Blueprint.
`boolean`	`addBlueprint(String blueprintName)` Adds a Blueprint to the list of Blueprints in this Blueprint identified by the blueprintName.
`boolean`	`addBlueprint(String blueprintName, String version, EnvironmentModelFileLocator locator)` Adds a Blueprint to the list of Blueprints in this Blueprint identified by the blueprintName.
`boolean`	`addExternalService(String externalService)` Adds a single external service to the list of external services for this Blueprint
`List<Blueprint>`	`getBlueprints()` Gets the list of Blueprints available in this Blueprint.
`List<String>`	`getExternalServices()` Returns the list of external services in this Blueprint.
`String`	`getFMWVersionRange()` Returns the range of FMW releases that this model object is supported under.
`String`	`getName()` Returns the name.
`String`	`getSchemaVersion()` Returns the version of the EnvSpec (XML) schema that applies to this model.
`List<Template>`	`getTemplates()` Returns the list of Templates in this Blueprint.
`String`	`getVersion()` Returns the consumer specified version of the this model file.
`Blueprint`	`setBlueprints(List<Blueprint> blueprints)` Sets the list of Blueprints in this Blueprint.
`Blueprint`	`setExternalServices(List<String> externalServices)` Sets the list of external services in this Blueprint.
`Blueprint`	`setFMWVersionRange(String fmwVersionRange)` Sets the the range of FMW releases that this model object is supported under.
`Blueprint`	`setName(String name)` Sets the name.
`Blueprint`	`setSchemaVersion(String schemaVersion)` Sets the version of the EnvSpec (XML) schema that applies to this model.
`Blueprint`	`setTemplates(List<Template> templates)` Sets the list of templates in this Blueprint.
`Blueprint`	`setVersion(String version)` Sets the consumer specified version of the their model file.
`String`	`toCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toString()`
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format..

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Blueprint
```
public Blueprint()
```
- Method Detail
  - addBlueprint
```
public boolean addBlueprint(Blueprint blueprint)
                     throws IllegalArgumentException
```
    Adds a Blueprint to the list of Blueprints in this Blueprint.
    
    Parameters:
    
    blueprint - The Blueprint to be added
    
    Returns:
    
    true if the Blueprint is successfully added to the list
    
    Throws:
    
    IllegalArgumentException
  - addBlueprint
```
public boolean addBlueprint(String blueprintName,
                            String version,
                            EnvironmentModelFileLocator locator)
                     throws FMWEnvSpecException
```
    Adds a Blueprint to the list of Blueprints in this Blueprint identified by the blueprintName. When multiple versions of a Blueprint are available with the same name, the version number can be specified to select the desired Blueprint. Specifying the optional file locator allows the Blueprint search to include other Blueprint locations outside the OracleHome.
    
    Parameters:
    
    blueprintName - the name of the Blueprint to be added
    
    version - the version of the Blueprint to be added or null if any version is acceptable
    
    locator - an EnvironmentModelFileLocator locator that has been initialized with the paths that are to be searched when finding the Blueprint or null if only the OracleHome needs to be searched
    
    Returns:
    
    true if the Blueprint is successfully added to the list
    
    Throws:
    
    FMWEnvSpecException - the Blueprint could not be loaded
  - addBlueprint
```
public boolean addBlueprint(String blueprintName)
                     throws FMWEnvSpecException,
                            IllegalArgumentException
```
    Adds a Blueprint to the list of Blueprints in this Blueprint identified by the blueprintName. This method uses the internal file locator to find and instantiate the Blueprint identified by the blueprintName provided. If multiple versions of the Blueprint exist that are identified by the same name, the first one found will be used.
    
    Parameters:
    
    blueprintName - the name of the blueprint to be added
    
    Returns:
    
    true if the Blueprint is successfully added to the list
    
    Throws:
    
    FMWEnvSpecException - The Blueprint could not be loaded
    
    IllegalArgumentException
  - getBlueprints
```
public List<Blueprint> getBlueprints()
```
    Gets the list of Blueprints available in this Blueprint. If the Blueprint References haven't been resolved then they will be resolved now and the ResourceReference list will be cleared.
    
    Returns:
    
    the list of Blueprints available in this Blueprint
  - getExternalServices
```
public List<String> getExternalServices()
```
    Returns the list of external services in this Blueprint.
    
    Returns:
    
    list of external services
  - getName
```
public String getName()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the name.
    
    Specified by:
    
    getName in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    name
  - getSchemaVersion
```
public String getSchemaVersion()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the version of the EnvSpec (XML) schema that applies to this model.
    
    Specified by:
    
    getSchemaVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the version of the EnvSpec (XML) schema that applies to this model
  - getTemplates
```
public List<Template> getTemplates()
```
    Returns the list of Templates in this Blueprint.
    
    Returns:
    
    the list of Templates in this Blueprint
  - getVersion
```
public String getVersion()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the consumer specified version of the this model file. This should be incremented when the model file is changed. This is used to allow the consumer to select a version by using it's version or a version range.
    
    Specified by:
    
    getVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the consumer specified version of the their model file
  - getFMWVersionRange
```
public String getFMWVersionRange()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the range of FMW releases that this model object is supported under.
    
    Specified by:
    
    getFMWVersionRange in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the consumer specified version of the their model
  - setFMWVersionRange
```
public Blueprint setFMWVersionRange(String fmwVersionRange)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the the range of FMW releases that this model object is supported under.
    
    Specified by:
    
    setFMWVersionRange in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    fmwVersionRange - the range of FMW releases that this model object is supported under
    
    Returns:
    
    this (for method chaining)
  - setBlueprints
```
public Blueprint setBlueprints(List<Blueprint> blueprints)
```
    Sets the list of Blueprints in this Blueprint.
    
    Parameters:
    
    blueprints - The Blueprint list to be used by this Blueprint
    
    Returns:
    
    this Blueprint object (for method chaining)
  - setExternalServices
```
public Blueprint setExternalServices(List<String> externalServices)
```
    Sets the list of external services in this Blueprint.
    
    Parameters:
    
    externalServices - the list of externalServices to be used by this Blueprint
    
    Returns:
    
    this Blueprint object (for method chaining)
  - addAllExternalServices
```
public boolean addAllExternalServices(List<String> externalServices)
                               throws IllegalArgumentException
```
    Adds a list of ResourceGroupTarget strings to the list of ResourceGroupTargets in this ResourceGroup
    
    Parameters:
    
    externalServices - list of String objects to add
    
    Returns:
    
    true if the list of ExternalServices changed in this Blueprint as a result of the call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - addExternalService
```
public boolean addExternalService(String externalService)
                           throws IllegalArgumentException
```
    Adds a single external service to the list of external services for this Blueprint
    
    Parameters:
    
    externalService - string value for the external service
    
    Returns:
    
    true if the list of ExternalServices changed in this Blueprint as a result of the call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - setName
```
public Blueprint setName(String name)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the name.
    
    Specified by:
    
    setName in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    name - the name
    
    Returns:
    
    this (for method chaining)
  - setSchemaVersion
```
public Blueprint setSchemaVersion(String schemaVersion)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the version of the EnvSpec (XML) schema that applies to this model.
    
    Specified by:
    
    setSchemaVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    schemaVersion - the version of the EnvSpec (XML) schema that applies to this model
    
    Returns:
    
    this (for method chaining)
  - setTemplates
```
public Blueprint setTemplates(List<Template> templates)
```
    Sets the list of templates in this Blueprint.
    
    Parameters:
    
    templates - the Templates to be used by this Blueprint
    
    Returns:
    
    this Blueprint object (for method chaining)
  - setVersion
```
public Blueprint setVersion(String version)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the consumer specified version of the their model file. This should be incremented when the model file is changed. This is used to allow the consumer to select a version by using it's version or a version range.
    
    Specified by:
    
    setVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    version - the consumer specified version of the their model file.
    
    Returns:
    
    this (for method chaining)
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format..
    
    Returns:
    
    a string representation of the object in XML format.
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Blueprint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Blueprint

Method Detail

addBlueprint

addBlueprint

addBlueprint

getBlueprints

getExternalServices

getName

getSchemaVersion

getTemplates

getVersion

getFMWVersionRange

setFMWVersionRange

setBlueprints

setExternalServices

addAllExternalServices

addExternalService

setName

setSchemaVersion

setTemplates

setVersion

toXmlCompactString

toXmlString

toCompactString

toString