com.ibm.tws.objects.model
Class ResourceHeader

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

public class ResourceHeader
extends java.lang.Object
implements TWSHeader

This class hosts the attributes to be shown in TWS external interfaces when listing resources.

See Also:
Resource, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
ResourceHeader()
          Creates an empty ResourceHeader.
ResourceHeader(Identifier resourceId)
          Creates a ResourceHeader with the specified identifier.
ResourceHeader(Identifier resourceId, ResourceKey resourceKey)
          Creates a ResourceHeader with the specified identifier and key.
ResourceHeader(ResourceKey resourceKey)
          Creates a ResourceHeader with the specified key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this ResourceHeader object are equal to those of the given one.
 ResourceBaseConstraints getDefaultConstraints()
          Returns the default resource constraints.
 java.lang.String getDescription()
          Returns the resource description.
 FlowTargetKey getFlowTargetKey()
          Returns the key of the workstation or workstation class referenced by this resource.
 Identifier getId()
          Returns the resource identifier.
 ResourceKey getKey()
          Returns the ResourceKey wrapped by this ResourceHeader object.
 LockData getLockData()
          Returns the resource lock data.
 ModifyData getModifyData()
          Returns the resource modification data.
 java.lang.String getName()
          Returns the resource name.
 TWSKey getObjectKey()
          Returns the resource key as a TWS key.
 int hashCode()
          Returns a hash code for this ResourceHeader object.
 void setDefaultConstraints(ResourceBaseConstraints constraints)
          Sets the default resource constraints.
 void setDescription(java.lang.String value)
          Sets the resource description.
 void setFlowTargetKey(FlowTargetKey trgKey)
          Sets the key of the workstation or workstation class referenced by this resource.
 void setId(Identifier identifier)
          Sets the resource identifier.
 void setKey(ResourceKey resourceKey)
          Sets the ResourceKey to be wrapped by this ResourceHeader object.
 void setLockData(LockData data)
          Sets the resource lock data.
 void setModifyData(ModifyData data)
          Sets the resource modification data.
 void setName(java.lang.String value)
          Sets the resource name.
 java.lang.String toString()
          Returns a string representation of this ResourceHeader 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

ResourceHeader

public ResourceHeader()
Creates an empty ResourceHeader.


ResourceHeader

public ResourceHeader(Identifier resourceId)
Creates a ResourceHeader with the specified identifier.

Parameters:
resourceId - The resource identifier.

ResourceHeader

public ResourceHeader(ResourceKey resourceKey)
Creates a ResourceHeader with the specified key.

Parameters:
resourceKey - The resource key.

ResourceHeader

public ResourceHeader(Identifier resourceId,
                      ResourceKey resourceKey)
Creates a ResourceHeader with the specified identifier and key.

Parameters:
resourceId - The resource identifier.
resourceKey - The resource key.
Method Detail

getId

public Identifier getId()
Returns the resource identifier.

Specified by:
getId in interface TWSHeader
Returns:
The resource identifier.

getObjectKey

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

Specified by:
getObjectKey in interface TWSHeader
Returns:
The resource key as a TWS key.

getKey

public ResourceKey getKey()
Returns the ResourceKey wrapped by this ResourceHeader object.

Returns:
The ResourceKey wrapped by this ResourceHeader object.

getName

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

Specified by:
getName in interface TWSHeader
Returns:
The resource name.

getFlowTargetKey

public FlowTargetKey getFlowTargetKey()
Returns the key of the workstation or workstation class referenced by this resource.

Returns:
The key of the workstation or workstation class referenced by this resource.

getDescription

public java.lang.String getDescription()
Returns the resource description.

Returns:
The resource description.

getDefaultConstraints

public ResourceBaseConstraints getDefaultConstraints()
Returns the default resource constraints.

Returns:
The default resource constraints.

getModifyData

public ModifyData getModifyData()
Returns the resource modification data.

Specified by:
getModifyData in interface TWSHeader
Returns:
The resource modification data.

getLockData

public LockData getLockData()
Returns the resource lock data.

Specified by:
getLockData in interface TWSHeader
Returns:
The resource lock data.

setId

public void setId(Identifier identifier)
Sets the resource identifier.

Parameters:
identifier - The resource identifier.

setKey

public void setKey(ResourceKey resourceKey)
Sets the ResourceKey to be wrapped by this ResourceHeader object.

Parameters:
resourceKey - The ResourceKey to be wrapped by this ResourceHeader object.

setName

public void setName(java.lang.String value)
Sets the resource name.

Parameters:
value - The resource name.

setFlowTargetKey

public void setFlowTargetKey(FlowTargetKey trgKey)
Sets the key of the workstation or workstation class referenced by this resource.

Parameters:
trgKey - The key of the workstation or workstation class referenced by this resource.

setDescription

public void setDescription(java.lang.String value)
Sets the resource description.

Parameters:
value - The resource description.

setDefaultConstraints

public void setDefaultConstraints(ResourceBaseConstraints constraints)
Sets the default resource constraints.

Parameters:
constraints - The default resource constraints.

setModifyData

public void setModifyData(ModifyData data)
Sets the resource modification data. For internal use only.

Parameters:
data - A ModifyData object.

setLockData

public void setLockData(LockData data)
Sets the resource 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 ResourceHeader 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 ResourceHeader object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all ResourceHeader fields.


Copyright © 2005 IBM All Rights Reserved.