wt.dataops.objectcol
Class BaseCriterionDefMaster

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.enterprise.Master
          extended bywt.dataops.objectcol.BaseCriterionDefMaster
All Implemented Interfaces:
BusinessInformation, DisplayIdentification, Externalizable, Identified, Mastered, NetFactor, ObjectMappable, Persistable, Serializable, UniquelyIdentified
Direct Known Subclasses:
CollectionCriterionDefMaster, FilterCriterionDefMaster, MethodDefMaster, RelationshipMapDefMaster

public class BaseCriterionDefMaster
extends Master
implements UniquelyIdentified, Externalizable

Use the newBaseCriterionDefMaster static factory method(s), not the BaseCriterionDefMaster 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
private static String CLASSNAME
           
private  String description
           
protected static String DESCRIPTION
          Label for the attribute.
private static int DESCRIPTION_UPPER_LIMIT
           
protected static String DISPLAY_NAME
          Label for the attribute.
private static int DISPLAY_NAME_UPPER_LIMIT
           
private  String displayName
           
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
           
static String PRIMARY_DEF
          Label for the attribute.
private  boolean primaryDef
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.enterprise.Master
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Fields inherited from interface wt.vc.Mastered
SERIES
 
Fields inherited from interface wt.fc.BusinessInformation
BUSINESS_TYPE, IDENTITY
 
Fields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
BaseCriterionDefMaster()
           
 
Method Summary
private  void descriptionValidate(String a_Description)
           
private  void displayNameValidate(String a_DisplayName)
           
 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.  
protected  String getDescription()
          Gets the value of the attribute: DESCRIPTION.
 String getDescription(Locale locale)
          

Supported API: false
protected  String getDisplayName()
          Gets the value of the attribute: DISPLAY_NAME.
 String getDisplayName(Locale locale)
          

Supported API: false
 IdentificationObject getIdentificationObject()
          Constructs and returns an identification object.
 String getName()
          Gets the value of the attribute: NAME.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize()
          

Supported API: false
 boolean isPrimaryDef()
          Gets the value of the attribute: PRIMARY_DEF.
private  void nameValidate(String a_Name)
           
static BaseCriterionDefMaster newBaseCriterionDefMaster()
          Default factory for the class.
protected  String parseDefault(String val)
           
protected  String parseKey(String val)
           
protected  String parseLocalizableMsg(String val)
           
protected  String parseRbInfoname(String val)
           
 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(BaseCriterionDefMaster thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setDescription(String a_Description)
          Sets the value of the attribute: DESCRIPTION.
 void setDisplayName(String a_DisplayName)
          Sets the value of the attribute: DISPLAY_NAME.
protected  void setName(String a_Name)
          Sets the value of the attribute: NAME.
 void setPrimaryDef(boolean a_PrimaryDef)
          Sets the value of the attribute: PRIMARY_DEF.
protected  String[] splitRbKeyOn(String msg, String sep)
           
 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.Master
getBusinessType, getIdentity, getSeries, readVersion, setSeries
 
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, getIdentity, 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

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

PRIMARY_DEF

public static final String PRIMARY_DEF
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

primaryDef

private boolean primaryDef

DISPLAY_NAME

protected static final String DISPLAY_NAME
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

DISPLAY_NAME_UPPER_LIMIT

private static int DISPLAY_NAME_UPPER_LIMIT

displayName

private String displayName

DESCRIPTION

protected 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

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

BaseCriterionDefMaster

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

readVersion

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

getName

public String getName()
Gets the value of the attribute: NAME.

Supported API: false

Returns:
String

setName

protected 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

isPrimaryDef

public boolean isPrimaryDef()
Gets the value of the attribute: PRIMARY_DEF.

Supported API: false

Returns:
boolean

setPrimaryDef

public void setPrimaryDef(boolean a_PrimaryDef)
                   throws WTPropertyVetoException
Sets the value of the attribute: PRIMARY_DEF.

Supported API: false

Parameters:
a_PrimaryDef -
Throws:
WTPropertyVetoException

getDisplayName

protected String getDisplayName()
Gets the value of the attribute: DISPLAY_NAME.

Supported API: false

Returns:
String

setDisplayName

public void setDisplayName(String a_DisplayName)
                    throws WTPropertyVetoException
Sets the value of the attribute: DISPLAY_NAME.

Supported API: false

Parameters:
a_DisplayName -
Throws:
WTPropertyVetoException

displayNameValidate

private void displayNameValidate(String a_DisplayName)
                          throws WTPropertyVetoException
Parameters:
a_DisplayName -
Throws:
WTPropertyVetoException

getDescription

protected 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

initialize

protected void initialize()
                   throws WTException


Supported API: false

Overrides:
initialize in class WTObject
Throws:
WTException

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException
Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: false

Specified by:
getIdentificationObject in interface Identified
Returns:
IdentificationObject
Throws:
WTException

getDisplayName

public String getDisplayName(Locale locale)


Supported API: false

Parameters:
locale -
Returns:
String

getDescription

public String getDescription(Locale locale)


Supported API: false

Parameters:
locale -
Returns:
String

newBaseCriterionDefMaster

public static BaseCriterionDefMaster newBaseCriterionDefMaster()
                                                        throws WTException
Default factory for the class.

Supported API: false

Returns:
BaseCriterionDefMaster
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 Master
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 Master
Returns:
int

parseDefault

protected String parseDefault(String val)

parseRbInfoname

protected String parseRbInfoname(String val)
                          throws WTException
Throws:
WTException

parseKey

protected String parseKey(String val)
                   throws WTException
Throws:
WTException

parseLocalizableMsg

protected String parseLocalizableMsg(String val)
                              throws WTException
Throws:
WTException

splitRbKeyOn

protected String[] splitRbKeyOn(String msg,
                                String sep)
                         throws WTException
Throws:
WTException