|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lombardisoftware.webapi.Favorite
public class Favorite
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.
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 |
---|
public 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 |
---|
public long getId()
public void setId(long id)
id
- * The environment specific identifier of the favoritepublic java.lang.String getName()
public void setName(java.lang.String name)
name
- * The name of the favorite.
Can be missing or nil if the Favorite is only partially
loaded.public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
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.public java.lang.Boolean getStartable()
public void setStartable(java.lang.Boolean startable)
startable
- * Specifies whether or not an instance of the item can be startedpublic FavoriteType getType()
public void setType(FavoriteType type)
type
- * The type of the favorite. Depending on the type the elements:
Service, Process, Scoreboard
and InfoPathForm/InfoPathFormOfflineOnly may be set.public Service getService()
public void setService(Service service)
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.public Process getProcess()
public void setProcess(Process process)
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.public InfoPathForm getInfoPathForm()
public void setInfoPathForm(InfoPathForm infoPathForm)
infoPathForm
- * For use by WLE for Officepublic java.lang.Boolean getInfoPathFormOfflineOnly()
public void setInfoPathFormOfflineOnly(java.lang.Boolean infoPathFormOfflineOnly)
infoPathFormOfflineOnly
- * For use by WLE for Officepublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |