wt.viewmarkup
Class DerivedImage

java.lang.Object
  wt.viewmarkup.DerivedImage

All Implemented Interfaces:

Archiveable, ContentHolder, DomainAdministered, Externalizable, FormatContentHolder, Identified, NetFactor, ObjectMappable, Ownable, Persistable, Representation, Serializable, UniquelyIdentified, Viewable

public class DerivedImage

extends Object

implements Viewable, Ownable, UniquelyIdentified, Representation, Archiveable, Externalizable

A Representation viewable in ProductView that is generated (derived) from an object or information outside of the Representable. For example, a DerivedImage can be generated for a WTPart using an EPMDocument and EPMDocConfigSpec. To create a DerivedImage call ViewMarkUpHelper.service.storeDerivedImage() followed by ViewMarkUpHelper.service.postStoreDerivedImage() to insure proper initialization of objects. Do not call the constructor or newDerivedImage methods directly.

Use the newDerivedImage static factory method(s), not the DerivedImage 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: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	ADDITIONAL_INFO Label for the attribute.
private static int	ADDITIONAL_INFO_UPPER_LIMIT
private String	additionalInfo
static String	CADFORM_NAME Label for the attribute; The CAD Form Name that the Derived Image was create with.
private static int	CADFORM_NAME_UPPER_LIMIT
private String	CADFormName
static String	CADPART_NAME Label for the attribute; The CAD Part Name that the Derived Image was create with.
private static int	CADPART_NAME_UPPER_LIMIT
private String	CADPartName
private static String	CLASSNAME
private Vector	contentVector
private Boolean	defaultRepresentation
static String	DERIVATION_TYPE Label for the attribute.
private static int	DERIVATION_TYPE_UPPER_LIMIT
private DerivationType	derivationType
static String	DERIVED_FROM Label for the attribute.
static String	DERIVED_FROM_REFERENCE Label for the attribute.
private ObjectReference	derivedFromReference
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
private AdminDomainRef	domainRef
static long	EXTERNALIZATION_VERSION_UID
private DataFormatReference	format
private boolean	hasContents
private Vector	httpVector
private boolean	inheritedDomain
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private boolean	outOfDate
private Ownership	ownership
private ContentItem	primary
static String	REPRESENTABLE Label for the attribute.
private static int	REPRESENTATION_TYPE_UPPER_LIMIT
private RepresentationType	representationType
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo
private ObjectReference	theRepresentableReference

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.representation.Representation

DEFAULT_REPRESENTATION, OUT_OF_DATE, REPRESENTABLE_REFERENCE, REPRESENTATION_TYPE

Fields inherited from interface wt.content.FormatContentHolder

FORMAT, FORMAT_NAME, PRIMARY

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Constructor Summary

DerivedImage()

Method Summary

