wt.ixb.actor
Class ActorTemplateForTypeDefinition

java.lang.Object
  wt.ixb.actor.ActorTemplate
      wt.ixb.actor.CheckOutActorTemplate
          wt.ixb.actor.ActorTemplateForTypeDefinition

All Implemented Interfaces:

Actor

public class ActorTemplateForTypeDefinition
extends CheckOutActorTemplate

Supported API: true

Extendable: false

Field Summary

static String	TYPE_FULL_PATH_2_INTERNET_DOMAIN_MAP Key used in Importer's general context for target internet domains for each XML file to be imported.
protected static String	XML_PARAM_NEW_NAME Tag to be used for import actions "Substitute Object" and "Create New Object" when importing type definitions.
protected static String	XML_PARAM_NEW_PATH Tag to be used for import action "Substitute Object" when importing type definitions.

Method Summary

TypeDefinitionDefaultView	createNewTypeDefinition(wt.ixb.handlers.forclasses.ExpImpForWTTypeDefinition handler, IxbElement fileXML, Importer importer, boolean checkin) This method creates and imports and persists a brand new Type Definition.
static String	getTargetContainerFromImporter(IxbElement fileXML, Importer importer) Get the internet domain name, after container mapping (if applicable) of the working container.
TypeDefinitionDefaultView	importToCheckedoutTypeDefinition(wt.ixb.handlers.forclasses.ExpImpForWTTypeDefinition handler, IxbElement fileXML, Importer importer, com.ptc.core.meta.type.mgmt.common.TypeDefinitionNodeView nodeView, boolean checkin, boolean removeIbas, boolean removeConstraints) This method import the attributes, including attributes for the type definition itself, its soft attributes (IBA values) as well as constraints (both constraints imposed on types and IBA values), to the type definition.
void	performPostExportAction(ClassExporterImporter handler, Exporter exporter, Object object, IxbElement fileXML) Perform check out action for the type definitions during export.
protected void	setLogicalIdentifier(TypeDefinitionDefaultView defView, IxbElement fileXML) Set logic identifier from XML file to the type definition.

Methods inherited from class wt.ixb.actor.ActorTemplate

createObject, performPreExportAction, previewObject, storeObject

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_FULL_PATH_2_INTERNET_DOMAIN_MAP

public static final String TYPE_FULL_PATH_2_INTERNET_DOMAIN_MAP

Key used in Importer's general context for target internet domains for each XML file to be imported.

Supported API: true

See Also:

Constant Field Values

XML_PARAM_NEW_PATH

protected static final String XML_PARAM_NEW_PATH

Tag to be used for import action "Substitute Object" when importing type definitions.

Supported API: true

See Also:

Constant Field Values

XML_PARAM_NEW_NAME

protected static final String XML_PARAM_NEW_NAME

Tag to be used for import actions "Substitute Object" and "Create New Object" when importing type definitions.

Supported API: true

See Also:

Constant Field Values

Method Detail

performPostExportAction

public void performPostExportAction(ClassExporterImporter handler,
                                    Exporter exporter,
                                    Object object,
                                    IxbElement fileXML)
                             throws WTException

Perform check out action for the type definitions during export. By default, if applicable only seed objects of type definitions will be checked out.

Supported API: true

Specified by:

performPostExportAction in interface Actor

Overrides:

performPostExportAction in class CheckOutActorTemplate

Parameters:

handler -

exporter - The Exporter instance that represents the context of the export operation.

object -

fileXML -

Throws:

WTException

createNewTypeDefinition

public TypeDefinitionDefaultView createNewTypeDefinition(wt.ixb.handlers.forclasses.ExpImpForWTTypeDefinition handler,
                                                         IxbElement fileXML,
                                                         Importer importer,
                                                         boolean checkin)
                                                  throws WTException

This method creates and imports and persists a brand new Type Definition.

Supported API: true

Parameters:

handler -

fileXML -

importer -

checkin - If this value is true, then the type definition will be checked in if it is checked out.

Returns:

TypeDefinitionDefaultView

Throws:

WTException

importToCheckedoutTypeDefinition

public TypeDefinitionDefaultView importToCheckedoutTypeDefinition(wt.ixb.handlers.forclasses.ExpImpForWTTypeDefinition handler,
                                                                  IxbElement fileXML,
                                                                  Importer importer,
                                                                  com.ptc.core.meta.type.mgmt.common.TypeDefinitionNodeView nodeView,
                                                                  boolean checkin,
                                                                  boolean removeIbas,
                                                                  boolean removeConstraints)
                                                           throws WTException

This method import the attributes, including attributes for the type definition itself, its soft attributes (IBA values) as well as constraints (both constraints imposed on types and IBA values), to the type definition. The type definition is assumed to be checked out prior to call this method.

Supported API: true

Parameters:

handler -

fileXML -

importer -

nodeView - The associated type definition should be checked out.

checkin - if set to true, the type definition will be checked in when import is done.

removeIbas - If set to true, all IBA values inherited from its predecessor type definition will be removed, keeping IBA values inherited from its parent type definition as well as the XML file.

removeConstraints - If set to true, all type constraints and IBA value constraints inherited from its predecessor type definition will be removed, keeping type constraints and IBA value constraints inherited from its parent type definition as well as the XML file.

Returns:

TypeDefinitionDefaultView

Throws:

WTException

setLogicalIdentifier

protected void setLogicalIdentifier(TypeDefinitionDefaultView defView,
                                    IxbElement fileXML)
                             throws WTException

Set logic identifier from XML file to the type definition.

Supported API: true

Parameters:

defView -

fileXML -

Throws:

WTException

getTargetContainerFromImporter

public static String getTargetContainerFromImporter(IxbElement fileXML,
                                                    Importer importer)
                                             throws WTException

Get the internet domain name, after container mapping (if applicable) of the working container. If the working container is not passed from client side, the container is set to the Exchange container.

Supported API: true

Parameters:

fileXML -

importer -

Returns:

String

Throws:

WTException