IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class ExposedItem

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

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

An ExposedItem

See Also:
Serialized Form

Constructor Summary
ExposedItem()
           
ExposedItem(long id, java.lang.String name, java.lang.String type, java.lang.String displayName, java.lang.Boolean startable, java.lang.String URL, Service service, Process process, Scoreboard scoreboard, Report report, InfoPathForm infoPathForm, java.lang.Boolean infoPathFormOfflineOnly)
           
 
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 ExposedItem.
 long getId()
          Gets the id value for this ExposedItem.
 InfoPathForm getInfoPathForm()
          Gets the infoPathForm value for this ExposedItem.
 java.lang.Boolean getInfoPathFormOfflineOnly()
          Gets the infoPathFormOfflineOnly value for this ExposedItem.
 java.lang.String getName()
          Gets the name value for this ExposedItem.
 Process getProcess()
          Gets the process value for this ExposedItem.
 Report getReport()
          Gets the report value for this ExposedItem.
 Scoreboard getScoreboard()
          Gets the scoreboard value for this ExposedItem.
static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Serializer
 Service getService()
          Gets the service value for this ExposedItem.
 java.lang.Boolean getStartable()
          Gets the startable value for this ExposedItem.
 java.lang.String getType()
          Gets the type value for this ExposedItem.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return type metadata object
 java.lang.String getURL()
          Gets the URL value for this ExposedItem.
 int hashCode()
           
 void setDisplayName(java.lang.String displayName)
          Sets the displayName value for this ExposedItem.
 void setId(long id)
          Sets the id value for this ExposedItem.
 void setInfoPathForm(InfoPathForm infoPathForm)
          Sets the infoPathForm value for this ExposedItem.
 void setInfoPathFormOfflineOnly(java.lang.Boolean infoPathFormOfflineOnly)
          Sets the infoPathFormOfflineOnly value for this ExposedItem.
 void setName(java.lang.String name)
          Sets the name value for this ExposedItem.
 void setProcess(Process process)
          Sets the process value for this ExposedItem.
 void setReport(Report report)
          Sets the report value for this ExposedItem.
 void setScoreboard(Scoreboard scoreboard)
          Sets the scoreboard value for this ExposedItem.
 void setService(Service service)
          Sets the service value for this ExposedItem.
 void setStartable(java.lang.Boolean startable)
          Sets the startable value for this ExposedItem.
 void setType(java.lang.String type)
          Sets the type value for this ExposedItem.
 void setURL(java.lang.String URL)
          Sets the URL value for this ExposedItem.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExposedItem

public ExposedItem()

ExposedItem

public ExposedItem(long id,
                   java.lang.String name,
                   java.lang.String type,
                   java.lang.String displayName,
                   java.lang.Boolean startable,
                   java.lang.String URL,
                   Service service,
                   Process process,
                   Scoreboard scoreboard,
                   Report report,
                   InfoPathForm infoPathForm,
                   java.lang.Boolean infoPathFormOfflineOnly)
Method Detail

getId

public long getId()
Gets the id value for this ExposedItem.

Returns:
id * The environment specific identifier of the exposed item

setId

public void setId(long id)
Sets the id value for this ExposedItem.

Parameters:
id - * The environment specific identifier of the exposed item

getName

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

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

setName

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

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

getType

public java.lang.String getType()
Gets the type value for this ExposedItem.

Returns:
type * The name of the exposed item type to filter by. Currently supported searchable types are:
  • Service
  • Scoreboard
  • Process
  • Report
These values are also made available via the ExposedItemType enumeration type for the convenience of the client programmer.

setType

public void setType(java.lang.String type)
Sets the type value for this ExposedItem.

Parameters:
type - * The name of the exposed item type to filter by. Currently supported searchable types are:
  • Service
  • Scoreboard
  • Process
  • Report
These values are also made available via the ExposedItemType enumeration type for the convenience of the client programmer.

getDisplayName

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

Returns:
displayName * The disambiguous name of the exposeditem. Generally this will be the same as the Name unless there are more than one favorites 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 ExposedItem is only partially loaded.

setDisplayName

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

Parameters:
displayName - * The disambiguous name of the exposeditem. Generally this will be the same as the Name unless there are more than one favorites 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 ExposedItem is only partially loaded.

getStartable

public java.lang.Boolean getStartable()
Gets the startable value for this ExposedItem.

Returns:
startable * Specifies whether or not an instance of the item can be started

setStartable

public void setStartable(java.lang.Boolean startable)
Sets the startable value for this ExposedItem.

Parameters:
startable - * Specifies whether or not an instance of the item can be started

getURL

public java.lang.String getURL()
Gets the URL value for this ExposedItem.

Returns:
URL * Specifies the URL of an item exposed via URL (e.g. Scoreboards, Services, Reports)

setURL

public void setURL(java.lang.String URL)
Sets the URL value for this ExposedItem.

Parameters:
URL - * Specifies the URL of an item exposed via URL (e.g. Scoreboards, Services, Reports)

getService

public Service getService()
Gets the service value for this ExposedItem.

Returns:
service * The service associated with this exposed item if the Type is SERVICE. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type SERVICE.

setService

public void setService(Service service)
Sets the service value for this ExposedItem.

Parameters:
service - * The service associated with this exposed item if the Type is SERVICE. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type SERVICE.

getProcess

public Process getProcess()
Gets the process value for this ExposedItem.

Returns:
process * The process associated with this exposed item if the Type is PROCESS. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type PROCESS.

setProcess

public void setProcess(Process process)
Sets the process value for this ExposedItem.

Parameters:
process - * The process associated with this exposed item if the Type is PROCESS. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type PROCESS.

getScoreboard

public Scoreboard getScoreboard()
Gets the scoreboard value for this ExposedItem.

Returns:
scoreboard * The scoreboard associated with this exposed item if the Type is SCOREBOARD. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type SCOREBOARD.

setScoreboard

public void setScoreboard(Scoreboard scoreboard)
Sets the scoreboard value for this ExposedItem.

Parameters:
scoreboard - * The scoreboard associated with this exposed item if the Type is SCOREBOARD. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type SCOREBOARD.

getReport

public Report getReport()
Gets the report value for this ExposedItem.

Returns:
report * The report associated with this exposed item if the Type is REPORT. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type REPORT.

setReport

public void setReport(Report report)
Sets the report value for this ExposedItem.

Parameters:
report - * The report associated with this exposed item if the Type is REPORT. Can be missing or nil if the exposed item is only partially loaded or if the exposed item is not of type REPORT.

getInfoPathForm

public InfoPathForm getInfoPathForm()
Gets the infoPathForm value for this ExposedItem.

Returns:
infoPathForm * For use by WLE for Office

setInfoPathForm

public void setInfoPathForm(InfoPathForm infoPathForm)
Sets the infoPathForm value for this ExposedItem.

Parameters:
infoPathForm - * For use by WLE for Office

getInfoPathFormOfflineOnly

public java.lang.Boolean getInfoPathFormOfflineOnly()
Gets the infoPathFormOfflineOnly value for this ExposedItem.

Returns:
infoPathFormOfflineOnly * For use by WLE for Office

setInfoPathFormOfflineOnly

public void setInfoPathFormOfflineOnly(java.lang.Boolean infoPathFormOfflineOnly)
Sets the infoPathFormOfflineOnly value for this ExposedItem.

Parameters:
infoPathFormOfflineOnly - * For use by WLE for Office

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.