private void	additionalInfoValidate(String a_AdditionalInfo)
private void	CADFormNameValidate(String a_CADFormName)
private void	CADPartNameValidate(String a_CADPartName)
void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	defaultRepresentationValidate(Boolean a_DefaultRepresentation)
private void	derivationTypeValidate(DerivationType a_DerivationType)
private void	derivedFromReferenceValidate(ObjectReference a_DerivedFromReference)
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	formatValidate(DataFormatReference a_Format)
String	getAdditionalInfo() Gets the value of the attribute: ADDITIONAL_INFO.
String	getCADFormName() Gets the value of the attribute: CADFORM_NAME.
String	getCADPartName() Gets the value of the attribute: CADPART_NAME.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
Boolean	getDefaultRepresentation() Gets the value of the attribute: DEFAULT_REPRESENTATION.
DerivationType	getDerivationType() Gets the object for the association that plays role: DERIVATION_TYPE.
RepresentationContributor	getDerivedFrom() Gets the object for the association that plays role: DERIVED_FROM.
PersistableConfigSpec	getDerivedFromConfigSpec() Retrieves the object playing the role of derivedFromConfigSpec for the DerivedImage.
ObjectReference	getDerivedFromReference() Gets the value of the attribute: DERIVED_FROM_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
DataFormatReference	getFormat() Gets the object for the association that plays role: FORMAT.
String	getFormatName() Gets the value of the attribute: FORMAT_NAME.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object for a DerivedImage.
String	getIdentity() Supported API: false
String	getName() Gets the value of the attribute: NAME.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
ContentItem	getPrimary() Gets the value of the attribute: PRIMARY.
Representable	getRepresentable() Gets the object for the association that plays role: REPRESENTABLE.
PersistableConfigSpec	getRepresentableConfigSpec() Retrieves the object playing the role of representableConfigSpec for the DerivedImage.
ObjectReference	getRepresentableReference() Gets the value of the attribute: REPRESENTABLE_REFERENCE.
RepresentationType	getRepresentationType() Gets the object for the association that plays role: REPRESENTATION_TYPE.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String newName) Supports initialization, following construction of an instance.
boolean	isDefaultRepresentation() Returns true if defaultRepresentation attribute is true or false otherwise.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
boolean	isOutOfDate() Gets the value of the attribute: OUT_OF_DATE.
private void	nameValidate(String a_Name)
static DerivedImage	newDerivedImage(String newName) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(DerivedImage thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	representationTypeValidate(RepresentationType a_RepresentationType)
void	setAdditionalInfo(String a_AdditionalInfo) Sets the value of the attribute: ADDITIONAL_INFO.
void	setCADFormName(String a_CADFormName) Sets the value of the attribute: CADFORM_NAME.
void	setCADPartName(String a_CADPartName) Sets the value of the attribute: CADPART_NAME.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setDefaultRepresentation(Boolean a_DefaultRepresentation) Sets the value of the attribute: DEFAULT_REPRESENTATION.
void	setDerivationType(DerivationType a_DerivationType) Sets the object for the association that plays role: DERIVATION_TYPE.
void	setDerivedFrom(RepresentationContributor a_DerivedFrom) Sets the object for the association that plays role: DERIVED_FROM.
void	setDerivedFromReference(ObjectReference a_DerivedFromReference) Sets the value of the attribute: DERIVED_FROM_REFERENCE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
void	setFormat(DataFormatReference a_Format) Sets the object for the association that plays role: FORMAT.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setIdentificationObject(IdentificationObject identificationObject) The "back door" the DerivedImageIdentity uses to set the object attributes when they have been changed (legitimately) by the IdentityService.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
void	setOutOfDate(boolean a_OutOfDate) Sets the value of the attribute: OUT_OF_DATE.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setPrimary(ContentItem a_Primary) Sets the value of the attribute: PRIMARY.
void	setRepresentable(Representable a_Representable) Sets the object for the association that plays role: REPRESENTABLE.
void	setRepresentableReference(ObjectReference a_RepresentableReference) Sets the value of the attribute: REPRESENTABLE_REFERENCE.
void	setRepresentationType(RepresentationType a_RepresentationType) Sets the object for the association that plays role: REPRESENTATION_TYPE.
private void	theRepresentableReferenceValidate(ObjectReference a_RepresentableReference)
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

ADDITIONAL_INFO

public static final String ADDITIONAL_INFO

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ADDITIONAL_INFO_UPPER_LIMIT

private static int ADDITIONAL_INFO_UPPER_LIMIT

additionalInfo

private String additionalInfo

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

CADFORM_NAME

public static final String CADFORM_NAME

Label for the attribute; The CAD Form Name that the Derived Image was create with.

Supported API: false

See Also:

Constant Field Values

CADFORM_NAME_UPPER_LIMIT

private static int CADFORM_NAME_UPPER_LIMIT

CADFormName

private String CADFormName

CADPART_NAME

public static final String CADPART_NAME

Label for the attribute; The CAD Part Name that the Derived Image was create with.

Supported API: false

See Also:

Constant Field Values

CADPART_NAME_UPPER_LIMIT

private static int CADPART_NAME_UPPER_LIMIT

CADPartName

private String CADPartName

DERIVATION_TYPE

public static final String DERIVATION_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DERIVATION_TYPE_UPPER_LIMIT

private static int DERIVATION_TYPE_UPPER_LIMIT

derivationType

private DerivationType derivationType

DERIVED_FROM

public static final String DERIVED_FROM

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DERIVED_FROM_REFERENCE

public static final String DERIVED_FROM_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

derivedFromReference

private ObjectReference derivedFromReference

thePersistInfo

private PersistInfo thePersistInfo

ownership

private Ownership ownership

defaultRepresentation

private Boolean defaultRepresentation

outOfDate

private boolean outOfDate

REPRESENTATION_TYPE_UPPER_LIMIT

private static int REPRESENTATION_TYPE_UPPER_LIMIT

representationType

private RepresentationType representationType

REPRESENTABLE

public static final String REPRESENTABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theRepresentableReference

private ObjectReference theRepresentableReference

primary

private ContentItem primary

format

private DataFormatReference format

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

DerivedImage

public DerivedImage()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(DerivedImage thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Specified by:

getDescription in interface Representation

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Specified by:

setDescription in interface Representation

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getAdditionalInfo

public String getAdditionalInfo()

Gets the value of the attribute: ADDITIONAL_INFO.

Supported API: false

Returns:

String

setAdditionalInfo

public void setAdditionalInfo(String a_AdditionalInfo)
                       throws WTPropertyVetoException

Sets the value of the attribute: ADDITIONAL_INFO.

Supported API: false

Parameters:

a_AdditionalInfo -

Throws:

WTPropertyVetoException

additionalInfoValidate

private void additionalInfoValidate(String a_AdditionalInfo)
                             throws WTPropertyVetoException

Parameters:

a_AdditionalInfo -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Specified by:

getName in interface Representation

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Specified by:

setName in interface Representation

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getCADFormName

public String getCADFormName()

Gets the value of the attribute: CADFORM_NAME. The CAD Form Name that the Derived Image was create with.

Supported API: false

Returns:

String

setCADFormName

public void setCADFormName(String a_CADFormName)
                    throws WTPropertyVetoException

Sets the value of the attribute: CADFORM_NAME. The CAD Form Name that the Derived Image was create with.

Supported API: false

Parameters:

a_CADFormName -

Throws:

WTPropertyVetoException

CADFormNameValidate

private void CADFormNameValidate(String a_CADFormName)
                          throws WTPropertyVetoException

Parameters:

a_CADFormName -

Throws:

WTPropertyVetoException

getCADPartName

public String getCADPartName()

Gets the value of the attribute: CADPART_NAME. The CAD Part Name that the Derived Image was create with.

Supported API: false

Returns:

String

setCADPartName

public void setCADPartName(String a_CADPartName)
                    throws WTPropertyVetoException

Sets the value of the attribute: CADPART_NAME. The CAD Part Name that the Derived Image was create with.

Supported API: false

Parameters:

a_CADPartName -

Throws:

WTPropertyVetoException

CADPartNameValidate

private void CADPartNameValidate(String a_CADPartName)
                          throws WTPropertyVetoException

Parameters:

a_CADPartName -

Throws:

WTPropertyVetoException

getDerivationType

public DerivationType getDerivationType()

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

Supported API: false

Returns:

DerivationType

setDerivationType

public void setDerivationType(DerivationType a_DerivationType)
                       throws WTPropertyVetoException

Sets the object for the association that plays role: DERIVATION_TYPE.

Supported API: false

Parameters:

a_DerivationType -

Throws:

WTPropertyVetoException

derivationTypeValidate

private void derivationTypeValidate(DerivationType a_DerivationType)
                             throws WTPropertyVetoException

Parameters:

a_DerivationType -

Throws:

WTPropertyVetoException

getDerivedFrom

public RepresentationContributor getDerivedFrom()

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

Supported API: false

Returns:

RepresentationContributor

setDerivedFrom

public void setDerivedFrom(RepresentationContributor a_DerivedFrom)
                    throws WTPropertyVetoException,
                           WTException

Sets the object for the association that plays role: DERIVED_FROM.

Supported API: false

Parameters:

a_DerivedFrom -

Throws:

WTPropertyVetoException

WTException

getDerivedFromReference

public ObjectReference getDerivedFromReference()

Gets the value of the attribute: DERIVED_FROM_REFERENCE.

Supported API: false

Returns:

ObjectReference

setDerivedFromReference

public void setDerivedFromReference(ObjectReference a_DerivedFromReference)
                             throws WTPropertyVetoException

Sets the value of the attribute: DERIVED_FROM_REFERENCE.

Supported API: false

Parameters:

a_DerivedFromReference -

Throws:

WTPropertyVetoException

derivedFromReferenceValidate

private void derivedFromReferenceValidate(ObjectReference a_DerivedFromReference)
                                   throws WTPropertyVetoException

Parameters:

a_DerivedFromReference -

Throws:

WTPropertyVetoException

newDerivedImage

public static DerivedImage newDerivedImage(String newName)
                                    throws WTPropertyVetoException

Supported API: false

Parameters:

newName -

Returns:

DerivedImage

Throws:

WTPropertyVetoException

initialize

protected void initialize(String newName)
                   throws WTPropertyVetoException

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

Supported API: false

Parameters:

newName -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object for a DerivedImage.

Supported API: false

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

setIdentificationObject

public void setIdentificationObject(IdentificationObject identificationObject)
                             throws WTException

The "back door" the DerivedImageIdentity uses to set the object attributes when they have been changed (legitimately) by the IdentityService. It directly sets name, type, Representable, and create timestamp, avoiding an exception that would be thrown by their validate methods (because the DerivedImage has been persisted.)

Supported API: false

Parameters:

identificationObject -

Throws:

WTException

getRepresentableConfigSpec

public PersistableConfigSpec getRepresentableConfigSpec()
                                                 throws WTException

Retrieves the object playing the role of representableConfigSpec for the DerivedImage. Returns null if none is found.

Supported API: false

Returns:

PersistableConfigSpec

Throws:

WTException

getDerivedFromConfigSpec

public PersistableConfigSpec getDerivedFromConfigSpec()
                                               throws WTException

Retrieves the object playing the role of derivedFromConfigSpec for the DerivedImage. Returns null if none is found.

Supported API: false

Returns:

PersistableConfigSpec

Throws:

WTException

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

Sets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

getDefaultRepresentation

public Boolean getDefaultRepresentation()

Gets the value of the attribute: DEFAULT_REPRESENTATION.

Supported API: false

Specified by:

getDefaultRepresentation in interface Representation

Returns:

Boolean

setDefaultRepresentation

public void setDefaultRepresentation(Boolean a_DefaultRepresentation)
                              throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_REPRESENTATION.

Supported API: false

Specified by:

setDefaultRepresentation in interface Representation

Parameters:

a_DefaultRepresentation -

Throws:

WTPropertyVetoException

defaultRepresentationValidate

private void defaultRepresentationValidate(Boolean a_DefaultRepresentation)
                                    throws WTPropertyVetoException

Parameters:

a_DefaultRepresentation -

Throws:

WTPropertyVetoException

isOutOfDate

public boolean isOutOfDate()

Gets the value of the attribute: OUT_OF_DATE. Has the Representation be made out of date by changes to other objects?

Supported API: false

Specified by:

isOutOfDate in interface Representation

Returns:

boolean

setOutOfDate

public void setOutOfDate(boolean a_OutOfDate)
                  throws WTPropertyVetoException

Sets the value of the attribute: OUT_OF_DATE. Has the Representation be made out of date by changes to other objects?

Supported API: false

Specified by:

setOutOfDate in interface Representation

Parameters:

a_OutOfDate -

Throws:

WTPropertyVetoException

isDefaultRepresentation

public boolean isDefaultRepresentation()

Returns true if defaultRepresentation attribute is true or false otherwise.

Supported API: false

Specified by:

isDefaultRepresentation in interface Representation

Returns:

boolean

getRepresentationType

public RepresentationType getRepresentationType()

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

Supported API: false

Specified by:

getRepresentationType in interface Representation

Returns:

RepresentationType

setRepresentationType

public void setRepresentationType(RepresentationType a_RepresentationType)
                           throws WTPropertyVetoException

Sets the object for the association that plays role: REPRESENTATION_TYPE.

Supported API: false

Specified by:

setRepresentationType in interface Representation

Parameters:

a_RepresentationType -

Throws:

WTPropertyVetoException

representationTypeValidate

private void representationTypeValidate(RepresentationType a_RepresentationType)
                                 throws WTPropertyVetoException

Parameters:

a_RepresentationType -

Throws:

WTPropertyVetoException

getRepresentable

public Representable getRepresentable()

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

Supported API: false

Specified by:

getRepresentable in interface Representation

Returns:

Representable

setRepresentable

public void setRepresentable(Representable a_Representable)
                      throws WTPropertyVetoException,
                             WTException

Sets the object for the association that plays role: REPRESENTABLE.

Supported API: false

Specified by:

setRepresentable in interface Representation

Parameters:

a_Representable -

Throws:

WTPropertyVetoException

WTException

getRepresentableReference

public ObjectReference getRepresentableReference()

Gets the value of the attribute: REPRESENTABLE_REFERENCE.

Supported API: false

Specified by:

getRepresentableReference in interface Representation

Returns:

ObjectReference

setRepresentableReference

public void setRepresentableReference(ObjectReference a_RepresentableReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: REPRESENTABLE_REFERENCE.

Supported API: false

Specified by:

setRepresentableReference in interface Representation

Parameters:

a_RepresentableReference -

Throws:

WTPropertyVetoException

theRepresentableReferenceValidate

private void theRepresentableReferenceValidate(ObjectReference a_RepresentableReference)
                                        throws WTPropertyVetoException

Parameters:

a_RepresentableReference -

Throws:

WTPropertyVetoException

getFormatName

public String getFormatName()

Gets the value of the attribute: FORMAT_NAME.

Supported API: false

Specified by:

getFormatName in interface FormatContentHolder

Returns:

String

getPrimary

public ContentItem getPrimary()

Gets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getPrimary in interface FormatContentHolder

Returns:

ContentItem

setPrimary

public void setPrimary(ContentItem a_Primary)
                throws WTPropertyVetoException

Sets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setPrimary in interface FormatContentHolder

Parameters:

a_Primary -

Throws:

WTPropertyVetoException

getFormat

public DataFormatReference getFormat()

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

Supported API: false

Specified by:

getFormat in interface FormatContentHolder

Returns:

DataFormatReference

setFormat

public void setFormat(DataFormatReference a_Format)
               throws WTPropertyVetoException

Sets the object for the association that plays role: FORMAT.

Supported API: false

Specified by:

setFormat in interface FormatContentHolder

Parameters:

a_Format -

Throws:

WTPropertyVetoException

formatValidate

private void formatValidate(DataFormatReference a_Format)
                     throws WTPropertyVetoException

Parameters:

a_Format -

Throws:

WTPropertyVetoException

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

isInheritedDomain

public boolean isInheritedDomain()

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

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

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

Sets the object for the association that plays role: DOMAIN_REF.

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Returns:

int