com.ptc.windchill.uwgm.proesrv.ndimpl
Class ProENDDocument

java.lang.Object
  com.ptc.windchill.uwgm.proesrv.ndimpl.ProENDDocument

All Implemented Interfaces:

EPMNDDocument, EPMNDObject

Direct Known Subclasses:

ProENDDocument_J01, ProENDDocument_J03

public abstract class ProENDDocument

extends Object

implements EPMNDDocument

Field Summary

private CacheDocument	cacheDoc
protected String	cadName
private WTContainer	container
private static boolean	dropNameExtension
private static boolean	dropNumberExtension
private EPMAuthoringAppVersion	epmAuthAppVersion
protected com.ptc.windchill.uwgm.soap.uwgmdb.EpmIterationInfo	epmIterationInfo
protected com.ptc.windchill.uwgm.soap.uwgmdb.EpmMasterInfo	epmMasterInfo
private boolean	isNew
protected boolean	isPlaceHolder
protected com.ptc.windchill.uwgm.soap.uwgmdb.EpmIteration	it
protected static Log	log
private String	name
private String	number
private static ObjectIdentifierHelper	oidHelper
private WTOrganization	organization
private static String	PROE_NAME_PARAM
private static String	PROE_NUMBER_PARAM
protected static String	PTC_COMMON_NAME
private int	revNum
protected ProENeutralData	uploadInfo

Fields inherited from interface wt.epm.ndi.EPMNDObject

OBJECT_ID

Constructor Summary

ProENDDocument(ProENeutralData uploadInfo, com.ptc.windchill.uwgm.soap.uwgmdb.EpmIteration it)

Method Summary

EPMAuthoringAppVersion	getAuthoringApplicationVersion() Gets the value of the attribute: authoringApplicationVersion.
CacheDocument	getCacheDocument()
String	getCadName() Gets the value of the attribute: cadName.
WTContainer	getContainer() Gets the value of the attribute: container.
int	getDbKeySize() Gets the value of the attribute: dbKeySize.
QuantityUnit	getDefaultUnit() Gets the value of the attribute: defaultUnit.
private com.ptc.windchill.uwgm.soap.uwgmdb.EpmIterationInfo	getEpmIterationInfo()
private com.ptc.windchill.uwgm.soap.uwgmdb.EpmMasterInfo	getEpmMasterInfo()
String	getGenericName()
String	getInstanceName()
ObjectIdentifier	getIterationObjectId() Gets the value of the attribute: iterationObjectId.
ObjectIdentifier	getMasterObjectId() Gets the value of the attribute: masterObjectId.
String	getName() Gets the value of the attribute: name.
private String	getNDVersion()
String	getNumber() Gets the value of the attribute: number.
ObjectIdentifier	getObjectId() Gets the value of the attribute: OBJECT_ID.
WTOrganization	getOrganization() Gets the value of the attribute: organization.
EPMNDReferenceControl	getReferenceControl() Gets the object for the association that plays role: referenceControl.
int	getRevNum() Gets the value of the attribute: revNum; [optional] Supported API: false
String	getSubType() Gets the value of the attribute: subType; [optional] Supported API: false
String	getType() Gets the value of the attribute: type.
int	getUpdateCounter() Gets the value of the attribute: updateCounter; Returns update counter for ND document.
private void	initDocumentNameAndNumber(Collection parameters)
boolean	isGeneric()
boolean	isInstance()
boolean	isNew()
boolean	isPlaceHolder()
boolean	isTopGeneric()
boolean	isVerified() Gets the value of the attribute: verified; [optional] Supported API: false
void	setPersistable(CacheDocument obj)

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.epm.ndi.EPMNDDocument

getAttributes, getDependencies

Field Detail

epmAuthAppVersion

private EPMAuthoringAppVersion epmAuthAppVersion

organization

private WTOrganization organization

container

private WTContainer container

uploadInfo

protected ProENeutralData uploadInfo

it

protected com.ptc.windchill.uwgm.soap.uwgmdb.EpmIteration it

epmMasterInfo

protected com.ptc.windchill.uwgm.soap.uwgmdb.EpmMasterInfo epmMasterInfo

epmIterationInfo

protected com.ptc.windchill.uwgm.soap.uwgmdb.EpmIterationInfo epmIterationInfo

revNum

private int revNum

cadName

protected String cadName

name

private String name

number

private String number

isNew

private boolean isNew

isPlaceHolder

protected boolean isPlaceHolder

log

protected static Log log

PROE_NAME_PARAM

private static String PROE_NAME_PARAM

PROE_NUMBER_PARAM

private static String PROE_NUMBER_PARAM

dropNameExtension

private static boolean dropNameExtension

dropNumberExtension

private static boolean dropNumberExtension

PTC_COMMON_NAME

protected static final String PTC_COMMON_NAME

See Also:

Constant Field Values

oidHelper

private static ObjectIdentifierHelper oidHelper

cacheDoc

private CacheDocument cacheDoc

Constructor Detail

ProENDDocument

public ProENDDocument(ProENeutralData uploadInfo,
                      com.ptc.windchill.uwgm.soap.uwgmdb.EpmIteration it)

Method Detail

getMasterObjectId

public ObjectIdentifier getMasterObjectId()
                                   throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: masterObjectId.

Supported API: true

Specified by:

getMasterObjectId in interface EPMNDDocument

Returns:

ObjectIdentifier

Throws:

WTException

getObjectId

public ObjectIdentifier getObjectId()
                             throws WTException

Description copied from interface: EPMNDObject

Gets the value of the attribute: OBJECT_ID.

Supported API: true

Specified by:

getObjectId in interface EPMNDObject

Returns:

ObjectIdentifier

Throws:

WTException

getIterationObjectId

public ObjectIdentifier getIterationObjectId()
                                      throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: iterationObjectId.

Supported API: true

Specified by:

getIterationObjectId in interface EPMNDDocument

Returns:

ObjectIdentifier

Throws:

WTException

getCadName

public String getCadName()
                  throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: cadName.

Supported API: true

Specified by:

getCadName in interface EPMNDDocument

Returns:

String

Throws:

WTException

getNumber

public String getNumber()
                 throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: number.

Supported API: true

Specified by:

getNumber in interface EPMNDDocument

Returns:

String

Throws:

WTException

getName

public String getName()
               throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: name.

Supported API: false

Specified by:

getName in interface EPMNDDocument

Returns:

String

Throws:

WTException

getType

public String getType()
               throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: type.

Supported API: false

Specified by:

getType in interface EPMNDDocument

Returns:

String

Throws:

WTException

getSubType

public String getSubType()
                  throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: subType; [optional]

Supported API: false

Specified by:

getSubType in interface EPMNDDocument

Returns:

String

Throws:

WTException

getRevNum

public int getRevNum()
              throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: revNum; [optional]

Supported API: false

Specified by:

getRevNum in interface EPMNDDocument

Returns:

int

Throws:

WTException

getEpmMasterInfo

private com.ptc.windchill.uwgm.soap.uwgmdb.EpmMasterInfo getEpmMasterInfo()

getEpmIterationInfo

private com.ptc.windchill.uwgm.soap.uwgmdb.EpmIterationInfo getEpmIterationInfo()

getAuthoringApplicationVersion

public EPMAuthoringAppVersion getAuthoringApplicationVersion()
                                                      throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: authoringApplicationVersion.

Supported API: true

Specified by:

getAuthoringApplicationVersion in interface EPMNDDocument

Returns:

EPMAuthoringAppVersion

Throws:

WTException

getUpdateCounter

public int getUpdateCounter()
                     throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: updateCounter; Returns update counter for ND document. If ND document update counter different then EPMDocument update counter overridable conflict will be generated. If ND document update counter equals -1 upload service ignore it value.

Supported API: true

Specified by:

getUpdateCounter in interface EPMNDDocument

Returns:

int

Throws:

WTException

getDefaultUnit

public QuantityUnit getDefaultUnit()
                            throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: defaultUnit.

Supported API: true

Specified by:

getDefaultUnit in interface EPMNDDocument

Returns:

QuantityUnit

Throws:

WTException

getContainer

public WTContainer getContainer()
                         throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: container.

Supported API: true

Specified by:

getContainer in interface EPMNDDocument

Returns:

WTContainer

Throws:

WTException

getOrganization

public WTOrganization getOrganization()
                               throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: organization.

Supported API: true

Specified by:

getOrganization in interface EPMNDDocument

Returns:

WTOrganization

Throws:

WTException

isGeneric

public boolean isGeneric()

isInstance

public boolean isInstance()

isTopGeneric

public boolean isTopGeneric()

getNDVersion

private String getNDVersion()

getGenericName

public String getGenericName()

getInstanceName

public String getInstanceName()

isNew

public boolean isNew()

isVerified

public boolean isVerified()
                   throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: verified; [optional]

Supported API: false

Specified by:

isVerified in interface EPMNDDocument

Returns:

boolean

Throws:

WTException

getDbKeySize

public int getDbKeySize()
                 throws WTException

Description copied from interface: EPMNDDocument

Gets the value of the attribute: dbKeySize.

Supported API: true

Specified by:

getDbKeySize in interface EPMNDDocument

Returns:

int

Throws:

WTException

getReferenceControl

public EPMNDReferenceControl getReferenceControl()
                                          throws WTException

Description copied from interface: EPMNDDocument

Gets the object for the association that plays role: referenceControl.

Supported API: true

Specified by:

getReferenceControl in interface EPMNDDocument

Returns:

EPMNDReferenceControl

Throws:

WTException

initDocumentNameAndNumber

private void initDocumentNameAndNumber(Collection parameters)
                                throws WTException

Throws:

WTException

isPlaceHolder

public boolean isPlaceHolder()

setPersistable

public void setPersistable(CacheDocument obj)

getCacheDocument

public CacheDocument getCacheDocument()