|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.model.Period
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 |
PeriodType
,
Serialized FormField 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 |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public Period()
public Period(PeriodHeader periodHeader)
periodHeader
- The period header.Method Detail |
public Identifier getId()
getId
in interface TWSObject
public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
public PeriodKey getKey()
public PeriodHeader getHeader()
public java.lang.String getName()
getName
in interface TWSObject
public java.lang.String getDescription()
public PeriodType getType()
public int getIntervalLength()
public java.lang.String getVariableTable()
public ModifyData getModifyData()
getModifyData
in interface TWSObject
public LockData getLockData()
getLockData
in interface TWSObject
public java.util.List getIntervals()
public void setId(Identifier identifier)
identifier
- The period identifier.public void setKey(PeriodKey periodKey)
periodKey
- The PeriodKey to be wrapped by this Period object.public void setHeader(PeriodHeader periodHeader)
periodHeader
- The PeriodHeader to be wrapped by this Period object.public void setName(java.lang.String value)
value
- The period name.public void setDescription(java.lang.String value)
value
- The period description.public void setType(PeriodType value)
value
- The period type.public void setIntervalLength(int value)
value
- The period interval length.public void setVariableTable(java.lang.String value)
value
- The period variable table.public void setModifyData(ModifyData data)
data
- A ModifyData object.public void setLockData(LockData data)
data
- A LockData object.public boolean equals(java.lang.Object object)
object
- The object to be compared with this one.
public int hashCode()
public java.lang.String toString()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |