Visit Platform at http://www.platform.com

Platform Symphony 5.1 Java API Reference

com.platform.symphony.soam
Class TaskSubmissionAttributes

java.lang.Object
  extended by com.platform.symphony.soam.TaskSubmissionAttributes

public final class TaskSubmissionAttributes
extends java.lang.Object

Container for all attributes that may be required upon task submission.

NOTE: If any of the methods of this class are called after the main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).

See Also:
Session.sendTaskInput(TaskSubmissionAttributes)

Constructor Summary
TaskSubmissionAttributes()
          Default constructor.
 
Method Summary
 void setPriorityTask(boolean isPriorityTask)
          Sets the priority flag of the task.
 void setResourcePreference(ResourcePreference resourcePreference)
          Sets the resource preference object of the task.
 void setTaskInput(Message taskInput)
          Sets the input message for the task.
 void setTaskInput(java.io.Serializable taskInput)
          Sets the input object for the task.
 void setTaskTag(java.lang.String tag)
          Sets the task tag.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskSubmissionAttributes

public TaskSubmissionAttributes()
Default constructor. Constructs a TaskSubmissionAttributes object with default settings.

Method Detail

setPriorityTask

public void setPriorityTask(boolean isPriorityTask)
                     throws SoamException
Sets the priority flag of the task. This is a parameter which indicates to the middleware that the message being submitted should take priority in the current session. This means that the created task will be placed at the front of the dispatch queue. The default value for this parameter is false if not specified, in which case the newly created task will be placed at the rear of the dispatch queue.

Parameters:
isPriorityTask - Flag indicating whether the task should have priority or not.
Throws:
SoamException

setTaskInput

public void setTaskInput(Message taskInput)
                  throws SoamException
Sets the input message for the task. This method allows you to provide input data to the created task. It sends your task input to the service as a Symphony message.

Parameters:
taskInput - The input for the task.
Throws:
SoamException

setTaskInput

public void setTaskInput(java.io.Serializable taskInput)
                  throws SoamException
Sets the input object for the task. This method allows you to provide input data to the created task. It sends your task input to the service as a java.io.Serializable object.

Parameters:
taskInput - The input for the task.
Throws:
SoamException

setTaskTag

public void setTaskTag(java.lang.String tag)
                throws SoamException
Sets the task tag. The task tag is just a string that will be associated with the created task. Maximum length 128 characters. Default value is "", which means that no task tag is associated with the task.

Parameters:
tag - The task tag.
Throws:
SoamException

setResourcePreference

public void setResourcePreference(ResourcePreference resourcePreference)
                           throws SoamException
Sets the resource preference object of the task. The resource preference to be associated with the task.

Parameters:
resourcePreference - The resource preference of the task.
Throws:
SoamException

Version 5.1
Date Modified: -DREL_DATE=Apr 28 2011
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.