wt.rn
Class WTRNRequest

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.FolderResident
          wt.rn.WTRNRequest

All Implemented Interfaces:

AccessControlled, BusinessInformation, CabinetBased, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, Serializable

public class WTRNRequest

extends FolderResident

implements Externalizable

The WTRNRequest object is used to store information relating to a specific RosettaNet request.

Use the newWTRNRequest static factory method(s), not the WTRNRequest 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: true

See Also:

Serialized Form

Field Summary

static String	ACKNOWLEDGEMENT_RECEIVED Label for the attribute.
private boolean	acknowledgementReceived
private static String	CLASSNAME
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
static String	DISPLAY_URL Label for the attribute.
private static int	DISPLAY_URL_UPPER_LIMIT
private String	displayURL
static String	EXCEPTION_RECEIVED Label for the attribute.
private boolean	exceptionReceived
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
static String	RESPONSE_RECEIVED Label for the attribute.
private boolean	responseReceived
(package private) static long	serialVersionUID

Fields inherited from class wt.enterprise.FolderResident

CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTRNRequest()

Method Summary

private void	descriptionValidate(String a_Description)
private void	displayURLValidate(String a_DisplayURL)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getDisplayURL() Gets the value of the attribute: DISPLAY_URL.
String	getName() Gets the value of the attribute: NAME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isAcknowledgementReceived() Gets the value of the attribute: ACKNOWLEDGEMENT_RECEIVED.
boolean	isExceptionReceived() Gets the value of the attribute: EXCEPTION_RECEIVED.
boolean	isResponseReceived() Gets the value of the attribute: RESPONSE_RECEIVED.
private void	nameValidate(String a_Name)
static WTRNRequest	newWTRNRequest() Default factory for the class.
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(WTRNRequest thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAcknowledgementReceived(boolean a_AcknowledgementReceived) Sets the value of the attribute: ACKNOWLEDGEMENT_RECEIVED.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setDisplayURL(String a_DisplayURL) Sets the value of the attribute: DISPLAY_URL.
void	setExceptionReceived(boolean a_ExceptionReceived) Sets the value of the attribute: EXCEPTION_RECEIVED.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setResponseReceived(boolean a_ResponseReceived) Sets the value of the attribute: RESPONSE_RECEIVED.
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 wt.enterprise.FolderResident

getBusinessType, getCabinet, getCabinetName, getCabinetReference, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEventSet, getFolderingInfo, getFolderPath, getIdentity, getLocation, getOwnership, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setFolderingInfo, setInheritedDomain, setOwnership

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

DISPLAY_URL

public static final String DISPLAY_URL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DISPLAY_URL_UPPER_LIMIT

private static int DISPLAY_URL_UPPER_LIMIT

displayURL

private String displayURL

ACKNOWLEDGEMENT_RECEIVED

public static final String ACKNOWLEDGEMENT_RECEIVED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

acknowledgementReceived

private boolean acknowledgementReceived

RESPONSE_RECEIVED

public static final String RESPONSE_RECEIVED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

responseReceived

private boolean responseReceived

EXCEPTION_RECEIVED

public static final String EXCEPTION_RECEIVED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

exceptionReceived

private boolean exceptionReceived

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

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

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

WTRNRequest

public WTRNRequest()

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

Overrides:

writeExternal in class FolderResident

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

Overrides:

readExternal in class FolderResident

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTRNRequest 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

Overrides:

writeExternal in class FolderResident

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

Overrides:

readExternal in class FolderResident

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

getDisplayURL

public String getDisplayURL()

Gets the value of the attribute: DISPLAY_URL.

Supported API: false

Returns:

String

setDisplayURL

public void setDisplayURL(String a_DisplayURL)
                   throws WTPropertyVetoException

Sets the value of the attribute: DISPLAY_URL.

Supported API: false

Parameters:

a_DisplayURL -

Throws:

WTPropertyVetoException

displayURLValidate

private void displayURLValidate(String a_DisplayURL)
                         throws WTPropertyVetoException

Parameters:

a_DisplayURL -

Throws:

WTPropertyVetoException

isAcknowledgementReceived

public boolean isAcknowledgementReceived()

Gets the value of the attribute: ACKNOWLEDGEMENT_RECEIVED.

Supported API: false

Returns:

boolean

setAcknowledgementReceived

public void setAcknowledgementReceived(boolean a_AcknowledgementReceived)
                                throws WTPropertyVetoException

Sets the value of the attribute: ACKNOWLEDGEMENT_RECEIVED.

Supported API: false

Parameters:

a_AcknowledgementReceived -

Throws:

WTPropertyVetoException

isResponseReceived

public boolean isResponseReceived()

Gets the value of the attribute: RESPONSE_RECEIVED.

Supported API: false

Returns:

boolean

setResponseReceived

public void setResponseReceived(boolean a_ResponseReceived)
                         throws WTPropertyVetoException

Sets the value of the attribute: RESPONSE_RECEIVED.

Supported API: false

Parameters:

a_ResponseReceived -

Throws:

WTPropertyVetoException

isExceptionReceived

public boolean isExceptionReceived()

Gets the value of the attribute: EXCEPTION_RECEIVED.

Supported API: false

Returns:

boolean

setExceptionReceived

public void setExceptionReceived(boolean a_ExceptionReceived)
                          throws WTPropertyVetoException

Sets the value of the attribute: EXCEPTION_RECEIVED.

Supported API: false

Parameters:

a_ExceptionReceived -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Specified by:

getName in interface CabinetBased

Overrides:

getName in class FolderResident

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

newWTRNRequest

public static WTRNRequest newWTRNRequest()
                                  throws WTException

Default factory for the class.

Supported API: false

Returns:

WTRNRequest

Throws:

WTException

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

Overrides:

equals in class FolderResident

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

Overrides:

hashCode in class FolderResident

Returns:

int