wt.inf.template
Interface ContainerTemplateService

All Known Implementing Classes:

ContainerTemplateServiceFwd, StandardContainerTemplateService

public interface ContainerTemplateService

Methods for manipulating templates.

Supported API: true

Extendable: false

Method Summary

WTContainerTemplate	addBusinessXML(WTContainerTemplateRef templateRef, UploadBusinessXMLRequest businessRequest) Uploads the business XML.
WTContainerRef	assignContainerToTemplate(WTContainerRef container, WTContainerTemplateRef containerTemplate) If a container has been created with no template, this provides the ability to assign one retroactively.
WTContainerTemplate	assignDefaultValuesSpec(WTContainerTemplateRef templateRef, String ruleName) Sets the default values for the template.
WTContainerRef	copyContainer(WTContainerRef sourceContainer, ContainerCopyInstanceAttributes clientValues, ContainerCopyWorklist workList) Given a source container, worklist,this method creates a new WTContainer and returns a reference to it.
WTContainerRef	copyContainer(WTContainerRef sourceContainer, ContainerCopyInstanceAttributes clientvalues, ContainerCopyWorklist workList, String scriptId) Given a source container, worklist, and a scriptIdentifier this method creates a new WTContainer and returns a reference to it.
WTContainerTemplate	copyTemplate(WTContainerRef parentContainer, WTContainerTemplate template, GeneratedTemplateAttributes attrs) Saves the non-identity information of a template along with any associated content files to a new template.
WTContainerTemplate	createContainerTemplate(WTContainerRef parentContainer, WTContainerTemplate template) Creates the container template.
WTContainerTemplate	createContainerTemplate(WTContainerRef parentContainer, WTContainerTemplate template, UploadTemplateRequest businessXML) Creates the container template.
void	deleteContainerTemplate(WTContainerTemplateRef template) This method should be used to delete a container template.
URL	downloadBusinessXML(WTContainerTemplateRef templateRef) Prepares a jar file containing the standard70.dtd, the business XML, and any content files and fragments that are part of the WTContainerTemplate Supported API: false
File	exportContainerAsTemplateToFile(WTContainerRef sourceContainer, GeneratedTemplateAttributes tmplAttrs, TemplateGeneratorWorklist worklist) A lower level API that allows solutions to over-ride the default URL generation.
File	exportContainerAsTemplateToFile(WTContainerRef sourceContainer, GeneratedTemplateAttributes tmplAttrs, TemplateGeneratorWorklist worklist, String scriptId) A lower level API that allows solutions to over-ride the default URL generation.
QueryResult	getAllTemplateMasters(LookupSpec lookupSpec) Supported API: false
QueryResult	getAllTemplateMasters(LookupSpec lookupSpec, Class contClass) Supported API: false
QueryResult	getAllTemplateMasters(WTContainerRef parentContainer) Supported API: false
QueryResult	getAllTemplateMasters(WTContainerRef parentContainer, Class contClass) Supported API: false
QueryResult	getAllTemplates(LookupSpec lookupSpec) Supported API: false
QueryResult	getAllTemplates(LookupSpec lookupSpec, Class contClass) Supported API: false
QueryResult	getAllTemplates(WTContainerRef parentContainer) Supported API: false
QueryResult	getAllTemplates(WTContainerRef parentContainer, Class contClass) Supported API: false
XMLLob	getBusinessXML(WTContainerTemplateRef templateRef) Retrieves the business XML for a subclass of DefaultWTContainerTemplate.
QueryResult	getContainers(WTContainerTemplateMasterReference definition) This signature gets all containers created from all iterations of the template.
QueryResult	getContainers(WTContainerTemplateRef definition) This method returns all containers created from all iterations of the master object.
WTContainerTemplate	getContainerTemplate(ContainerTemplateDefinition definition) Gets the latest iteration of a template given a container definition.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, Class containerClass) Gets a template given a name and a container class object.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, Class containerClass, boolean lookupFlag, String locale) Gets a template given a name and a container class.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, String containerClassName) Gets a template given a name and a fully qualified container class name.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, String containerClassName, boolean lookupFlag, String locale) Gets a template given a name and a contaienr class name.
WTContainerTemplateRef	getContainerTemplateRef(ContainerTemplateDefinition definition) Gets the latest iteration of a template given a container definition.
WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, Class containerClass) Gets a template given a name and container class object.
WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, Class containerClass, boolean lookup, String locale) Gets a template given a name and a fully qualified container class name.
WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, String containerClassName) Gets a template given a name and a fully qualified container class name.
WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, String containerClassName, boolean lookupflag, String locale) Gets a template given a name and a fully qualified container class name.
WTContainer	getDefaultContainerValues(WTContainerTemplateRef containerTemplate) Returns an unpersisted WTContainer corresponding to the DefaultContainerValues object corresponding to the passed in template.
WTContainer	getDefaultContainerValues(WTContainerTemplateRef containerTemplate, WTContainer cont) Returns an unpersisted WTContainer corresponding to the DefaultContainerValues object corresponding to the passed in template.
QueryResult	getEnabledTemplateMasters(LookupSpec lookupSpec) returns all template masters residing in the passed in container, the locale is the server side locale Supported API: true
QueryResult	getEnabledTemplateMasters(LookupSpec lookupSpec, Class containerClass) returns all enabled template masters that reside in the passed in LookupSpec Supported API: true
QueryResult	getEnabledTemplateMasters(LookupSpec lookupSpec, Class containerClass, Locale clientLocale) returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.
QueryResult	getEnabledTemplateMasters(WTContainerRef parentContainer) returns all template masters residing in the passed in container, the locale is the server side locale Supported API: true
QueryResult	getEnabledTemplateMasters(WTContainerRef parentContainer, Class containerClass) returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.
QueryResult	getEnabledTemplateMasters(WTContainerRef parentContainer, Class containerClass, Locale clientLocale) returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.
QueryResult	getEnabledTemplates(LookupSpec lookupSpec) Returns all container templates regardless of containerclass, the lookupspec only needs to specify the container restrictions The other restrictions will be taken care of by the service.
QueryResult	getEnabledTemplates(LookupSpec lookupSpec, Class containerClass) Returns all enabled templates which create a container of the type of the passed in container class which live in the containers correpsonding to the designated LookupSpec This lookup spec only needs to specify the specification for the container navigation, the rest of the search conditions will be added on your behalf by the service.
QueryResult	getEnabledTemplates(WTContainerRef parentContainer) Supported API: false
QueryResult	getEnabledTemplates(WTContainerRef parentContainer, Class containerClass) Supported API: false
ImportTemplateRequest	getImportRequest(File file) Returns the appropriate ImportTemplateRequest object for the passed in File.
WTContainerTemplateRef	getLatestIteration(ContainerTemplateDefinition definition) Supported API: false
WTContainerTemplateRef	getLatestIteration(WTContainerTemplateRef definitionReference) Supported API: false
UploadTemplateRequest	getUploadRequest(File file) Returns the appropriate UploadRequest based on an analysis of the passed in File object.
WTContainerTemplateRef	importContainerTemplate(ImportTemplateRequest req, WTContainerRef contRef, GeneratedTemplateAttributes attrs) Imports a file containing a single default values spec.
void	importDefaultValuesSpec(WTContainerRef contRef, UploadBusinessXMLRequest req) Imports a file containing a single default values spec.
void	importDefaultValuesSpec(WTContainerRef contRef, UploadBusinessXMLRequest req, String ruleName) Imports a file containing a single default values spec.
WTContainerTemplate	replaceBusinessXML(WTContainerTemplateRef definitionReference, UploadTemplateRequest request) Purges the old business XML and any fragments, and replaces it with the passed in BusinessXML Supported API: false
WTContainerTemplateRef	saveContainerAsTemplate(WTContainerRef sourceContainer, GeneratedTemplateAttributes tmplAttrs, TemplateGeneratorWorklist worklist) Supported API: false
WTContainerTemplateRef	saveContainerAsTemplate(WTContainerRef sourceContainer, GeneratedTemplateAttributes tmplAttrs, TemplateGeneratorWorklist worklist, String scriptId) Saves a container template to the container that is the parent container of the source container Supported API: false
WTContainerTemplateRef	saveContainerAsTemplate(WTContainerRef parentContainer, WTContainerRef sourceContainer, GeneratedTemplateAttributes tmplAttrs, TemplateGeneratorWorklist worklist) This signature saves the template to the specified parent container Supported API: false
WTContainerTemplateRef	saveContainerAsTemplate(WTContainerRef parentContainer, WTContainerRef sourceContainer, GeneratedTemplateAttributes tmplAttrs, TemplateGeneratorWorklist worklist, String scriptId) Saves a container template to the specified parent container Supported API: false

