wt.calendar
Class CalendarComponent

java.lang.Object
  wt.fc.WTObject
      wt.calendar.CalendarComponent

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class CalendarComponent

extends WTObject

implements Externalizable

Calendar Components. The ComponentType attribute will denote either event, to do, journal, free busy, time zone, or alarm calendar component. Initially, only event components will be allowed. A time zone is not strictly needed at this time because our granularity is one day (24 hours).

Use the newCalendarComponent static factory method(s), not the CalendarComponent 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 WTPrincipalReference	delegate
static String	DELEGATE Label for the attribute.
private Timestamp	end_date
static String	END_DATE Label for the attribute; This is converted from the user's time zone into UTC for storage.
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private Timestamp	start_date
static String	START_DATE Label for the attribute; This is converted from the user's time zone into UTC for storage.
static String	WORKING_DAY Label for the attribute.
private boolean	workingDay

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

CalendarComponent()

Method Summary

void	checkStartEnd()
private void	delegateValidate(WTPrincipalReference a_Delegate)
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.
WTPrincipalReference	getDelegate() Gets the object for the association that plays role: DELEGATE.
Timestamp	getEnd_date() Gets the value of the attribute: END_DATE.
Timestamp	getStart_date() Gets the value of the attribute: START_DATE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
boolean	isWorkingDay() Gets the value of the attribute: WORKING_DAY.
static CalendarComponent	newCalendarComponent() 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(CalendarComponent thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDelegate(WTPrincipalReference a_Delegate) Sets the object for the association that plays role: DELEGATE.
void	setEnd_date(Timestamp a_End_date) Sets the value of the attribute: END_DATE.
void	setStart_date(Timestamp a_Start_date) Sets the value of the attribute: START_DATE.
void	setWorkingDay(boolean a_WorkingDay) Sets the value of the attribute: WORKING_DAY.
String	toString() If the object has been persisted, return it's ObjectIdentifier.
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, readVersion, setPersistInfo

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

START_DATE

public static final String START_DATE

Label for the attribute; This is converted from the user's time zone into UTC for storage. The calendar server operates on UTC. When the StandardCalendarService creates a CalendarMonth container for the client, it will convert these UTC times into that appropriate for the time zone offset the client passed in on the call.

Supported API: false

See Also:

Constant Field Values

start_date

private Timestamp start_date

END_DATE

public static final String END_DATE

Label for the attribute; This is converted from the user's time zone into UTC for storage. The calendar server operates on UTC. When the StandardCalendarService creates a CalendarMonth container for the client, it will convert these UTC times into that appropriate for the time zone offset the client passed in on the call.

Supported API: false

See Also:

Constant Field Values

end_date

private Timestamp end_date

WORKING_DAY

public static final String WORKING_DAY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

workingDay

private boolean workingDay

DELEGATE

public static final String DELEGATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

delegate

private WTPrincipalReference delegate

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

CalendarComponent

public CalendarComponent()

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(CalendarComponent 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

getStart_date

public Timestamp getStart_date()

Gets the value of the attribute: START_DATE. This is converted from the user's time zone into UTC for storage. The calendar server operates on UTC. When the StandardCalendarService creates a CalendarMonth container for the client, it will convert these UTC times into that appropriate for the time zone offset the client passed in on the call.

Supported API: false

Returns:

Timestamp

setStart_date

public void setStart_date(Timestamp a_Start_date)
                   throws WTPropertyVetoException

Sets the value of the attribute: START_DATE. This is converted from the user's time zone into UTC for storage. The calendar server operates on UTC. When the StandardCalendarService creates a CalendarMonth container for the client, it will convert these UTC times into that appropriate for the time zone offset the client passed in on the call.

Supported API: false

Parameters:

a_Start_date -

Throws:

WTPropertyVetoException

getEnd_date

public Timestamp getEnd_date()

Gets the value of the attribute: END_DATE. This is converted from the user's time zone into UTC for storage. The calendar server operates on UTC. When the StandardCalendarService creates a CalendarMonth container for the client, it will convert these UTC times into that appropriate for the time zone offset the client passed in on the call.

Supported API: false

Returns:

Timestamp

setEnd_date

public void setEnd_date(Timestamp a_End_date)
                 throws WTPropertyVetoException

Sets the value of the attribute: END_DATE. This is converted from the user's time zone into UTC for storage. The calendar server operates on UTC. When the StandardCalendarService creates a CalendarMonth container for the client, it will convert these UTC times into that appropriate for the time zone offset the client passed in on the call.

Supported API: false

Parameters:

a_End_date -

Throws:

WTPropertyVetoException

isWorkingDay

public boolean isWorkingDay()

Gets the value of the attribute: WORKING_DAY.

Supported API: false

Returns:

boolean

setWorkingDay

public void setWorkingDay(boolean a_WorkingDay)
                   throws WTPropertyVetoException

Sets the value of the attribute: WORKING_DAY.

Supported API: false

Parameters:

a_WorkingDay -

Throws:

WTPropertyVetoException

getDelegate

public WTPrincipalReference getDelegate()

Gets the object for the association that plays role: DELEGATE.

Supported API: false

Returns:

WTPrincipalReference

setDelegate

public void setDelegate(WTPrincipalReference a_Delegate)
                 throws WTPropertyVetoException

Sets the object for the association that plays role: DELEGATE.

Supported API: false

Parameters:

a_Delegate -

Throws:

WTPropertyVetoException

delegateValidate

private void delegateValidate(WTPrincipalReference a_Delegate)
                       throws WTPropertyVetoException

Parameters:

a_Delegate -

Throws:

WTPropertyVetoException

newCalendarComponent

public static CalendarComponent newCalendarComponent()
                                              throws WTException

Default factory for the class.

Supported API: false

Returns:

CalendarComponent

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

initialize

protected void initialize()

Description copied from class: WTObject

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

checkStartEnd

public void checkStartEnd()
                   throws CalendarException

Throws:

CalendarException

toString

public String toString()

Description copied from class: WTObject

If the object has been persisted, return it's ObjectIdentifier. If it has not yet been persisted, simply return it's conceptual (modeled) name.

Overrides:

toString in class WTObject

Returns:

String