com.ibm.tws.objects.model
Class PeriodHeader

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

public class PeriodHeader
extends java.lang.Object
implements TWSHeader

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

See Also:
Period, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
PeriodHeader()
          Creates an empty PeriodHeader.
PeriodHeader(Identifier periodId)
          Creates a PeriodHeader with the specified identifier.
PeriodHeader(Identifier periodId, PeriodKey periodKey)
          Creates a PeriodHeader with the specified identifier and key.
PeriodHeader(PeriodKey periodKey)
          Creates a PeriodHeader with the specified key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this PeriodHeader object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the period description.
 Identifier getId()
          Returns the period identifier.
 int getIntervalLength()
          Returns the period interval length.
 PeriodKey getKey()
          Returns the PeriodKey wrapped by this PeriodHeader object.
 LockData getLockData()
          Returns the period lock data.
 ModifyData getModifyData()
          Returns the period modification data.
 java.lang.String getName()
          Returns the period name.
 TWSKey getObjectKey()
          Returns the period key as a TWS key.
 PeriodType getType()
          Returns the period type.
 java.lang.String getVariableTable()
          Returns the period variable table.
 int hashCode()
          Returns a hash code for this PeriodHeader object.
 void setDescription(java.lang.String value)
          Sets the period description.
 void setId(Identifier identifier)
          Sets the period identifier.
 void setIntervalLength(int value)
          Sets the period interval length.
 void setKey(PeriodKey periodKey)
          Sets the PeriodKey to be wrapped by this PeriodHeader object.
 void setLockData(LockData data)
          Sets the period lock data.
 void setModifyData(ModifyData data)
          Sets the period modification data.
 void setName(java.lang.String value)
          Sets the period name.
 void setType(PeriodType value)
          Sets the period type.
 void setVariableTable(java.lang.String value)
          Sets the period variable table.
 java.lang.String toString()
          Returns a string representation of this PeriodHeader 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

PeriodHeader

public PeriodHeader()
Creates an empty PeriodHeader.


PeriodHeader

public PeriodHeader(Identifier periodId)
Creates a PeriodHeader with the specified identifier.

Parameters:
periodId - The period identifier.

PeriodHeader

public PeriodHeader(PeriodKey periodKey)
Creates a PeriodHeader with the specified key.

Parameters:
periodKey - The period key.

PeriodHeader

public PeriodHeader(Identifier periodId,
                    PeriodKey periodKey)
Creates a PeriodHeader with the specified identifier and key.

Parameters:
periodId - The period identifier.
periodKey - The period key.
Method Detail

getId

public Identifier getId()
Returns the period identifier.

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

getObjectKey

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

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

getKey

public PeriodKey getKey()
Returns the PeriodKey wrapped by this PeriodHeader object.

Returns:
The PeriodKey wrapped by this PeriodHeader object.

getName

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

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

getDescription

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

Returns:
The period description.

getType

public PeriodType getType()
Returns the period type.

Returns:
The period type.

getIntervalLength

public int getIntervalLength()
Returns the period interval length.

Returns:
The period interval length.

getVariableTable

public java.lang.String getVariableTable()
Returns the period variable table.

Returns:
The period variable table.

getModifyData

public ModifyData getModifyData()
Returns the period modification data.

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

getLockData

public LockData getLockData()
Returns the period lock data.

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

setId

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

Parameters:
identifier - The period identifier.

setKey

public void setKey(PeriodKey periodKey)
Sets the PeriodKey to be wrapped by this PeriodHeader object.

Parameters:
periodKey - The PeriodKey to be wrapped by this PeriodHeader object.

setName

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

Parameters:
value - The period name.

setDescription

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

Parameters:
value - The period description.

setType

public void setType(PeriodType value)
Sets the period type.

Parameters:
value - The period type.

setIntervalLength

public void setIntervalLength(int value)
Sets the period interval length.

Parameters:
value - The period interval length.

setVariableTable

public void setVariableTable(java.lang.String value)
Sets the period variable table.

Parameters:
value - The period variable table.

setModifyData

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

Parameters:
data - A ModifyData object.

setLockData

public void setLockData(LockData data)
Sets the period 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 PeriodHeader 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 PeriodHeader object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all PeriodHeader fields.


Copyright © 2005 IBM All Rights Reserved.