wt.calendar
Class WTCalendar

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.enterprise.Simple
          extended bywt.calendar.WTCalendar
All Implemented Interfaces:
AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, Serializable

public class WTCalendar
extends Simple
implements Ownable, Externalizable

Use the newWTCalendar static factory method(s), not the WTCalendar 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
protected static String ALLOWED_GRANULARITY
          Label for the attribute.
private  long allowedGranularity
           
protected static String BASE_DATE
          Label for the attribute.
private  Timestamp baseDate
           
private static String CLASSNAME
           
protected static String DELEGATE_INDEFINITELY_DATE
          Label for the attribute.
protected static String DELEGATE_INDEFINITELY_PREF
          Label for the attribute.
private  Timestamp delegateIndefinitelyDate
           
private  WTPrincipalReference delegateIndefinitelyPRef
           
static long EXTERNALIZATION_VERSION_UID
           
static long MILLIS_IN_DAY
           
protected static long OLD_FORMAT_VERSION_UID
           
private  Ownership ownership
           
static String PARENT
          Label for the attribute.
static String PARENT_REFERENCE
          Label for the attribute.
private  ObjectReference parentReference
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
protected static WTPrincipalReference SYS_CAL_OWNER
           
protected static boolean VERBOSE
           
protected static String WEEKLY_DAYS_OFF
           
 
Fields inherited from class wt.enterprise.Simple
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.ownership.Ownable
OWNERSHIP
 
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.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
WTCalendar()
           
 
Method Summary
private  void delegateIndefinitelyPRefValidate(WTPrincipalReference a_DelegateIndefinitelyPRef)
           
 boolean equals(Object obj)
          Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
protected  long getAllowedGranularity()
          Gets the value of the attribute: ALLOWED_GRANULARITY.
protected  Timestamp getBaseDate()
          Gets the value of the attribute: BASE_DATE.
 String getConceptualClassname()
          Deprecated.  
protected  Timestamp getDelegateIndefinitelyDate()
          Gets the value of the attribute: DELEGATE_INDEFINITELY_DATE.
protected  WTPrincipalReference getDelegateIndefinitelyPRef()
          Gets the value of the attribute: DELEGATE_INDEFINITELY_PREF.
 Ownership getOwnership()
          Gets the object for the association that plays role: OWNERSHIP.
 WTCalendar getParent()
          Gets the object for the association that plays role: PARENT.
 ObjectReference getParentReference()
          Gets the value of the attribute: PARENT_REFERENCE.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize()
          Performs object initialization.
protected  void initialize(WTPrincipalReference user, WTCalendar parent)
          Supports initialization, following construction of an instance.
static WTCalendar newWTCalendar(WTPrincipalReference user, WTCalendar parent)
          

Supported API: false
private  void parentReferenceValidate(ObjectReference a_ParentReference)
           
 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(WTCalendar thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
protected  void setAllowedGranularity(long a_AllowedGranularity)
          Sets the value of the attribute: ALLOWED_GRANULARITY.
protected  void setBaseDate(Timestamp a_BaseDate)
          Sets the value of the attribute: BASE_DATE.
protected  void setDelegateIndefinitelyDate(Timestamp a_DelegateIndefinitelyDate)
          Sets the value of the attribute: DELEGATE_INDEFINITELY_DATE.
protected  void setDelegateIndefinitelyPRef(WTPrincipalReference a_DelegateIndefinitelyPRef)
          Sets the value of the attribute: DELEGATE_INDEFINITELY_PREF.
 void setOwnership(Ownership a_Ownership)
          Sets the object for the association that plays role: OWNERSHIP.
 void setParent(WTCalendar a_Parent)
          Sets the object for the association that plays role: PARENT.
 void setParentReference(ObjectReference a_ParentReference)
          Sets the value of the attribute: PARENT_REFERENCE.
 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.Simple
getBusinessType, getDomainRef, getEventSet, getIdentity, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain
 
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

ALLOWED_GRANULARITY

protected static final String ALLOWED_GRANULARITY
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

allowedGranularity

private long allowedGranularity

BASE_DATE

protected static final String BASE_DATE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

baseDate

private Timestamp baseDate

DELEGATE_INDEFINITELY_DATE

protected static final String DELEGATE_INDEFINITELY_DATE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

delegateIndefinitelyDate

private Timestamp delegateIndefinitelyDate

DELEGATE_INDEFINITELY_PREF

protected static final String DELEGATE_INDEFINITELY_PREF
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

delegateIndefinitelyPRef

private WTPrincipalReference delegateIndefinitelyPRef

PARENT

public static final String PARENT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

PARENT_REFERENCE

public static final String PARENT_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

parentReference

private ObjectReference parentReference

ownership

private Ownership ownership

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

MILLIS_IN_DAY

public static final long MILLIS_IN_DAY
See Also:
Constant Field Values

WEEKLY_DAYS_OFF

protected static String WEEKLY_DAYS_OFF

VERBOSE

protected static boolean VERBOSE

SYS_CAL_OWNER

protected static WTPrincipalReference SYS_CAL_OWNER
Constructor Detail

WTCalendar

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

readVersion

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

getAllowedGranularity

protected long getAllowedGranularity()
Gets the value of the attribute: ALLOWED_GRANULARITY.

Supported API: false

Returns:
long

setAllowedGranularity

protected void setAllowedGranularity(long a_AllowedGranularity)
                              throws WTPropertyVetoException
Sets the value of the attribute: ALLOWED_GRANULARITY.

Supported API: false

Parameters:
a_AllowedGranularity -
Throws:
WTPropertyVetoException

getBaseDate

protected Timestamp getBaseDate()
Gets the value of the attribute: BASE_DATE.

Supported API: false

Returns:
Timestamp

setBaseDate

protected void setBaseDate(Timestamp a_BaseDate)
                    throws WTPropertyVetoException
Sets the value of the attribute: BASE_DATE.

Supported API: false

Parameters:
a_BaseDate -
Throws:
WTPropertyVetoException

getDelegateIndefinitelyDate

protected Timestamp getDelegateIndefinitelyDate()
Gets the value of the attribute: DELEGATE_INDEFINITELY_DATE.

Supported API: false

Returns:
Timestamp

setDelegateIndefinitelyDate

protected void setDelegateIndefinitelyDate(Timestamp a_DelegateIndefinitelyDate)
                                    throws WTPropertyVetoException
Sets the value of the attribute: DELEGATE_INDEFINITELY_DATE.

Supported API: false

Parameters:
a_DelegateIndefinitelyDate -
Throws:
WTPropertyVetoException

getDelegateIndefinitelyPRef

protected WTPrincipalReference getDelegateIndefinitelyPRef()
Gets the value of the attribute: DELEGATE_INDEFINITELY_PREF.

Supported API: false

Returns:
WTPrincipalReference

setDelegateIndefinitelyPRef

protected void setDelegateIndefinitelyPRef(WTPrincipalReference a_DelegateIndefinitelyPRef)
                                    throws WTPropertyVetoException
Sets the value of the attribute: DELEGATE_INDEFINITELY_PREF.

Supported API: false

Parameters:
a_DelegateIndefinitelyPRef -
Throws:
WTPropertyVetoException

delegateIndefinitelyPRefValidate

private void delegateIndefinitelyPRefValidate(WTPrincipalReference a_DelegateIndefinitelyPRef)
                                       throws WTPropertyVetoException
Parameters:
a_DelegateIndefinitelyPRef -
Throws:
WTPropertyVetoException

getParent

public WTCalendar getParent()
Gets the object for the association that plays role: PARENT.

Supported API: false

Returns:
WTCalendar

setParent

public void setParent(WTCalendar a_Parent)
               throws WTPropertyVetoException,
                      WTException
Sets the object for the association that plays role: PARENT.

Supported API: false

Parameters:
a_Parent -
Throws:
WTPropertyVetoException
WTException

getParentReference

public ObjectReference getParentReference()
Gets the value of the attribute: PARENT_REFERENCE.

Supported API: false

Returns:
ObjectReference

setParentReference

public void setParentReference(ObjectReference a_ParentReference)
                        throws WTPropertyVetoException
Sets the value of the attribute: PARENT_REFERENCE.

Supported API: false

Parameters:
a_ParentReference -
Throws:
WTPropertyVetoException

parentReferenceValidate

private void parentReferenceValidate(ObjectReference a_ParentReference)
                              throws WTPropertyVetoException
Parameters:
a_ParentReference -
Throws:
WTPropertyVetoException

newWTCalendar

public static WTCalendar newWTCalendar(WTPrincipalReference user,
                                       WTCalendar parent)
                                throws WTException


Supported API: false

Parameters:
user -
parent -
Returns:
WTCalendar
Throws:
WTException

initialize

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

Supported API: false

Parameters:
user -
parent -
Throws:
WTException

getOwnership

public Ownership getOwnership()
Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:
getOwnership in interface Ownable
Returns:
Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)
Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:
setOwnership in interface Ownable
Parameters:
a_Ownership -

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

initialize

protected void initialize()
                   throws WTException
Performs object initialization.

Overrides:
initialize in class Simple
Throws:
WTException