Method Detail

getEnabledTemplates

public QueryResult getEnabledTemplates(WTContainerRef parentContainer,
                                       Class containerClass)
                                throws WTException

Supported API: false

Parameters:

parentContainer -

containerClass -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplates

public QueryResult getEnabledTemplates(LookupSpec lookupSpec,
                                       Class containerClass)
                                throws WTException

Returns all enabled templates which create a container of the type of the passed in container class which live in the containers correpsonding to the designated LookupSpec This lookup spec only needs to specify the specification for the container navigation, the rest of the search conditions will be added on your behalf by the service.

Supported API: false

Parameters:

lookupSpec -

containerClass -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplates

public QueryResult getEnabledTemplates(WTContainerRef parentContainer)
                                throws WTException

Supported API: false

Parameters:

parentContainer -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplates

public QueryResult getEnabledTemplates(LookupSpec lookupSpec)
                                throws WTException

Returns all container templates regardless of containerclass, the lookupspec only needs to specify the container restrictions The other restrictions will be taken care of by the service.

Supported API: false

Parameters:

lookupSpec -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

public QueryResult getEnabledTemplateMasters(WTContainerRef parentContainer,
                                             Class containerClass)
                                      throws WTException

returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.

Supported API: true

Parameters:

parentContainer -

containerClass -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

