com.ibm.tws.objects.model
Class WorkstationHeader

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

public class WorkstationHeader
extends FlowTargetHeader

This subclass of FlowTargetHeader hosts the attributes to be shown by TWS external interfaces when listing workstations in addition to those already hosted by the FlowTargetHeader class.

See Also:
Workstation, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
WorkstationHeader()
          Creates an empty WorkstationHeader.
WorkstationHeader(FlowTargetKey workstationKey)
          Creates a WorkstationHeader with the specified key.
WorkstationHeader(Identifier workstationId)
          Creates a WorkstationHeader with the specified identifier.
WorkstationHeader(Identifier workstationId, FlowTargetKey workstationKey)
          Creates a WorkstationHeader with the specified identifier and key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this WorkstationHeader object are equal to those of the given one.
 DomainKey getDomainKey()
          Returns the key of the domain to which the workstation is associated.
 java.lang.String getNodeName()
          Returns the workstation node name.
 OperatingSystem getOs()
          Returns the workstation operating system.
 WorkstationReportingAttribute getReportingAttribute()
          Returns the workstation reporting attribute.
 SecurityLevel getSecurityLevel()
          Returns the workstation security level.
 int getSslPort()
          Returns the workstation SSL port.
 int getTcpPort()
          Returns the workstation TCP port.
 java.lang.String getTimeZone()
          Returns the workstation timezone.
 WorkstationType getType()
          Returns the workstation type.
 int hashCode()
          Returns a hash code for this WorkstationHeader object.
 boolean isAutomation()
          Returns true if the workstation is a system automation type.
 boolean isBehindFirewall()
          Returns true if the workstation is behind a firewall.
 void setAutomation(boolean value)
          Sets the property used to decide if the workstation is a system automation type.
 void setBehindFirewall(boolean value)
          Sets the property used to decide if the workstation is behind a firewall.
 void setDomainKey(DomainKey key)
          Sets the key of the domain to which the workstation is associated.
 void setNodeName(java.lang.String value)
          Sets the workstation node name.
 void setOs(OperatingSystem value)
          Sets the workstation operating system.
 void setReportingAttribute(WorkstationReportingAttribute value)
          Sets the workstation reporting attribute.
 void setSecurityLevel(SecurityLevel value)
          Sets the workstation security level.
 void setSslPort(int value)
          Sets the workstation SSL port.
 void setTcpPort(int value)
          Sets the workstation TCP port.
 void setTimeZone(java.lang.String value)
          Sets the workstation timezone.
 void setType(WorkstationType value)
          Sets the workstation type.
 java.lang.String toString()
          Returns a string representation of this WorkstationHeader object.
 
Methods inherited from class com.ibm.tws.objects.model.FlowTargetHeader
getDescription, getId, getIncludeInPlan, getKey, getLockData, getModifyData, getName, getObjectKey, setDescription, setId, setIncludeInPlan, setKey, setLockData, setModifyData, setName
 
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

WorkstationHeader

public WorkstationHeader()
Creates an empty WorkstationHeader.


WorkstationHeader

public WorkstationHeader(Identifier workstationId)
Creates a WorkstationHeader with the specified identifier.

Parameters:
workstationId - The workstation identifier.

WorkstationHeader

public WorkstationHeader(FlowTargetKey workstationKey)
Creates a WorkstationHeader with the specified key.

Parameters:
workstationKey - The workstation key.

WorkstationHeader

public WorkstationHeader(Identifier workstationId,
                         FlowTargetKey workstationKey)
Creates a WorkstationHeader with the specified identifier and key.

Parameters:
workstationId - The workstation identifier.
workstationKey - The workstation key.
Method Detail

getType

public WorkstationType getType()
Returns the workstation type.

Returns:
The workstation type.

getOs

public OperatingSystem getOs()
Returns the workstation operating system.

Returns:
The workstation operating system.

getTimeZone

public java.lang.String getTimeZone()
Returns the workstation timezone.

Returns:
The workstation timezone.

getNodeName

public java.lang.String getNodeName()
Returns the workstation node name.

Returns:
The workstation node name.

getSecurityLevel

public SecurityLevel getSecurityLevel()
Returns the workstation security level.

Returns:
The workstation security level.

isBehindFirewall

public boolean isBehindFirewall()
Returns true if the workstation is behind a firewall.

Returns:
True if the workstation is behind a firewall.

getSslPort

public int getSslPort()
Returns the workstation SSL port.

Returns:
The workstation SSL port.

getTcpPort

public int getTcpPort()
Returns the workstation TCP port.

Returns:
The workstation TCP port.

getDomainKey

public DomainKey getDomainKey()
Returns the key of the domain to which the workstation is associated.

Returns:
The key of the domain to which the workstation is associated.

getReportingAttribute

public WorkstationReportingAttribute getReportingAttribute()
Returns the workstation reporting attribute. This is valid only for a z/OS workstation.

Returns:
The workstation reporting attribute.

isAutomation

public boolean isAutomation()
Returns true if the workstation is a system automation type. This is valid only for a z/OS workstation.

Returns:
True if the workstation is a system automation type.

setType

public void setType(WorkstationType value)
Sets the workstation type.

Parameters:
value - The workstation type.

setOs

public void setOs(OperatingSystem value)
Sets the workstation operating system.

Parameters:
value - The workstation operating system.

setTimeZone

public void setTimeZone(java.lang.String value)
Sets the workstation timezone.

Parameters:
value - The workstation timezone.

setNodeName

public void setNodeName(java.lang.String value)
Sets the workstation node name.

Parameters:
value - The workstation node name.

setSecurityLevel

public void setSecurityLevel(SecurityLevel value)
Sets the workstation security level.

Parameters:
value - The workstation security level.

setBehindFirewall

public void setBehindFirewall(boolean value)
Sets the property used to decide if the workstation is behind a firewall.

Parameters:
value - True if the workstation is behind a firewall.

setSslPort

public void setSslPort(int value)
Sets the workstation SSL port.

Parameters:
value - The workstation SSL port.

setTcpPort

public void setTcpPort(int value)
Sets the workstation TCP port.

Parameters:
value - The workstation TCP port.

setDomainKey

public void setDomainKey(DomainKey key)
Sets the key of the domain to which the workstation is associated.

Parameters:
key - The key of the domain to which the workstation is associated.

setReportingAttribute

public void setReportingAttribute(WorkstationReportingAttribute value)
Sets the workstation reporting attribute. This is valid only for a z/OS workstation.

Parameters:
value - The workstation reporting attribute.

setAutomation

public void setAutomation(boolean value)
Sets the property used to decide if the workstation is a system automation type. This is valid only for a z/OS workstation.

Parameters:
value - True if the workstation is a system automation type.

equals

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

Overrides:
equals in class FlowTargetHeader
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 WorkstationHeader object.

Overrides:
hashCode in class FlowTargetHeader
Returns:
The object's hash code.

toString

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

Overrides:
toString in class FlowTargetHeader
Returns:
A text string including all WorkstationHeader fields.


Copyright © 2005 IBM All Rights Reserved.