com.ibm.tws.objects.plan
Class SymphonyInPlan

java.lang.Object
  extended bycom.ibm.tws.objects.plan.SymphonyInPlan
All Implemented Interfaces:
java.io.Serializable, TWSHeader, TWSObject

public class SymphonyInPlan
extends java.lang.Object
implements TWSObject, TWSHeader

This class maintains information about Symphony Files. Since it has no header, it wraps directly a SymphonyInPlanKey object. It mantains information of all the Symphony types.

The following syntax validation constraints must be met on SymphonyInPlan objects:

name The name of an Existing Symphony.
scheduleDate Read Only.
It does not contains information about the time.
timeStarted Read Only.
lastTime Read Only.
planStart Read Only.
planEnd Read Only.
runNumber Read Only.
size Read Only.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
SymphonyInPlan()
          Creates an empty SymphonyInPlan.
SymphonyInPlan(PlanIdentifier symphonyId)
          Creates a Symphony in plan with the specified Identifier.
SymphonyInPlan(PlanIdentifier symphonyId, SymphonyInPlanKey symphonyKey)
          Creates a SymphonyInPlan with the specified id and key.
SymphonyInPlan(SymphonyInPlanKey symphonyKey)
          Creates a SymphonyInPlan with the specified key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this Symphony object are equal to those of the given one.
 Identifier getId()
          Returns the Identifier of this object
 SymphonyInPlanKey getKey()
          Return the Symphony Key
 java.util.Date getLastTime()
          Return the last time
 LockData getLockData()
          This method return the object's LockData.
 ModifyData getModifyData()
          This method return the object's ModifyData.
 java.lang.String getName()
          Return the Symphony Name
 TWSHeader getObjectHeader()
          Return this object header.
 TWSKey getObjectKey()
          Return this object key
 java.util.Date getPlanEnd()
          Return the plan end
 PlanIdentifier getPlanId()
          Return this object Identifier as a PlanIdentifier
 java.util.Date getPlanStart()
          Return the plan start
 int getRunNumber()
          Return the run number
 java.util.Date getScheduleDate()
          Return the schedule date
 int getSize()
          Return the size of this Symphony
 java.util.Date getTimeStarted()
          Return the time started
 SymphonyType getType()
          Returns the Symphony type Valid Values are: Archived, Trial, Forecast, Unknown.
 int hashCode()
          Returns a hash code for this Symphony object.
 void setLastTime(java.util.Date date)
          Sets the last time For internal use only
 void setPlanEnd(java.util.Date date)
          Sets the plan end For internal use only
 void setPlanStart(java.util.Date date)
          Sets the plan start For internal use only
 void setRunNumber(int i)
          Sets the run number For internal use only
 void setScheduleDate(java.util.Date date)
          Sets the schedule date For internal use only
 void setSize(int i)
          Sets the size of this Symphony For internal use only
 void setTimeStarted(java.util.Date date)
          Sets the time started For internal use only
 void setType(SymphonyType type)
          Sets the Symphony type For Internal Use Only Valid Values are: Archived, Trial, Forecast, Unknown.
 java.lang.String toString()
          Returns a string representation of this Symphony.
 
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

SymphonyInPlan

public SymphonyInPlan()
Creates an empty SymphonyInPlan.


SymphonyInPlan

public SymphonyInPlan(PlanIdentifier symphonyId)
Creates a Symphony in plan with the specified Identifier.

Parameters:
symphonyId - The symphony Identifier.

SymphonyInPlan

public SymphonyInPlan(SymphonyInPlanKey symphonyKey)
Creates a SymphonyInPlan with the specified key.

Parameters:
symphonyKey - The symphony key.

SymphonyInPlan

public SymphonyInPlan(PlanIdentifier symphonyId,
                      SymphonyInPlanKey symphonyKey)
Creates a SymphonyInPlan with the specified id and key.

Parameters:
symphonyId - The symphony id.
symphonyKey - The symphony key.
Method Detail

getId

public Identifier getId()
Returns the Identifier of this object

Specified by:
getId in interface TWSObject
Returns:
this object Identifier
See Also:
TWSHeader.getId()

getPlanId

public PlanIdentifier getPlanId()
Return this object Identifier as a PlanIdentifier

Returns:
this object PlanIdentifier
See Also:
TWSHeader.getId()

getName

public java.lang.String getName()
Return the Symphony Name

Specified by:
getName in interface TWSObject
Returns:
this object name
See Also:
TWSHeader.getName()

getObjectKey

public TWSKey getObjectKey()
Return this object key

Specified by:
getObjectKey in interface TWSObject
Returns:
this object key
See Also:
TWSHeader.getObjectKey()

getObjectHeader

public TWSHeader getObjectHeader()
Return this object header. In this case, this method returns the object itself.

Specified by:
getObjectHeader in interface TWSObject
Returns:
the object's header.
See Also:
TWSObject.getObjectHeader()

getModifyData

public ModifyData getModifyData()
This method return the object's ModifyData. For all Plan object this method returns null

Specified by:
getModifyData in interface TWSObject
Returns:
the object's ModifyData.
See Also:
TWSHeader.getModifyData()

getLockData

public LockData getLockData()
This method return the object's LockData. For all Plan object this method returns null

Specified by:
getLockData in interface TWSObject
Returns:
the object's LockData.
See Also:
TWSHeader.getLockData()

getKey

public SymphonyInPlanKey getKey()
Return the Symphony Key

Returns:
the Symphony key.

getLastTime

public java.util.Date getLastTime()
Return the last time

Returns:
the last time

getPlanEnd

public java.util.Date getPlanEnd()
Return the plan end

Returns:
the plan end

getPlanStart

public java.util.Date getPlanStart()
Return the plan start

Returns:
the plan start

getRunNumber

public int getRunNumber()
Return the run number

Returns:
the run number

getScheduleDate

public java.util.Date getScheduleDate()
Return the schedule date

Returns:
the schedule date

getTimeStarted

public java.util.Date getTimeStarted()
Return the time started

Returns:
the time started

setLastTime

public void setLastTime(java.util.Date date)
Sets the last time For internal use only

Parameters:
date - the last time

setPlanEnd

public void setPlanEnd(java.util.Date date)
Sets the plan end For internal use only

Parameters:
date - the plan end

setPlanStart

public void setPlanStart(java.util.Date date)
Sets the plan start For internal use only

Parameters:
date - the plan start

setRunNumber

public void setRunNumber(int i)
Sets the run number For internal use only

Parameters:
i - the run number

setScheduleDate

public void setScheduleDate(java.util.Date date)
Sets the schedule date For internal use only

Parameters:
date - the schedule date

setTimeStarted

public void setTimeStarted(java.util.Date date)
Sets the time started For internal use only

Parameters:
date - the time started

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this Symphony 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 Symphony object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all Symphony fields.

getSize

public int getSize()
Return the size of this Symphony

Returns:
the size of this Symphony

setSize

public void setSize(int i)
Sets the size of this Symphony For internal use only

Parameters:
i - the size of this Symphony

getType

public SymphonyType getType()
Returns the Symphony type Valid Values are: Archived, Trial, Forecast, Unknown.

Returns:
the symphony type

setType

public void setType(SymphonyType type)
Sets the Symphony type For Internal Use Only Valid Values are: Archived, Trial, Forecast, Unknown.

Parameters:
type - The symphony type.


Copyright © 2005 IBM All Rights Reserved.