public QueryResult getEnabledTemplateMasters(LookupSpec lookupSpec,
                                             Class containerClass)
                                      throws WTException

returns all enabled template masters that reside in the passed in LookupSpec

Supported API: true

Parameters:

lookupSpec -

containerClass -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

public QueryResult getEnabledTemplateMasters(WTContainerRef parentContainer,
                                             Class containerClass,
                                             Locale clientLocale)
                                      throws WTException

returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.

Supported API: true

Parameters:

parentContainer -

containerClass -

clientLocale -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

public QueryResult getEnabledTemplateMasters(LookupSpec lookupSpec,
                                             Class containerClass,
                                             Locale clientLocale)
                                      throws WTException

returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.

Supported API: true

Parameters:

lookupSpec -

containerClass -

clientLocale -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

public QueryResult getEnabledTemplateMasters(WTContainerRef parentContainer)
                                      throws WTException

returns all template masters residing in the passed in container, the locale is the server side locale

Supported API: true

Parameters:

parentContainer -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

public QueryResult getEnabledTemplateMasters(LookupSpec lookupSpec)
                                      throws WTException

returns all template masters residing in the passed in container, the locale is the server side locale

Supported API: true

Parameters:

lookupSpec -

Returns:

QueryResult

Throws:

WTException

getAllTemplateMasters

public QueryResult getAllTemplateMasters(WTContainerRef parentContainer)
                                  throws WTException

Supported API: false

Parameters:

parentContainer -

Returns:

QueryResult

Throws:

WTException

getAllTemplateMasters

public QueryResult getAllTemplateMasters(LookupSpec lookupSpec)
                                  throws WTException

Supported API: false

Parameters:

lookupSpec -

Returns:

QueryResult

Throws:

WTException

getAllTemplateMasters

public QueryResult getAllTemplateMasters(WTContainerRef parentContainer,
                                         Class contClass)
                                  throws WTException

Supported API: false

Parameters:

parentContainer -

contClass -

Returns:

QueryResult

Throws:

WTException

getAllTemplateMasters

public QueryResult getAllTemplateMasters(LookupSpec lookupSpec,
                                         Class contClass)
                                  throws WTException

Supported API: false

Parameters:

lookupSpec -

contClass -

Returns:

QueryResult

Throws:

WTException

getAllTemplates

public QueryResult getAllTemplates(WTContainerRef parentContainer)
                            throws WTException

Supported API: false

Parameters:

parentContainer -

