wt.content
Class URLData

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.content.ContentItem
          extended bywt.content.URLData
All Implemented Interfaces:
BusinessInformation, DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Revaultable, Serializable, UniquelyIdentifiedContent
Direct Known Subclasses:
ProxyURLData

public class URLData
extends ContentItem
implements Revaultable, UniquelyIdentifiedContent, Externalizable

This allows a URL link to be attached to a ContentHolder

Use the newURLData static factory method(s), not the URLData 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
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
private  long revaultSessionId
           
(package private) static long serialVersionUID
           
private  long streamId
           
static String URL_LOCATION
          Label for the attribute; Holds the URL string.
private static int URL_LOCATION_UPPER_LIMIT
           
private  String urlLocation
           
 
Fields inherited from class wt.content.ContentItem
CATEGORY, CREATED_BY, DESCRIPTION, FORMAT, FORMAT_NAME, HOLDER_LINK, INTENT_TO_CHANGE, ROLE, STALE
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.fv.Revaultable
INITIAL_VALUE, REVAULT_SESSION_ID
 
Fields inherited from interface wt.fv.UniquelyIdentifiedContent
STREAM_ID
 
Fields inherited from interface wt.fc.BusinessInformation
BUSINESS_TYPE, IDENTITY
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Fields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
URLData()
           
 
Method Summary
 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 getIdentity()
          

Supported API: false
 long getRevaultSessionId()
          Gets the value of the attribute: REVAULT_SESSION_ID.
 long getStreamId()
          Gets the value of the attribute: STREAM_ID.
 String getUrlLocation()
          Gets the value of the attribute: URL_LOCATION.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize(ContentHolder holder)
          Supports initialization, following construction of an instance.
static URLData newURLData(ContentHolder holder)
          Instatiates a new URLData object based on a ContentHolder

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(URLData thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setRevaultSessionId(long a_RevaultSessionId)
          Sets the value of the attribute: REVAULT_SESSION_ID.
 void setStreamId(long a_StreamId)
          Sets the value of the attribute: STREAM_ID.
 void setUrlLocation(String a_UrlLocation)
          Sets the value of the attribute: URL_LOCATION.
private  void urlLocationValidate(String a_UrlLocation)
           
 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.content.ContentItem
getBusinessType, getCategory, getCreatedBy, getDescription, getFormat, getFormatName, getHolderLink, getIntentToChange, getRole, isStale, readVersion, setCategory, setCreatedBy, setDescription, setFormat, setFormatName, setHolderLink, setIntentToChange, setRole, setStale
 
Methods inherited from class wt.fc.WTObject
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString
 
Methods inherited from class java.lang.Object
clone, 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

URL_LOCATION

public static final String URL_LOCATION
Label for the attribute; Holds the URL string.

Supported API: true

See Also:
Constant Field Values

URL_LOCATION_UPPER_LIMIT

private static int URL_LOCATION_UPPER_LIMIT

urlLocation

private String urlLocation

revaultSessionId

private long revaultSessionId

streamId

private long streamId

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

URLData

public URLData()
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 ContentItem
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 ContentItem
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

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

getUrlLocation

public String getUrlLocation()
Gets the value of the attribute: URL_LOCATION. Holds the URL string.

Supported API: true

Returns:
String

setUrlLocation

public void setUrlLocation(String a_UrlLocation)
                    throws WTPropertyVetoException
Sets the value of the attribute: URL_LOCATION. Holds the URL string.

Supported API: true

Parameters:
a_UrlLocation -
Throws:
WTPropertyVetoException

urlLocationValidate

private void urlLocationValidate(String a_UrlLocation)
                          throws WTPropertyVetoException
Parameters:
a_UrlLocation -
Throws:
WTPropertyVetoException

newURLData

public static URLData newURLData(ContentHolder holder)
                          throws WTException
Instatiates a new URLData object based on a ContentHolder

Supported API: false

Parameters:
holder -
Returns:
URLData
Throws:
WTException

initialize

protected void initialize(ContentHolder holder)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
holder -
Throws:
WTException

getIdentity

public String getIdentity()


Supported API: false

Specified by:
getIdentity in interface BusinessInformation
Overrides:
getIdentity in class ContentItem
Returns:
String

getRevaultSessionId

public long getRevaultSessionId()
Gets the value of the attribute: REVAULT_SESSION_ID.

Supported API: false

Specified by:
getRevaultSessionId in interface Revaultable
Returns:
long

setRevaultSessionId

public void setRevaultSessionId(long a_RevaultSessionId)
Sets the value of the attribute: REVAULT_SESSION_ID.

Supported API: false

Specified by:
setRevaultSessionId in interface Revaultable
Parameters:
a_RevaultSessionId -

getStreamId

public long getStreamId()
Gets the value of the attribute: STREAM_ID.

Supported API: false

Specified by:
getStreamId in interface UniquelyIdentifiedContent
Returns:
long

setStreamId

public void setStreamId(long a_StreamId)
Sets the value of the attribute: STREAM_ID.

Supported API: false

Specified by:
setStreamId in interface UniquelyIdentifiedContent
Parameters:
a_StreamId -

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 ContentItem
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 ContentItem
Returns:
int