IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class Favorite

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

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

A Favorite defines a way for users to start a process or a service based on their membership in the role associated with the favorite. Favorites are created using the WLE administration web application using the Maintain Portal Favorites tool.

See Also:
Serialized Form

Constructor Summary
Favorite()
           
Favorite(long id, java.lang.String name, java.lang.String displayName, java.lang.Boolean startable, FavoriteType type, Service service, Process process, 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 Favorite.
 long getId()
          Gets the id value for this Favorite.
 InfoPathForm getInfoPathForm()
          Gets the infoPathForm value for this Favorite.
 java.lang.Boolean getInfoPathFormOfflineOnly()
          Gets the infoPathFormOfflineOnly value for this Favorite.
 java.lang.String getName()
          Gets the name value for this Favorite.
 Process getProcess()
          Gets the process value for this Favorite.
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 Favorite.
 java.lang.Boolean getStartable()
          Gets the startable value for this Favorite.
 FavoriteType getType()
          Gets the type value for this Favorite.
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 Favorite.
 void setId(long id)
          Sets the id value for this Favorite.
 void setInfoPathForm(InfoPathForm infoPathForm)
          Sets the infoPathForm value for this Favorite.
 void setInfoPathFormOfflineOnly(java.lang.Boolean infoPathFormOfflineOnly)
          Sets the infoPathFormOfflineOnly value for this Favorite.
 void setName(java.lang.String name)
          Sets the name value for this Favorite.
 void setProcess(Process process)
          Sets the process value for this Favorite.
 void setService(Service service)
          Sets the service value for this Favorite.
 void setStartable(java.lang.Boolean startable)
          Sets the startable value for this Favorite.
 void setType(FavoriteType type)
          Sets the type value for this Favorite.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Favorite

public Favorite()

Favorite

public Favorite(long id,
                java.lang.String name,
                java.lang.String displayName,
                java.lang.Boolean startable,
                FavoriteType type,
                Service service,
                Process process,
                InfoPathForm infoPathForm,
                java.lang.Boolean infoPathFormOfflineOnly)
Method Detail

getId

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

Returns:
id * The environment specific identifier of the favorite

setId

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

Parameters:
id - * The environment specific identifier of the favorite

getName

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

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

setName

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

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

getDisplayName

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

Returns:
displayName * The disambiguous name of the favorite. 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 Favorite is only partially loaded.

setDisplayName

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

Parameters:
displayName - * The disambiguous name of the favorite. 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 Favorite is only partially loaded.

getStartable

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

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 Favorite.

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

getType

public FavoriteType getType()
Gets the type value for this Favorite.

Returns:
type * The type of the favorite. Depending on the type the elements: Service, Process, Scoreboard and InfoPathForm/InfoPathFormOfflineOnly may be set.

setType

public void setType(FavoriteType type)
Sets the type value for this Favorite.

Parameters:
type - * The type of the favorite. Depending on the type the elements: Service, Process, Scoreboard and InfoPathForm/InfoPathFormOfflineOnly may be set.

getService

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

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

setService

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

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

getProcess

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

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

setProcess

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

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

getInfoPathForm

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

Returns:
infoPathForm * For use by WLE for Office

setInfoPathForm

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

Parameters:
infoPathForm - * For use by WLE for Office

getInfoPathFormOfflineOnly

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

Returns:
infoPathFormOfflineOnly * For use by WLE for Office

setInfoPathFormOfflineOnly

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

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.