Returns:

QueryResult

Throws:

WTException

getAllTemplates

public QueryResult getAllTemplates(LookupSpec lookupSpec)
                            throws WTException

Supported API: false

Parameters:

lookupSpec -

Returns:

QueryResult

Throws:

WTException

getAllTemplates

public QueryResult getAllTemplates(WTContainerRef parentContainer,
                                   Class contClass)
                            throws WTException

Supported API: false

Parameters:

parentContainer -

contClass -

Returns:

QueryResult

Throws:

WTException

getAllTemplates

public QueryResult getAllTemplates(LookupSpec lookupSpec,
                                   Class contClass)
                            throws WTException

Supported API: false

Parameters:

lookupSpec -

contClass -

Returns:

QueryResult

Throws:

WTException

getContainers

public QueryResult getContainers(WTContainerTemplateMasterReference definition)
                          throws WTException

This signature gets all containers created from all iterations of the template.

Supported API: false

Parameters:

definition -

Returns:

QueryResult

Throws:

WTException

getContainers

public QueryResult getContainers(WTContainerTemplateRef definition)
                          throws WTException

This method returns all containers created from all iterations of the master object. If you want only the containers created from a specific iteration of a template use the getContainersCreatedFrom method.

Supported API: false

Parameters:

definition -

Returns:

QueryResult

Throws:

WTException

getLatestIteration

public WTContainerTemplateRef getLatestIteration(ContainerTemplateDefinition definition)
                                          throws WTException

Supported API: false

Parameters:

definition -

Returns:

WTContainerTemplateRef

Throws:

WTException

getLatestIteration

public WTContainerTemplateRef getLatestIteration(WTContainerTemplateRef definitionReference)
                                          throws WTException

Supported API: false

Parameters:

definitionReference -

Returns:

WTContainerTemplateRef

Throws:

WTException

addBusinessXML

public WTContainerTemplate addBusinessXML(WTContainerTemplateRef templateRef,
                                          UploadBusinessXMLRequest businessRequest)
                                   throws WTException

Uploads the business XML. If this object already has business XML an exception is thrown.

Supported API: false

Parameters:

templateRef -

businessRequest -

Returns:

WTContainerTemplate

Throws:

WTException

downloadBusinessXML

public URL downloadBusinessXML(WTContainerTemplateRef templateRef)
                        throws WTException

Prepares a jar file containing the standard70.dtd, the business XML, and any content files and fragments that are part of the WTContainerTemplate

Supported API: false

Parameters:

templateRef -

Returns:

URL

Throws:

WTException

createContainerTemplate

public WTContainerTemplate createContainerTemplate(WTContainerRef parentContainer,
                                                   WTContainerTemplate template)
                                            throws WTException

Creates the container template. If the container is null, the template is created globally, otherwise the template is created in the scope of the container. All templates reside in the containers System Folder, unless there is no system folder, in which case it is created in the root folder of the container.

Supported API: false

Parameters:

parentContainer -

template -

Returns:

WTContainerTemplate

Throws:

WTException

createContainerTemplate

public WTContainerTemplate createContainerTemplate(WTContainerRef parentContainer,
                                                   WTContainerTemplate template,
                                                   UploadTemplateRequest businessXML)
                                            throws WTException

Creates the container template. If the container is null, the template is created globally, otherwise the template is created in the scope of the container. All templates reside in the containers System Folder, unless there is no system folder, in which case it is created in the root folder of the container.

Supported API: false

Parameters:

parentContainer -

template -

businessXML -

Returns:

WTContainerTemplate

Throws:

WTException

copyTemplate

public WTContainerTemplate copyTemplate(WTContainerRef parentContainer,
                                        WTContainerTemplate template,
                                        GeneratedTemplateAttributes attrs)
                                 throws WTException

Saves the non-identity information of a template along with any associated content files to a new template.

Supported API: false

Parameters:

parentContainer -

template -

attrs - Identity information for the new template. See wt.inf.template.GeneratedTemplateAttributes

Returns:

WTContainerTemplate

Throws:

WTException

getBusinessXML

public XMLLob getBusinessXML(WTContainerTemplateRef templateRef)
                      throws WTException

Retrieves the business XML for a subclass of DefaultWTContainerTemplate. If the passed in reference is not a sub-class of DefaultWTContainerTemplate, the method returns null.

Supported API: false

Parameters:

templateRef -

Returns:

XMLLob

Throws:

WTException

deleteContainerTemplate

public void deleteContainerTemplate(WTContainerTemplateRef template)
                             throws WTException

This method should be used to delete a container template. An Exception will be thrown if there are any containers that exist that have been created from this template. Templates should never be deleted via PersistenceHelper.manager.delete

Supported API: false

Parameters:

template - A reference to the template to be deleted. An Exception is thrown if there are any containers that have been made with this template

Throws:

WTException

getContainerTemplateRef

public WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                      String name,
                                                      Class containerClass)
                                               throws WTException

Gets a template given a name and container class object. If a template matching the passed in criteria is not found in the target container, a lookup is performed.

Supported API: true

Parameters:

parent -

name -

containerClass - An Exception will be thrown if the class is not a subclass of WTContainer

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

public WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                      String name,
                                                      Class containerClass,
                                                      boolean lookup,
                                                      String locale)
                                               throws WTException

Gets a template given a name and a fully qualified container class name. This also for restricting the scope of the search to the passed in container, and to a specific locale.

Supported API: true

Parameters:

parent -

name -

containerClass -

lookup - If set to false the search is restricted to the target container, if set to true, a lookup is performed.

locale - This may be null or an empty string.

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

public WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                      String name,
                                                      String containerClassName)
                                               throws WTException

Gets a template given a name and a fully qualified container class name. If the template is not found, a lookup is performed.

Supported API: true

Parameters:

parent -

name -

containerClassName - An Exception will be thrown if this is not the class name of a subclass of WTContainer

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

public WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                      String name,
                                                      String containerClassName,
                                                      boolean lookupflag,
                                                      String locale)
                                               throws WTException

Gets a template given a name and a fully qualified container class name.

Supported API: true

Parameters:

parent -

name -

containerClassName -

lookupflag - If the flag is set to false the search is restricted to the target contaner.

locale -

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

public WTContainerTemplateRef getContainerTemplateRef(ContainerTemplateDefinition definition)
                                               throws WTException

Gets the latest iteration of a template given a container definition.

Supported API: true

Parameters:

definition - Either a WTContainerTemplate or a WTContainerTemplateMaster object

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplate

public WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                                String name,
                                                String containerClassName)
                                         throws WTException

Gets a template given a name and a fully qualified container class name. If a template matching this criteria is not found in the target container a lookup will be performed.

Supported API: true

Parameters:

parent -

name -

containerClassName -

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

public WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                                String name,
                                                String containerClassName,
                                                boolean lookupFlag,
                                                String locale)
                                         throws WTException

Gets a template given a name and a contaienr class name. This signature allows for filtering by container and locale. By specifying the lookup flag to false, the search is restricted to the passed in template. If it is set to true a lookup is performed that will return the first match to the passed in criteria.

Supported API: true

Parameters:

parent -

name -

containerClassName -

lookupFlag - If set to true a lookup is performed.

locale - If you are only interested in a specific locale pass in a locale this will filter the query, other wise this value may be null or an empty string

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

public WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                                String name,
                                                Class containerClass)
                                         throws WTException

Gets a template given a name and a container class object. A lookup will be performed if the container matching the passed in criteria is not in the target container

Supported API: true

Parameters:

parent -

name -

containerClass -

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

public WTContainerTemplate getContainerTemplate(ContainerTemplateDefinition definition)
                                         throws WTException

Gets the latest iteration of a template given a container definition.

Supported API: true

Parameters:

definition - Either a WTContainerTemplate or a WTContainerTemplateMaster object

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

public WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                                String name,
                                                Class containerClass,
                                                boolean lookupFlag,
                                                String locale)
                                         throws WTException

Gets a template given a name and a container class. This signature allows for filtering by container and locale

Supported API: true

Parameters:

parent -

name -

containerClass -

lookupFlag - If set to true a lookup is performed.

locale - If you are only interested in a specific locale pass in a locale this will filter the query, other wise this value may be null or an empty string

Returns:

WTContainerTemplate

Throws:

WTException

assignContainerToTemplate

public WTContainerRef assignContainerToTemplate(WTContainerRef container,
                                                WTContainerTemplateRef containerTemplate)
                                         throws WTException

If a container has been created with no template, this provides the ability to assign one retroactively. The result of this addition is that the association to the template is made and the business XML residing in the template is loaded into the container.

Supported API: false

Parameters:

container -

containerTemplate -

Returns:

WTContainerRef

Throws:

WTException

replaceBusinessXML

public WTContainerTemplate replaceBusinessXML(WTContainerTemplateRef definitionReference,
                                              UploadTemplateRequest request)
                                       throws WTException

Purges the old business XML and any fragments, and replaces it with the passed in BusinessXML

Supported API: false

Parameters:

definitionReference -

request -

Returns:

WTContainerTemplate

Throws:

WTException

getDefaultContainerValues

public WTContainer getDefaultContainerValues(WTContainerTemplateRef containerTemplate)
                                      throws WTException

Returns an unpersisted WTContainer corresponding to the DefaultContainerValues object corresponding to the passed in template. This is usefull for client developers since container defaults can be forced on an instance based and a type based fashion.

Supported API: false

Parameters:

containerTemplate -

Returns:

WTContainer

Throws:

WTException

getDefaultContainerValues

public WTContainer getDefaultContainerValues(WTContainerTemplateRef containerTemplate,
                                             WTContainer cont)
                                      throws WTException

Returns an unpersisted WTContainer corresponding to the DefaultContainerValues object corresponding to the passed in template. This is usefull for client developers since container defaults can be forced on an instance based and a type based fashion.

Supported API: false

Parameters:

containerTemplate -

cont - An exception is thrown if the passed in container has been persisted.

Returns:

WTContainer

Throws:

WTException

copyContainer

public WTContainerRef copyContainer(WTContainerRef sourceContainer,
                                    ContainerCopyInstanceAttributes clientvalues,
                                    ContainerCopyWorklist workList,
                                    String scriptId)
                             throws WTException

Given a source container, worklist, and a scriptIdentifier this method creates a new WTContainer and returns a reference to it.

Supported API: false

Parameters:

sourceContainer -

clientvalues -

workList -

scriptId -

Returns:

WTContainerRef

Throws:

WTException

copyContainer

public WTContainerRef copyContainer(WTContainerRef sourceContainer,
                                    ContainerCopyInstanceAttributes clientValues,
                                    ContainerCopyWorklist workList)
                             throws WTException

Given a source container, worklist,this method creates a new WTContainer and returns a reference to it. The script that is run corresponds to the Default for the container type.

Supported API: false

Parameters:

sourceContainer -

clientValues -

workList -

Returns:

WTContainerRef

Throws:

WTException

exportContainerAsTemplateToFile

public File exportContainerAsTemplateToFile(WTContainerRef sourceContainer,
                                            GeneratedTemplateAttributes tmplAttrs,
                                            TemplateGeneratorWorklist worklist,
                                            String scriptId)
                                     throws WTException

A lower level API that allows solutions to over-ride the default URL generation.

Supported API: false

Parameters:

sourceContainer - The container that the template is to be generated from

tmplAttrs - Client supplied attributes for the template to be created.

worklist -

scriptId -

Returns:

File

Throws:

WTException

exportContainerAsTemplateToFile

public File exportContainerAsTemplateToFile(WTContainerRef sourceContainer,
                                            GeneratedTemplateAttributes tmplAttrs,
                                            TemplateGeneratorWorklist worklist)
                                     throws WTException

A lower level API that allows solutions to over-ride the default URL generation. This signature uses the default scriptId for the passed in container type. If there is no scriptId for the container type, an exception is thrown.

Supported API: false

Parameters:

sourceContainer - The container that the template is to be generated from

tmplAttrs - Client supplied attributes for the template to be created.

worklist -

Returns:

File

Throws:

WTException

importContainerTemplate

public WTContainerTemplateRef importContainerTemplate(ImportTemplateRequest req,
                                                      WTContainerRef contRef,
                                                      GeneratedTemplateAttributes attrs)
                                               throws WTException

Imports a file containing a single default values spec.

Supported API: false

Parameters:

req -

contRef -

attrs - If this is not null or an empty string, the default values profile will be given the passed in name, otherwise the name will be the one specified in the file.

Returns:

WTContainerTemplateRef

Throws:

WTException

saveContainerAsTemplate

public WTContainerTemplateRef saveContainerAsTemplate(WTContainerRef sourceContainer,
                                                      GeneratedTemplateAttributes tmplAttrs,
                                                      TemplateGeneratorWorklist worklist)
                                               throws WTException

Supported API: false

Parameters:

sourceContainer - The container that the template is to be generated from

tmplAttrs - Client supplied attributes for the template to be created.

worklist -

Returns:

WTContainerTemplateRef

Throws:

WTException

saveContainerAsTemplate

public WTContainerTemplateRef saveContainerAsTemplate(WTContainerRef sourceContainer,
                                                      GeneratedTemplateAttributes tmplAttrs,
                                                      TemplateGeneratorWorklist worklist,
                                                      String scriptId)
                                               throws WTException

Saves a container template to the container that is the parent container of the source container

Supported API: false

Parameters:

sourceContainer - The container that the template is to be generated from

tmplAttrs - Client supplied attributes for the template to be created.

worklist -

scriptId -

Returns:

WTContainerTemplateRef

Throws:

WTException

saveContainerAsTemplate

public WTContainerTemplateRef saveContainerAsTemplate(WTContainerRef parentContainer,
                                                      WTContainerRef sourceContainer,
                                                      GeneratedTemplateAttributes tmplAttrs,
                                                      TemplateGeneratorWorklist worklist)
                                               throws WTException

This signature saves the template to the specified parent container

Supported API: false

Parameters:

parentContainer -

sourceContainer - The container that the template is to be generated from

tmplAttrs - Client supplied attributes for the template to be created.

worklist -

Returns:

WTContainerTemplateRef

Throws:

WTException

saveContainerAsTemplate

public WTContainerTemplateRef saveContainerAsTemplate(WTContainerRef parentContainer,
                                                      WTContainerRef sourceContainer,
                                                      GeneratedTemplateAttributes tmplAttrs,
                                                      TemplateGeneratorWorklist worklist,
                                                      String scriptId)
                                               throws WTException

Saves a container template to the specified parent container

Supported API: false

Parameters:

parentContainer -

sourceContainer - The container that the template is to be generated from

tmplAttrs - Client supplied attributes for the template to be created.

worklist -

scriptId -

Returns:

WTContainerTemplateRef

Throws:

WTException

assignDefaultValuesSpec

public WTContainerTemplate assignDefaultValuesSpec(WTContainerTemplateRef templateRef,
                                                   String ruleName)
                                            throws WTException

Sets the default values for the template.

Supported API: false

Parameters:

templateRef -

ruleName -

Returns:

WTContainerTemplate

Throws:

WTException

importDefaultValuesSpec

public void importDefaultValuesSpec(WTContainerRef contRef,
                                    UploadBusinessXMLRequest req,
                                    String ruleName)
                             throws WTException

Imports a file containing a single default values spec.

Supported API: false

Parameters:

contRef -

req -

ruleName - If this is not null or an empty string, the default values profile will be given the passed in name, otherwise the name will be the one specified in the file.

Throws:

WTException

importDefaultValuesSpec

public void importDefaultValuesSpec(WTContainerRef contRef,
                                    UploadBusinessXMLRequest req)
                             throws WTException

Imports a file containing a single default values spec.

Supported API: false

Parameters:

contRef -

req -

Throws:

WTException

getUploadRequest

public UploadTemplateRequest getUploadRequest(File file)
                                       throws WTException

Returns the appropriate UploadRequest based on an analysis of the passed in File object. An exception is thrown if an UploadRequest cannot be procured. (This can be used for create template and replaceBusinessXML)

Supported API: false

Parameters:

file -

Returns:

UploadTemplateRequest

Throws:

WTException

getImportRequest

public ImportTemplateRequest getImportRequest(File file)
                                       throws WTException

Returns the appropriate ImportTemplateRequest object for the passed in File. This can be passed to the updateTemplate methods.

Supported API: false

Parameters:

file -

Returns:

ImportTemplateRequest

Throws:

WTException