com.ibm.tws.objects.model
Class Period

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

public class Period
extends java.lang.Object
implements TWSObject

This object represents a TWS zOS period, and wraps a PeriodHeader that in turn wraps a PeriodKey. No object is referenced by Period, which includes only the attributes of a TWS period.

The following syntax validation constraints must be met on Period objects in z/OS environment:

name Always required
Alphanumeric characters
Blank spaces not allowed
Not longer than 8 characters
description Not longer than 30 characters
type One of the values exposed by the PeriodType class
intervalLength Allowed range is from 1 to 999
variableTable If specified, must reference an existing variable table
Alphanumeric characters
Not longer than 16 characters

See Also:
PeriodType, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
Period()
          Creates an empty Period.
Period(PeriodHeader periodHeader)
          Creates a Period with the specified header.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this Period object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the period description.
 PeriodHeader getHeader()
          Returns the PeriodHeader wrapped by this Period object.
 Identifier getId()
          Returns the period identifier.
 int getIntervalLength()
          Returns the period interval length.
 java.util.List getIntervals()
          Returns a reference to the list of period intervals.
 PeriodKey getKey()
          Returns the PeriodKey wrapped by this Period object.
 LockData getLockData()
          Returns the period lock data.
 ModifyData getModifyData()
          Returns the period modification data.
 java.lang.String getName()
          Returns the period name.
 TWSHeader getObjectHeader()
          Returns the period header as a TWS header.
 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 Period object.
 void setDescription(java.lang.String value)
          Sets the period description.
 void setHeader(PeriodHeader periodHeader)
          Sets the PeriodHeader to be wrapped by this Period object.
 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 Period 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 Period 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

Period

public Period()
Creates an empty Period.


Period

public Period(PeriodHeader periodHeader)
Creates a Period with the specified header.

Parameters:
periodHeader - The period header.
Method Detail

getId

public Identifier getId()
Returns the period identifier.

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

getObjectKey

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

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

getObjectHeader

public TWSHeader getObjectHeader()
Returns the period header as a TWS header.

Specified by:
getObjectHeader in interface TWSObject
Returns:
The period header as a TWS header.

getKey

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

Returns:
The PeriodKey wrapped by this Period object.

getHeader

public PeriodHeader getHeader()
Returns the PeriodHeader wrapped by this Period object.

Returns:
The PeriodHeader wrapped by this Period object.

getName

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

Specified by:
getName in interface TWSObject
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 TWSObject
Returns:
The period modification data.

getLockData

public LockData getLockData()
Returns the period lock data.

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

getIntervals

public java.util.List getIntervals()
Returns a reference to the list of period intervals.

Returns:
A reference to the list of period intervals.

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 Period object.

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

setHeader

public void setHeader(PeriodHeader periodHeader)
Sets the PeriodHeader to be wrapped by this Period object.

Parameters:
periodHeader - The PeriodHeader to be wrapped by this Period 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 Period 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 Period object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all Period fields.


Copyright © 2005 IBM All Rights Reserved.