Package wt.epm.build

Class EPMBuildRule

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.vc._VersionToVersionLink

wt.vc.VersionToVersionLink

wt.epm.build._EPMBuildRule

wt.epm.build.EPMBuildRule

All Implemented Interfaces:

Externalizable, Serializable, wt.build._BuildRule, wt.build.BuildRule, wt.epm._EPMObject, EPMObject, wt.fc._BinaryLink, wt.fc._Link, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.archive._Archiveable, wt.fc.archive.Archiveable, BinaryLink, Link, NetFactor, ObjectMappable, Persistable, DisplayIdentification

@GenAsBinaryLink(superClass=VersionToVersionLink.class,interfaces={EPMObject.class,wt.build.BuildRule.class,wt.fc.archive.Archiveable.class},versions={5029331757957183836L,-2114693163325197590L},properties={@GeneratedProperty(name="uniqueID",type=long.class,supportedAPI=PUBLIC,javaDoc="A unique ID, automatically maintained by the system, that distinguishes one build rule  from another.",constraints=@PropertyConstraints(changeable=FROZEN,required=true)),@GeneratedProperty(name="buildType",type=int.class,initialValue="EPMBuildRule.ALL_BUILD_ROLES",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="attributesOnTarget",type=int.class,initialValue="EPMBuildRule.DEFAULT",accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="attributesOnLink",type=int.class,initialValue="EPMBuildRule.DEFAULT",accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="attributesOnOccurrence",type=int.class,initialValue="EPMBuildRule.DEFAULT",accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="attributesOnMaster",type=int.class,initialValue="EPMBuildRule.DEFAULT",accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="modelItemMasterReference",type=ObjectReference.class,constraints=@PropertyConstraints(required=true))},roleA=@GeneratedRole(name="buildSource",type=EPMDocument.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(getAccess=PRIVATE),owner=false,cascade=false),roleB=@GeneratedRole(name="buildTarget",type=WTPart.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(getAccess=PRIVATE),cascade=false),tableProperties=@TableProperties(tableName="EPMBuildRule"))
public class EPMBuildRule
extends _EPMBuildRule

EPMBuildRule decides what data from the build source to publish to the build target and how to publish them.

Use the newEPMBuildRule static factory method(s), not the EPMBuildRule constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BUILD_ATTRIBUTES	Supported API: true
static final int	BUILD_STRUCTURE	Supported API: true
static final int	CAD_REPRESENTATION	Supported API: true

Fields inherited from class wt.epm.build._EPMBuildRule

UNIQUE_ID

Method Summary

Modifier and Type	Method	Description
EPMAuthoringAppType	getAuthoringApplication()	Gets the value of the attribute: AUTHORING_APPLICATION.
EPMApplicationType	getOwnerApplication()	Gets the value of the attribute: OWNER_APPLICATION.
protected void	initialize(EPMDocument container, ModelItem source, WTPart target, int buildType)	Supports initialization, following construction of an instance.
static EPMBuildRule	newEPMBuildRule(EPMDocument container, ModelItem source, WTPart target, int buildType)	api to create build rule for ModelItem.
static EPMBuildRule	newEPMBuildRule(EPMDocument source, WTPart target)	Supported API: true
static EPMBuildRule	newEPMBuildRule(EPMDocument source, WTPart target, int buildType)	Supported API: true

Methods inherited from class wt.epm.build._EPMBuildRule

getUniqueID, setUniqueID

Methods inherited from class wt.vc.VersionToVersionLink

duplicate, getAllObjects, getRoleObject, initialize, setRoleAObject, setRoleBObject, setRoleObject

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.BinaryLink

getLinkInfo, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleBObject, getRoleBObjectId, setRoleAObject, setRoleBObject

Methods inherited from interface wt.fc.Link

appendJoinCriteria, appendRoleCriteria, getAllObjects, getJoinValues, getRoleIdName, getRoleObject, setRoleObject

Field Details

BUILD_STRUCTURE

public static final int BUILD_STRUCTURE

Supported API: true

See Also:

• Constant Field Values

BUILD_ATTRIBUTES

public static final int BUILD_ATTRIBUTES

Supported API: true

See Also:

• Constant Field Values

CAD_REPRESENTATION

public static final int CAD_REPRESENTATION

Supported API: true

See Also:

• Constant Field Values

Method Details

newEPMBuildRule

public static EPMBuildRule newEPMBuildRule(EPMDocument source,
 WTPart target)
                                    throws WTException

Supported API: true

Parameters:

source - source EPMDocument

target - target part

Returns:

EPMBuildRule

Throws:

WTException

newEPMBuildRule

public static EPMBuildRule newEPMBuildRule(EPMDocument source,
 WTPart target,
 int buildType)
                                    throws WTException

Supported API: true

Parameters:

source - source EPMDocument

target - target part.

buildType - type of the build rule. Combination of the constants (BUILD_STRUCTURE, BUILD_ATTRIBUTES and CAD_REPRESENTATION).

Returns:

EPMBuildRule

Throws:

WTException

newEPMBuildRule

public static EPMBuildRule newEPMBuildRule(EPMDocument container,
 ModelItem source,
 WTPart target,
 int buildType)
                                    throws WTException

api to create build rule for ModelItem. constructor to create EPMBuildRule between given 'source' ModelItem and 'target' WTPart. Actual build rule will be created between 'container' EPMDocument and 'target' part and modelItemMasterReference will be set to ModelItemMaster of the 'source' ModelItem.

Supported API: true

Parameters:

container - Container document dor the given 'source' modle item

source - source model item

target - target part.

buildType - type of the build rule. Combination of the constants (BUILD_STRUCTURE, BUILD_ATTRIBUTES and CAD_REPRESENTATION).

Returns:

EPMBuildRule

Throws:

WTException

initialize

protected void initialize(EPMDocument container,
 ModelItem source,
 WTPart target,
 int buildType)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

container - Container document dor the given 'source' modle item

source - source model item

target - target part.

buildType - type of the build rule. Combination of the constants (BUILD_STRUCTURE, BUILD_ATTRIBUTES and CAD_REPRESENTATION).

Throws:

WTException

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Gets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

Returns:

EPMApplicationType

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

Returns:

EPMAuthoringAppType