IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class TaskListSyncInput

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

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

TaskListSyncInput is used to synchronize a task list on a client with the results of executing a saved search on the server.

See Also:
Serialized Form

Constructor Summary
TaskListSyncInput()
           
TaskListSyncInput(java.util.Calendar lastSyncDate, long savedSearchId, java.lang.String taskIdSet, java.lang.Boolean tasksFromTaskIdSetOnly)
           
 
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.util.Calendar getLastSyncDate()
          Gets the lastSyncDate value for this TaskListSyncInput.
 long getSavedSearchId()
          Gets the savedSearchId value for this TaskListSyncInput.
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 getTaskIdSet()
          Gets the taskIdSet value for this TaskListSyncInput.
 java.lang.Boolean getTasksFromTaskIdSetOnly()
          Gets the tasksFromTaskIdSetOnly value for this TaskListSyncInput.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return type metadata object
 int hashCode()
           
 void setLastSyncDate(java.util.Calendar lastSyncDate)
          Sets the lastSyncDate value for this TaskListSyncInput.
 void setSavedSearchId(long savedSearchId)
          Sets the savedSearchId value for this TaskListSyncInput.
 void setTaskIdSet(java.lang.String taskIdSet)
          Sets the taskIdSet value for this TaskListSyncInput.
 void setTasksFromTaskIdSetOnly(java.lang.Boolean tasksFromTaskIdSetOnly)
          Sets the tasksFromTaskIdSetOnly value for this TaskListSyncInput.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskListSyncInput

public TaskListSyncInput()

TaskListSyncInput

public TaskListSyncInput(java.util.Calendar lastSyncDate,
                         long savedSearchId,
                         java.lang.String taskIdSet,
                         java.lang.Boolean tasksFromTaskIdSetOnly)
Method Detail

getLastSyncDate

public java.util.Calendar getLastSyncDate()
Gets the lastSyncDate value for this TaskListSyncInput.

Returns:
lastSyncDate * LastSyncDate is the date/time that client last synchronized its task list with this saved search. May be missing or nil if the client has not synchronized this saved search previously, or if the client wishes to receive all tasks for this saved search regardless of modification date.

setLastSyncDate

public void setLastSyncDate(java.util.Calendar lastSyncDate)
Sets the lastSyncDate value for this TaskListSyncInput.

Parameters:
lastSyncDate - * LastSyncDate is the date/time that client last synchronized its task list with this saved search. May be missing or nil if the client has not synchronized this saved search previously, or if the client wishes to receive all tasks for this saved search regardless of modification date.

getSavedSearchId

public long getSavedSearchId()
Gets the savedSearchId value for this TaskListSyncInput.

Returns:
savedSearchId * The environment specific identifier for the saved search to synchronize

setSavedSearchId

public void setSavedSearchId(long savedSearchId)
Sets the savedSearchId value for this TaskListSyncInput.

Parameters:
savedSearchId - * The environment specific identifier for the saved search to synchronize

getTaskIdSet

public java.lang.String getTaskIdSet()
Gets the taskIdSet value for this TaskListSyncInput.

Returns:
taskIdSet * A comma-separated list of task ids that are in the client's task list for this saved search. The server will use this in conjunction with the LastSyncDate to determine whether or not the client should add, remove, or update tasks in its task list. May be missing or nil if the client has no tasks in their task list for this saved search or if they wish to receive all tasks for this saved search regardless of whether or not the client already has a copy of that task.

setTaskIdSet

public void setTaskIdSet(java.lang.String taskIdSet)
Sets the taskIdSet value for this TaskListSyncInput.

Parameters:
taskIdSet - * A comma-separated list of task ids that are in the client's task list for this saved search. The server will use this in conjunction with the LastSyncDate to determine whether or not the client should add, remove, or update tasks in its task list. May be missing or nil if the client has no tasks in their task list for this saved search or if they wish to receive all tasks for this saved search regardless of whether or not the client already has a copy of that task.

getTasksFromTaskIdSetOnly

public java.lang.Boolean getTasksFromTaskIdSetOnly()
Gets the tasksFromTaskIdSetOnly value for this TaskListSyncInput.

Returns:
tasksFromTaskIdSetOnly * This flag indicates to the server that it should only consider tasks that are in the TaskIdSet for synchronization. This allows the client to selectively refresh certain tasks without having to synchronize the whole task list with the saved search. May be missing or nil if the client desires a normal synchronization to take place.

setTasksFromTaskIdSetOnly

public void setTasksFromTaskIdSetOnly(java.lang.Boolean tasksFromTaskIdSetOnly)
Sets the tasksFromTaskIdSetOnly value for this TaskListSyncInput.

Parameters:
tasksFromTaskIdSetOnly - * This flag indicates to the server that it should only consider tasks that are in the TaskIdSet for synchronization. This allows the client to selectively refresh certain tasks without having to synchronize the whole task list with the saved search. May be missing or nil if the client desires a normal synchronization to take place.

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.