com.ibm.tws.objects.model
Class CalendarHeader

java.lang.Object
  extended bycom.ibm.tws.objects.model.CalendarHeader
All Implemented Interfaces:
java.io.Serializable, TWSHeader

public class CalendarHeader
extends java.lang.Object
implements TWSHeader

This class hosts the attributes to be shown in TWS external interfaces when listing calendars.

See Also:
Calendar, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
CalendarHeader()
          Creates an empty CalendarHeader.
CalendarHeader(CalendarKey calendarKey)
          Creates a CalendarHeader with the specified key.
CalendarHeader(Identifier calendarId)
          Creates a CalendarHeader with the specified identifier.
CalendarHeader(Identifier calendarId, CalendarKey calendarKey)
          Creates a CalendarHeader with the specified identifier and key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this CalendarHeader object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the calendar description.
 Identifier getId()
          Returns the calendar identifier.
 CalendarKey getKey()
          Returns the CalendarKey wrapped by this CalendarHeader object.
 LockData getLockData()
          Returns the calendar lock data.
 ModifyData getModifyData()
          Returns the calendar modification data.
 java.lang.String getName()
          Returns the calendar name.
 TWSKey getObjectKey()
          Returns the calendar key as a TWS key.
 int hashCode()
          Returns a hash code for this CalendarHeader object.
 void setDescription(java.lang.String value)
          Sets the calendar description.
 void setId(Identifier identifier)
          Sets the calendar identifier.
 void setKey(CalendarKey calendarKey)
          Sets the CalendarKey to be wrapped by this CalendarHeader object.
 void setLockData(LockData data)
          Sets the calendar lock data.
 void setModifyData(ModifyData data)
          Sets the calendar modification data.
 void setName(java.lang.String value)
          Sets the calendar name.
 java.lang.String toString()
          Returns a string representation of this CalendarHeader object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

CalendarHeader

public CalendarHeader()
Creates an empty CalendarHeader.


CalendarHeader

public CalendarHeader(Identifier calendarId)
Creates a CalendarHeader with the specified identifier.

Parameters:
calendarId - The calendar identifier.

CalendarHeader

public CalendarHeader(CalendarKey calendarKey)
Creates a CalendarHeader with the specified key.

Parameters:
calendarKey - The calendar key.

CalendarHeader

public CalendarHeader(Identifier calendarId,
                      CalendarKey calendarKey)
Creates a CalendarHeader with the specified identifier and key.

Parameters:
calendarId - The calendar identifier.
calendarKey - The calendar key.
Method Detail

getId

public Identifier getId()
Returns the calendar identifier.

Specified by:
getId in interface TWSHeader
Returns:
The calendar identifier.

getObjectKey

public TWSKey getObjectKey()
Returns the calendar key as a TWS key.

Specified by:
getObjectKey in interface TWSHeader
Returns:
The calendar key as a TWS key.

getKey

public CalendarKey getKey()
Returns the CalendarKey wrapped by this CalendarHeader object.

Returns:
The CalendarKey wrapped by this CalendarHeader object.

getName

public java.lang.String getName()
Returns the calendar name.

Specified by:
getName in interface TWSHeader
Returns:
The calendar name.

getDescription

public java.lang.String getDescription()
Returns the calendar description.

Returns:
The calendar description.

getModifyData

public ModifyData getModifyData()
Returns the calendar modification data.

Specified by:
getModifyData in interface TWSHeader
Returns:
The calendar modification data.

getLockData

public LockData getLockData()
Returns the calendar lock data.

Specified by:
getLockData in interface TWSHeader
Returns:
The calendar lock data.

setId

public void setId(Identifier identifier)
Sets the calendar identifier.

Parameters:
identifier - The calendar identifier.

setKey

public void setKey(CalendarKey calendarKey)
Sets the CalendarKey to be wrapped by this CalendarHeader object.

Parameters:
calendarKey - The CalendarKey to be wrapped by this CalendarHeader object.

setName

public void setName(java.lang.String value)
Sets the calendar name.

Parameters:
value - The calendar name.

setDescription

public void setDescription(java.lang.String value)
Sets the calendar description.

Parameters:
value - The calendar description.

setModifyData

public void setModifyData(ModifyData data)
Sets the calendar modification data. For internal use only.

Parameters:
data - A ModifyData object.

setLockData

public void setLockData(LockData data)
Sets the calendar lock data. For internal use only.

Parameters:
data - A LockData object.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this CalendarHeader object are equal to those of the given one.

Parameters:
object - The object to be compared with this one.
Returns:
True if this object equals to the given one.

hashCode

public int hashCode()
Returns a hash code for this CalendarHeader object.

Returns:
The object's hash code.

toString

public java.lang.String toString()
Returns a string representation of this CalendarHeader object.

Returns:
A text string including all CalendarHeader fields.


Copyright © 2005 IBM All Rights Reserved.