IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class Scoreboard

java.lang.Object
  extended by com.lombardisoftware.webapi.Scoreboard
All Implemented Interfaces:
java.io.Serializable

public class Scoreboard
extends java.lang.Object
implements java.io.Serializable

A Scoreboard describes a set of reports usually describing process or task performance that can be viewed by the user.

See Also:
Serialized Form

Constructor Summary
Scoreboard()
           
Scoreboard(java.lang.String exposedId, java.lang.String reference, java.lang.String snapshotId, java.lang.String name, java.lang.String displayName, java.lang.String title, java.lang.String systemId)
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Deserializer
 java.lang.String getDisplayName()
          Gets the displayName value for this Scoreboard.
 java.lang.String getExposedId()
          Gets the exposedId value for this Scoreboard.
 java.lang.String getName()
          Gets the name value for this Scoreboard.
 java.lang.String getReference()
          Gets the reference value for this Scoreboard.
static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Serializer
 java.lang.String getSnapshotId()
          Gets the snapshotId value for this Scoreboard.
 java.lang.String getSystemId()
          Gets the systemId value for this Scoreboard.
 java.lang.String getTitle()
          Gets the title value for this Scoreboard.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return type metadata object
 int hashCode()
           
 void setDisplayName(java.lang.String displayName)
          Sets the displayName value for this Scoreboard.
 void setExposedId(java.lang.String exposedId)
          Sets the exposedId value for this Scoreboard.
 void setName(java.lang.String name)
          Sets the name value for this Scoreboard.
 void setReference(java.lang.String reference)
          Sets the reference value for this Scoreboard.
 void setSnapshotId(java.lang.String snapshotId)
          Sets the snapshotId value for this Scoreboard.
 void setSystemId(java.lang.String systemId)
          Sets the systemId value for this Scoreboard.
 void setTitle(java.lang.String title)
          Sets the title value for this Scoreboard.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Scoreboard

public Scoreboard()

Scoreboard

public Scoreboard(java.lang.String exposedId,
                  java.lang.String reference,
                  java.lang.String snapshotId,
                  java.lang.String name,
                  java.lang.String displayName,
                  java.lang.String title,
                  java.lang.String systemId)
Method Detail

getExposedId

public java.lang.String getExposedId()
Gets the exposedId value for this Scoreboard.

Returns:
exposedId * The exposed item id of the scoreboard. Note: This id is not the same as the scoreboard id.

setExposedId

public void setExposedId(java.lang.String exposedId)
Sets the exposedId value for this Scoreboard.

Parameters:
exposedId - * The exposed item id of the scoreboard. Note: This id is not the same as the scoreboard id.

getReference

public java.lang.String getReference()
Gets the reference value for this Scoreboard.

Returns:
reference * The externalized reference to the scoreboard

setReference

public void setReference(java.lang.String reference)
Sets the reference value for this Scoreboard.

Parameters:
reference - * The externalized reference to the scoreboard

getSnapshotId

public java.lang.String getSnapshotId()
Gets the snapshotId value for this Scoreboard.

Returns:
snapshotId * The snapshot id of the scoreboard

setSnapshotId

public void setSnapshotId(java.lang.String snapshotId)
Sets the snapshotId value for this Scoreboard.

Parameters:
snapshotId - * The snapshot id of the scoreboard

getName

public java.lang.String getName()
Gets the name value for this Scoreboard.

Returns:
name * The name of the scoreboard. Can be missing or nil if the Scoreboard is only partially loaded.

setName

public void setName(java.lang.String name)
Sets the name value for this Scoreboard.

Parameters:
name - * The name of the scoreboard. Can be missing or nil if the Scoreboard is only partially loaded.

getDisplayName

public java.lang.String getDisplayName()
Gets the displayName value for this Scoreboard.

Returns:
displayName * The disambiguous name of the scoreboard. Generally this will be the same as the Name unless there are more than one scoreboards are returned with the same name. In that case, it would include snapshot information and possibly even Process Application information to specify the correct version of the object. Can be missing or nil if the Favorite is only partially loaded.

setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the displayName value for this Scoreboard.

Parameters:
displayName - * The disambiguous name of the scoreboard. Generally this will be the same as the Name unless there are more than one scoreboards are returned with the same name. In that case, it would include snapshot information and possibly even Process Application information to specify the correct version of the object. Can be missing or nil if the Favorite is only partially loaded.

getTitle

public java.lang.String getTitle()
Gets the title value for this Scoreboard.

Returns:
title * The title of the scoreboard. Can be missing or nil if the Scoreboard is only partially loaded.

setTitle

public void setTitle(java.lang.String title)
Sets the title value for this Scoreboard.

Parameters:
title - * The title of the scoreboard. Can be missing or nil if the Scoreboard is only partially loaded.

getSystemId

public java.lang.String getSystemId()
Gets the systemId value for this Scoreboard.

Returns:
systemId * The system identifier of the scoreboard

setSystemId

public void setSystemId(java.lang.String systemId)
Sets the systemId value for this Scoreboard.

Parameters:
systemId - * The system identifier of the scoreboard

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return type metadata object


getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Custom Serializer


getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Custom Deserializer


IBM BPM API for Web Service Clients v8.0.0

(C) Copyright IBM Corporation 2011. All Rights Reserved.