oracle.fmwplatform.envspec.model.blueprint

Class Template

java.lang.Object

oracle.fmwplatform.envspec.model.blueprint.Template

public class Template
extends Object

Provides details of a Domain Extension Template (or Base Template).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Template.TemplateType Specifies how the Template is used.

Constructor Summary

Constructors

Constructor and Description
Template()

Method Summary

Modifier and Type	Method and Description
boolean	getIsCustom() Determines if the Template is custom i.e.
String	getLocation() Returns the location of a Template.
String	getName() Returns the name of the Template.
String	getProfile() Returns the profile associated with this template assignment, such as Expanded, Compact, or default (null).
Template.TemplateType	getTemplateType() Returns the Template type of this Template.
Template	setIsCustom(boolean isCustom) Sets if the template is custom i.e.
Template	setLocation(String location) Sets the location of this Template for custom Templates only.
Template	setName(String name) Sets the name of this Template.
Template	setProfile(String profile) Sets the profile associated with this template assignment.
Template	setTemplateType(Template.TemplateType templateType) Sets the Template type of this Template.
String	toCompactString() Returns a compact string representation of the object in XML format.
String	toJsonCompactString() Returns a compact string representation of the object in JSON format.
String	toJsonString() Returns a string representation of the object in JSON format.
String	toString() Returns a string representation of the object in XML format.
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

Template

public Template()

Method Detail

getIsCustom

public boolean getIsCustom()

Determines if the Template is custom i.e. user provided or provided by Oracle. Custom Domain Templates must be accessed differently than Oracle provided domain templates.

Returns:

true if the Template is a custom Template, otherwise returns false

getLocation

public String getLocation()

Returns the location of a Template. Used only for custom Templates.

Returns:

location the location of a Template for a custom Template only

getProfile

public String getProfile()

Returns the profile associated with this template assignment, such as Expanded, Compact, or default (null).

Returns:

the profile associated with this template assignment, or null for default

getName

public String getName()

Returns the name of the Template.

Returns:

the name of the Template

getTemplateType

public Template.TemplateType getTemplateType()

Returns the Template type of this Template. Defaults to Extension if not specified.

Returns:

the Template type of this Template

setIsCustom

public Template setIsCustom(boolean isCustom)

Sets if the template is custom i.e. user provided or provided by Oracle. Custom domain templates must be accessed differently than Oracle provided domain templates.

Parameters:

isCustom - sets true for custom Template or false if this Template is not custom

Returns:

a reference to the current Template object

setLocation

public Template setLocation(String location)

Sets the location of this Template for custom Templates only.

Parameters:

location - the location of this Template for custom Templates only.

Returns:

a reference to the current Template object

setProfile

public Template setProfile(String profile)

Sets the profile associated with this template assignment.

Parameters:

profile - the profile associated with this template assignment

Returns:

a reference to the current Template object

setName

public Template setName(String name)

Sets the name of this Template.

Parameters:

name - the name of this Template

Returns:

a reference to the current Template object

Throws:

IllegalArgumentException - if input parameter is null

setTemplateType

public Template setTemplateType(Template.TemplateType templateType)

Sets the Template type of this Template.

Parameters:

templateType - the Template type to be used by this Template

Returns:

a reference to the current Template object

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

toJsonCompactString

public String toJsonCompactString()

Returns a compact string representation of the object in JSON format.

Returns:

a compact string representation of the object in JSON format

toJsonString

public String toJsonString()

Returns a string representation of the object in JSON format.

Returns:

a string representation of the object in JSON format

toCompactString

public String toCompactString()

Returns a compact string representation of the object in XML format.

Returns:

a compact string representation of the object in XML format

toString

public String toString()

Returns a string representation of the object in XML format.

Overrides:

toString in class Object

Returns:

a string representation of the object in XML format