wt.router
Class ToDoItem

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.router.ToDoItem
All Implemented Interfaces:
DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class ToDoItem
extends WTObject
implements Externalizable

Use the newToDoItem static factory method(s), not the ToDoItem 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  Vector args
           
static String ARGS
          Label for the attribute.
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
static String METHOD_NAME
          Label for the attribute.
private static int METHOD_NAME_UPPER_LIMIT
           
private  String methodName
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
static String ROUTER_NAME
          Label for the attribute.
private static int ROUTER_NAME_UPPER_LIMIT
           
private  String routerName
           
(package private) static long serialVersionUID
           
private  RoutingStatus status
           
static String STATUS
          Label for the attribute.
private static int STATUS_UPPER_LIMIT
           
private  RouterMethodArg t_object
           
static String T_OBJECT
          Label for the attribute.
 
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.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
ToDoItem()
           
 
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.
 Vector getArgs()
          Gets the object for the association that plays role: ARGS.
 String getConceptualClassname()
          Deprecated.  
 String getMethodName()
          Gets the value of the attribute: METHOD_NAME.
 String getRouterName()
          Gets the value of the attribute: ROUTER_NAME.
 RoutingStatus getStatus()
          Gets the object for the association that plays role: STATUS.
 RouterMethodArg getT_object()
          Gets the object for the association that plays role: T_OBJECT.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
private  void methodNameValidate(String a_MethodName)
           
static ToDoItem newToDoItem()
          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(ToDoItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
private  void routerNameValidate(String a_RouterName)
           
 void setArgs(Vector a_Args)
          Sets the object for the association that plays role: ARGS.
 void setMethodName(String a_MethodName)
          Sets the value of the attribute: METHOD_NAME.
 void setRouterName(String a_RouterName)
          Sets the value of the attribute: ROUTER_NAME.
 void setStatus(RoutingStatus a_Status)
          Sets the object for the association that plays role: STATUS.
 void setT_object(RouterMethodArg a_T_object)
          Sets the object for the association that plays role: T_OBJECT.
private  void statusValidate(RoutingStatus a_Status)
           
 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.fc.WTObject
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, 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

ROUTER_NAME

public static final String ROUTER_NAME
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

ROUTER_NAME_UPPER_LIMIT

private static int ROUTER_NAME_UPPER_LIMIT

routerName

private String routerName

METHOD_NAME

public static final String METHOD_NAME
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

METHOD_NAME_UPPER_LIMIT

private static int METHOD_NAME_UPPER_LIMIT

methodName

private String methodName

ARGS

public static final String ARGS
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

args

private Vector args

STATUS

public static final String STATUS
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

STATUS_UPPER_LIMIT

private static int STATUS_UPPER_LIMIT

status

private RoutingStatus status

T_OBJECT

public static final String T_OBJECT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

t_object

private RouterMethodArg t_object

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

ToDoItem

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

readVersion

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

getRouterName

public String getRouterName()
Gets the value of the attribute: ROUTER_NAME.

Supported API: false

Returns:
String

setRouterName

public void setRouterName(String a_RouterName)
                   throws WTPropertyVetoException
Sets the value of the attribute: ROUTER_NAME.

Supported API: false

Parameters:
a_RouterName -
Throws:
WTPropertyVetoException

routerNameValidate

private void routerNameValidate(String a_RouterName)
                         throws WTPropertyVetoException
Parameters:
a_RouterName -
Throws:
WTPropertyVetoException

getMethodName

public String getMethodName()
Gets the value of the attribute: METHOD_NAME.

Supported API: false

Returns:
String

setMethodName

public void setMethodName(String a_MethodName)
                   throws WTPropertyVetoException
Sets the value of the attribute: METHOD_NAME.

Supported API: false

Parameters:
a_MethodName -
Throws:
WTPropertyVetoException

methodNameValidate

private void methodNameValidate(String a_MethodName)
                         throws WTPropertyVetoException
Parameters:
a_MethodName -
Throws:
WTPropertyVetoException

getArgs

public Vector getArgs()
Gets the object for the association that plays role: ARGS.

Supported API: false

Returns:
Vector

setArgs

public void setArgs(Vector a_Args)
             throws WTPropertyVetoException
Sets the object for the association that plays role: ARGS.

Supported API: false

Parameters:
a_Args -
Throws:
WTPropertyVetoException

getStatus

public RoutingStatus getStatus()
Gets the object for the association that plays role: STATUS.

Supported API: false

Returns:
RoutingStatus

setStatus

public void setStatus(RoutingStatus a_Status)
               throws WTPropertyVetoException
Sets the object for the association that plays role: STATUS.

Supported API: false

Parameters:
a_Status -
Throws:
WTPropertyVetoException

statusValidate

private void statusValidate(RoutingStatus a_Status)
                     throws WTPropertyVetoException
Parameters:
a_Status -
Throws:
WTPropertyVetoException

getT_object

public RouterMethodArg getT_object()
Gets the object for the association that plays role: T_OBJECT.

Supported API: false

Returns:
RouterMethodArg

setT_object

public void setT_object(RouterMethodArg a_T_object)
                 throws WTPropertyVetoException
Sets the object for the association that plays role: T_OBJECT.

Supported API: false

Parameters:
a_T_object -
Throws:
WTPropertyVetoException

newToDoItem

public static ToDoItem newToDoItem()
                            throws WTException
Default factory for the class.

Supported API: false

Returns:
ToDoItem
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 WTObject
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 WTObject
Returns:
int