|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.WorkstationInPlan
This class represents a workstation, and references a domain and a host workstation (for XA or SA type). WorkstationInPlan implements both TWSObject and TWSHeader and wraps a WorkstationInPlanKey object.
The following syntax validation constraints must be met on WorkstationInPlan objects in distributed environment:
type | One of the values exposed by the WorkstationInPlanType class |
Read Only. | |
os | One of the values exposed by the OperatingSystem class |
Read Only. | |
timeZone | If specified, must be allowed by TZ library and Java |
Read Only. | |
nodeName | Read Only. |
securityLevel | One of the values exposed by the SecurityLevel class |
Read Only. | |
behindFirewall | Read Only. |
tcpPort | Read Only. |
sslPort | Read Only. |
domainKey | Reference to an existing domain. Read Only. |
Null if type is XA. Read Only. | |
autoLink | Read Only. |
fullStatus | true if type is MANAGER. Read Only. |
server | An alphanumeric character, or a blank space |
Read Only. | |
accessMethod | Required if type is XA |
Must be null if type is not XA | |
Read Only. | |
hostWorkstationKey | Reference to an existing workstation |
Read Only. | |
linkStatus | One of the values exposed by the LinkStatus class |
Read Only. | |
limit | Int between -1 and 1024. Read Only. |
The value can be changed through specific API. | |
fence | Int between 0 and 101. |
The value can be changed through specific API. | |
version | Read Only. |
symRunNumber | Read Only. |
timeStarted | Read Only. |
elapsedTime | Read Only. |
userInfo | Read Only. |
requested | Read Only. |
defuser | Read Only. |
jobmanUp | Read Only. |
tcpLink | Read Only. |
writerUp | Read Only. |
writerDs | Read Only. |
symDwnld | Read Only. |
isInited | Read Only. |
initExec | Read Only. |
mailReceived | Read Only. |
resolveDependencies | Read Only. |
description | Read Only. |
The following syntax validation constraints must be met on WorkstationInPlan objects in zOS environment:
name | Always required |
It must match the name of an existing workstation in database | |
description | Output only |
type | One of the values exposed by the WorkstationInPlanType class |
Output only | |
linkStatus | One of the values exposed by the LinkStatus class |
This flag is ignored if the version of Tivoli Workload Scheduler for zOS is prior to 8.1. | |
Default value is Unlinked. | |
LinkStatus.LINKED is ignored if type not equal WorkstationType.FTA. | |
LinkStatus.FULLY_LINKED is ignored if the version of Tivoli Workload Scheduler for zOS is prior to 8.2.0.3 | |
workstationInPlanAvailabilityIntervals | List of WorkstationInPlanAvailabilityIntervals |
See WorkstationInPlanAvailabilityIntervals for constraints on this field | |
alternateWorkstation | Default is a WorkstationKey with null name |
If specified it must match the key of an existing workstation in current plan | |
ZOSAttributes | See WorkstationInPlanZOSAttributes for constraints on this field |
os | N/A |
timeZone | N/A |
nodeName | N/A |
securityLevel | N/A |
behindFirewall | N/A |
tcpPort | N/A |
sslPort | N/A |
domainKey | N/A |
autoLink | N/A |
fullStatus | N/A |
server | N/A |
accessMethod | N/A |
hostWorkstationKey | N/A |
limit | N/A |
fence | N/A |
version | N/A |
symRunNumber | N/A |
timeStarted | N/A |
elapsedTime | N/A |
userInfo | N/A |
requested | N/A |
defuser | N/A |
jobmanUp | N/A |
tcpLink | N/A |
writerUp | N/A |
writerDs | N/A |
symDwnld | N/A |
isInited | N/A |
initExec | N/A |
mailReceived | N/A |
resolveDependencies | N/A |
automation | true if is a system automation type |
com.ibm.tws.objects.types.WorkstationInPlanType
,
OperatingSystem
,
SecurityLevel
,
LinkStatus
,
WorkstationInPlanZOSAttributes
,
WorkstationInPlanAvailabilityIntervals
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright |
Constructor Summary | |
---|---|
WorkstationInPlan()
Creates an empty Workstation. |
|
WorkstationInPlan(Identifier workstationId)
Creates a WorkstationInPlan with the specified Identifier. |
|
WorkstationInPlan(Identifier workstationId,
WorkstationInPlanKey workstationKey)
Creates a WorkstationInPlan with the specified Identifier and key. |
|
WorkstationInPlan(WorkstationInPlanKey workstationKey)
Creates a WorkstationInPlan with the specified key. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this WorkstationInPlan object are equal to those of the given one. |
java.lang.String |
getAccessMethod()
Returns the access method. |
WorkstationInPlanKey |
getAlternateWorkstation()
z/OS only method. |
boolean |
getAutoLink()
Return if this Workstation is Autolink or not. |
java.lang.String |
getDefuser()
Return the default user. |
java.lang.String |
getDescription()
Returns the Workstation description z/OS only method. |
Identifier |
getDomainId()
Returns The Identifier of the Domain to which this Workstation refer. |
DomainInPlanKey |
getDomainKey()
Return the Domain key to which this Workstation refer. |
long |
getElapsedTime()
Return the elapsed time |
int |
getFence()
Return the fence of this workstation. |
Identifier |
getHostWorkstationId()
Gets the host Workstation Identifier |
WorkstationInPlanKey |
getHostWorkstationKey()
Return the key of the host workstation |
Identifier |
getId()
Get the object Identifier |
WorkstationInPlanKey |
getKey()
Returns The Workstation key |
int |
getLimit()
Return the workstation limit. |
LinkStatus |
getLinkStatus()
Return the Link Status of this Workstation |
LockData |
getLockData()
Returns always null because locking is not available for objects in plan. |
ModifyData |
getModifyData()
Returns always null because modification info are not available for objects in plan. |
java.lang.String |
getName()
Get The Name of this Workstation |
java.lang.String |
getNodeName()
Get the node name |
TWSHeader |
getObjectHeader()
Returns the object header. |
TWSKey |
getObjectKey()
Returns the object key. |
OperatingSystem |
getOs()
Get the Operating System of this Workstation. |
int |
getRequested()
Get the number of requested jobs |
int |
getRunNumber()
Get the Run Number. |
SecurityLevel |
getSecurityLevel()
Get the Security Level. |
char |
getServer()
Get The Server Code. |
int |
getSslPort()
Get the SSL port. |
int |
getSymRunNumber()
Deprecated. |
int |
getTcpPort()
Get the TCP/IP port |
java.util.Date |
getTimeStarted()
Get the Time this Workstation started |
java.lang.String |
getTimeZone()
Get the Timezone |
WorkstationType |
getType()
Get the Workstation type. |
java.lang.String |
getUserInfo()
Get The User Information |
java.lang.String |
getVersion()
Return the version of the Workstation. |
java.util.List |
getWorkstationInPlanAvailabilityIntervals()
z/OS only method. |
WorkstationInPlanZOSAttributes |
getZOSAttributes()
z/OS only method. |
int |
hashCode()
Returns a hash code for this Workstation object. |
boolean |
isAutomation()
Verify if this Workstation is a system automation type |
boolean |
isBehindFirewall()
Verify if this Workstation is behind a Firewall |
boolean |
isFullStatus()
Returns if this Workstation is full status or not |
boolean |
isInited()
Returns true if Workstation is initialized |
boolean |
isInitExec()
Returns true if JobMan is updating Workstation for exececuting job |
boolean |
isJobmanUp()
Returns true if JobMan is up and running |
boolean |
isMailReceived()
Used to check if the link is Up |
boolean |
isResolveDependencies()
Returns if this Workstation resolves dependencies |
boolean |
isSymDwnld()
Returns true if the symphony for the next day has been downloaded |
boolean |
isTcpLink()
Retruns true if this Workstation is TCP/IP linked |
boolean |
isWriterDs()
Returns true if Mailman is writing to Mailbox |
boolean |
isWriterUp()
Returns true if the Writer is up |
void |
setAccessMethod(java.lang.String string)
Set the access method. |
void |
setAlternateWorkstation(WorkstationInPlanKey alternateWorkstationkey)
z/OS only method. |
void |
setAutoLink(boolean value)
Sets if this Workstation is autolink For internal use only. |
void |
setAutomation(boolean value)
Set true if this Workstation is a system automation type. |
void |
setBehindFirewall(boolean b)
Set if this Workstation is behind Firewall. |
void |
setDefuser(java.lang.String string)
Set the Default User. |
void |
setDescription(java.lang.String description)
Sets the Description. |
void |
setDomainId(Identifier identifier)
Sets the Identifier of the Domain to which this Workstation refer. |
void |
setDomainKey(DomainInPlanKey key)
Set the key of the Domain referenced by this Workstation. |
void |
setElapsedTime(int i)
Deprecated. |
void |
setElapsedTime(long l)
Sets the elapsed time from the start Time. |
void |
setFence(int s)
Set the Workstation fence. |
void |
setFullStatus(boolean value)
Sets if this Workstation is full status. |
void |
setHostWorkstationId(Identifier identifier)
Sets the host Workstation Identifier. |
void |
setHostWorkstationKey(WorkstationInPlanKey key)
Set the new key of the host workstation. |
void |
setId(Identifier identifier)
Sets the object Identifier. |
void |
setInited(boolean b)
Sets if this Workstation is Initialized For internal use only. |
void |
setInitExec(boolean b)
Sets if JobMan is updating Workstation for exececuting job For internal use only. |
void |
setJobmanUp(boolean b)
Sets if JobMan is up and Running For internal use only. |
void |
setKey(WorkstationInPlanKey key)
Sets the Workstation key |
void |
setLimit(int s)
Set the Workstation Limit. |
void |
setLinkStatus(LinkStatus status)
Sets the Link status of this Workstation. |
void |
setMailReceived(boolean b)
Sets if the link is up For internal use only. |
void |
setName(java.lang.String string)
Set the name of this Workstation. |
void |
setNodeName(java.lang.String string)
Set the Node Name. |
void |
setOs(OperatingSystem value)
Set the Operating System. |
void |
setRequested(int s)
Set the number of job requested. |
void |
setResolveDependencies(boolean b)
Sets if this workstation resolves the dependencies For internal use only. |
void |
setRunNumber(int s)
Set the Symphony RunNumber. |
void |
setSecurityLevel(SecurityLevel s)
Set the Security Level. |
void |
setServer(char s)
Set the Server Code. |
void |
setSslPort(int i)
Set the SSL Port. |
void |
setSymDwnld(boolean b)
Sets if the Symphony for the next day has been downloaded. |
void |
setSymRunNumber(int i)
Deprecated. |
void |
setTcpLink(boolean b)
Sets if this Workstation is TCP/IP linked For internal use only. |
void |
setTcpPort(int i)
Set the TCP/IP Port. |
void |
setTimeStarted(java.util.Date i)
Set the Time this Workstation Started. |
void |
setTimeZone(java.lang.String string)
Set the Workstation Time Zone. |
void |
setType(WorkstationType s)
Set the Workstation Type. |
void |
setUserInfo(java.lang.String string)
Set the User Information. |
void |
setVersion(java.lang.String string)
Set the version of the workstation For Internal Use Only. |
void |
setWriterDs(boolean b)
Sets if Mailman is writing to Mailbox For internal use only. |
void |
setWriterUp(boolean b)
Sets if Writer is Up For internal use only. |
void |
setZOSAttributes(WorkstationInPlanZOSAttributes attributes)
z/OS only method. |
java.lang.String |
toString()
Returns a string representation of this Workstation. |
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 WorkstationInPlan()
public WorkstationInPlan(Identifier workstationId)
workstationId
- the workstation Identifier.public WorkstationInPlan(WorkstationInPlanKey workstationKey)
workstationKey
- The workstation key.public WorkstationInPlan(Identifier workstationId, WorkstationInPlanKey workstationKey)
workstationId
- is the workstation Identifier.workstationKey
- is the workstation key.Method Detail |
public ModifyData getModifyData()
getModifyData
in interface TWSObject
public LockData getLockData()
getLockData
in interface TWSObject
public java.lang.String getAccessMethod()
public int getLimit()
public java.lang.String getDefuser()
public DomainInPlanKey getDomainKey()
public long getElapsedTime()
public int getFence()
public WorkstationInPlanKey getHostWorkstationKey()
public java.lang.String getVersion()
public int getTcpPort()
public java.lang.String getNodeName()
public WorkstationType getType()
public int getRequested()
public SecurityLevel getSecurityLevel()
public char getServer()
public int getSslPort()
public int getRunNumber()
public java.util.Date getTimeStarted()
public java.lang.String getTimeZone()
public java.lang.String getUserInfo()
public boolean isBehindFirewall()
public void setAccessMethod(java.lang.String string)
string
- The Access Method.public void setLimit(int s)
s
- The new Workstation Limitpublic void setDefuser(java.lang.String string)
string
- The new Default User.public void setElapsedTime(int i)
i
- The new elapsed time.public void setFence(int s)
s
- The new fence valuepublic void setHostWorkstationKey(WorkstationInPlanKey key)
key
- the new key of the host workstation.public void setVersion(java.lang.String string)
string
- the workstation version.public void setTcpPort(int i)
i
- The TCP/IP portpublic void setNodeName(java.lang.String string)
string
- The node Name.public void setType(WorkstationType s)
s
- The Workstation type.public void setRequested(int s)
s
- The number of job requested.public void setSecurityLevel(SecurityLevel s)
s
- the Security Level.public void setServer(char s)
s
- the Server Code.public void setSslPort(int i)
i
- the SSL port.public void setRunNumber(int s)
s
- the Symphony RunNumberpublic void setTimeStarted(java.util.Date i)
i
- The time this Workstation started.public void setTimeZone(java.lang.String string)
string
- the Workstation timezone.public void setUserInfo(java.lang.String string)
string
- the User Information.public void setBehindFirewall(boolean b)
b
- true if this Workstation is behind a Firewall, false otherwise.public void setName(java.lang.String string)
string
- The name of the Workstation.public void setOs(OperatingSystem value)
value
- The Workstation Operating System.public int hashCode()
public boolean equals(java.lang.Object object)
object
- The object to be compared
public java.lang.String getName()
getName
in interface TWSObject
public OperatingSystem getOs()
public void setDomainKey(DomainInPlanKey key)
key
- the Domain key.public boolean getAutoLink()
public void setAutoLink(boolean value)
value
- true if this Workstation is autolink, false otherwise.public boolean isFullStatus()
public void setFullStatus(boolean value)
value
- true if this Workstation is full status, false otherwise.public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
TWSHeader.getObjectKey()
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
TWSObject.getObjectHeader()
public Identifier getId()
getId
in interface TWSObject
public void setId(Identifier identifier)
identifier
- the enw object Identifierpublic java.lang.String toString()
public Identifier getHostWorkstationId()
public void setHostWorkstationId(Identifier identifier)
identifier
- the new host Workstation Identifierpublic Identifier getDomainId()
public WorkstationInPlanKey getKey()
public LinkStatus getLinkStatus()
public int getSymRunNumber()
public void setDomainId(Identifier identifier)
identifier
- The Domain Identifier.public void setElapsedTime(long l)
l
- The elapsed Time.public void setKey(WorkstationInPlanKey key)
key
- he Workstation keypublic void setLinkStatus(LinkStatus status)
status
- The Workstation link status.public void setSymRunNumber(int i)
i
- the Symphony Run Numberpublic boolean isInitExec()
public boolean isInited()
public boolean isJobmanUp()
public boolean isSymDwnld()
public boolean isTcpLink()
public boolean isWriterDs()
public boolean isWriterUp()
public void setInitExec(boolean b)
b
- true if JobMan is updating Workstation for exececuting jobpublic void setInited(boolean b)
b
- true if this Workstation is Initializedpublic void setJobmanUp(boolean b)
b
- true if JobMan is up and runningpublic void setSymDwnld(boolean b)
b
- true if the Symphony for the next day has been downloaded.public void setTcpLink(boolean b)
b
- true if this Workstation is TCP/IP linkedpublic void setWriterDs(boolean b)
b
- true if Mailman is writing to Mailboxpublic void setWriterUp(boolean b)
b
- true if Writer is up.public boolean isMailReceived()
public void setMailReceived(boolean b)
b
- true if the link is uppublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- The description to set.public WorkstationInPlanKey getAlternateWorkstation()
public void setAlternateWorkstation(WorkstationInPlanKey alternateWorkstationkey)
alternateWorkstationkey
- The alternateWorkstation to set.public WorkstationInPlanZOSAttributes getZOSAttributes()
public void setZOSAttributes(WorkstationInPlanZOSAttributes attributes)
attributes
- The zOSAttributes to set. For internal use only.public java.util.List getWorkstationInPlanAvailabilityIntervals()
public boolean isResolveDependencies()
public void setResolveDependencies(boolean b)
b
- true if this workstation resolves the dependenciespublic boolean isAutomation()
public void setAutomation(boolean value)
value
- true if this Workstation is a system automation type, false otherwise.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |