wt.occurrence
Class UsesOccurrenceForeignKey

java.lang.Object
  extended bywt.occurrence.UsesOccurrenceForeignKey
All Implemented Interfaces:
Externalizable, NetFactor, ObjectMappable, QueryKey, Serializable

public class UsesOccurrenceForeignKey
extends Object
implements QueryKey, Externalizable

This key is used to identify a UsesOccurrence.

Use the newUsesOccurrenceForeignKey static factory method(s), not the UsesOccurrenceForeignKey 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  String classname
           
private static String CLASSNAME
           
private static int CLASSNAME_UPPER_LIMIT
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
static String USES_ID
          Label for the attribute.
private  long usesId
           
 
Constructor Summary
UsesOccurrenceForeignKey()
           
 
Method Summary
 QuerySpec appendKeyCriteria(QuerySpec qs)
          

Supported API: false
 boolean equals(Object obj)
          

Supported API: false
 ClassInfo getClassInfo()
          Returns the ClassInfo object for this class.
 String getClassname()
          Gets the value of the attribute: CLASSNAME.
 String getConceptualClassname()
          Deprecated.  
 long getUsesId()
          Gets the value of the attribute: USES_ID.
 int hashCode()
          

Supported API: false
protected  void initialize(Class target, long usesOccurrenceIdentifier)
          

Supported API: false
static UsesOccurrenceForeignKey newUsesOccurrenceForeignKey(Class target, long usesOccurrenceIdentifier)
          

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(UsesOccurrenceForeignKey thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setClassname(String a_Classname)
          Sets the value of the attribute: CLASSNAME.
 void setUsesId(long a_UsesId)
          Sets the value of the attribute: USES_ID.
 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

USES_ID

public static final String USES_ID
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

usesId

private long usesId

CLASSNAME_UPPER_LIMIT

private static int CLASSNAME_UPPER_LIMIT

classname

private String classname

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

UsesOccurrenceForeignKey

public UsesOccurrenceForeignKey()
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(UsesOccurrenceForeignKey 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

getUsesId

public long getUsesId()
Gets the value of the attribute: USES_ID.

Supported API: false

Returns:
long

setUsesId

public void setUsesId(long a_UsesId)
Sets the value of the attribute: USES_ID.

Supported API: false

Parameters:
a_UsesId -

newUsesOccurrenceForeignKey

public static UsesOccurrenceForeignKey newUsesOccurrenceForeignKey(Class target,
                                                                   long usesOccurrenceIdentifier)
                                                            throws WTException


Supported API: false

Parameters:
target -
usesOccurrenceIdentifier -
Returns:
UsesOccurrenceForeignKey
Throws:
WTException

equals

public boolean equals(Object obj)


Supported API: false

Specified by:
equals in interface QueryKey
Parameters:
obj -
Returns:
boolean

hashCode

public int hashCode()


Supported API: false

Specified by:
hashCode in interface QueryKey
Returns:
int

appendKeyCriteria

public QuerySpec appendKeyCriteria(QuerySpec qs)
                            throws WTException


Supported API: false

Specified by:
appendKeyCriteria in interface QueryKey
Parameters:
qs -
Returns:
QuerySpec
Throws:
WTException

initialize

protected void initialize(Class target,
                          long usesOccurrenceIdentifier)
                   throws WTException


Supported API: false

Parameters:
target -
usesOccurrenceIdentifier -
Throws:
WTException

getClassname

public String getClassname()
Gets the value of the attribute: CLASSNAME.

Supported API: false

Specified by:
getClassname in interface QueryKey
Returns:
String

setClassname

public void setClassname(String a_Classname)
Sets the value of the attribute: CLASSNAME.

Supported API: false

Specified by:
setClassname in interface QueryKey
Parameters:
a_Classname -