Options (Salesforce Marketing Cloud Java SDK 1.5.1 API)

java.lang.Object
- com.exacttarget.fuelsdk.internal.Options

Direct Known Subclasses:: ConfigureOptions, CreateOptions, DeleteOptions, ExtractOptions, PerformOptions, RetrieveOptions, RetrieveSingleOptions, ScheduleOptions, SystemStatusOptions, UpdateOptions

public abstract class Options
extends Object

Java class for Options complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Options">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Client" type="{http://exacttarget.com/wsdl/partnerAPI}ClientID" minOccurs="0"/>
         <element name="SendResponseTo" type="{http://exacttarget.com/wsdl/partnerAPI}AsyncResponse" maxOccurs="unbounded" minOccurs="0"/>
         <element name="SaveOptions" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="SaveOption" type="{http://exacttarget.com/wsdl/partnerAPI}SaveOption" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="Priority" type="{http://www.w3.org/2001/XMLSchema}byte" minOccurs="0"/>
         <element name="ConversationID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SequenceCode" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="CallsInConversation" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ScheduledTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="RequestType" type="{http://exacttarget.com/wsdl/partnerAPI}RequestType" minOccurs="0"/>
         <element name="QueuePriority" type="{http://exacttarget.com/wsdl/partnerAPI}Priority" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Options.SaveOptions
Java class for anonymous complex type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Options.SaveOptions` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`callsInConversation`
`protected ClientID`	`client`
`protected String`	`conversationID`
`protected Byte`	`priority`
`protected Priority`	`queuePriority`
`protected RequestType`	`requestType`
`protected Options.SaveOptions`	`saveOptions`
`protected Date`	`scheduledTime`
`protected List<AsyncResponse>`	`sendResponseTo`
`protected Integer`	`sequenceCode`

Constructor Summary

Constructors
Constructor and Description

Options()

Constructors
Constructor and Description
`Options()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getCallsInConversation()` Gets the value of the callsInConversation property.
`ClientID`	`getClient()` Gets the value of the client property.
`String`	`getConversationID()` Gets the value of the conversationID property.
`Byte`	`getPriority()` Gets the value of the priority property.
`Priority`	`getQueuePriority()` Gets the value of the queuePriority property.
`RequestType`	`getRequestType()` Gets the value of the requestType property.
`Options.SaveOptions`	`getSaveOptions()` Gets the value of the saveOptions property.
`Date`	`getScheduledTime()` Gets the value of the scheduledTime property.
`List<AsyncResponse>`	`getSendResponseTo()` Gets the value of the sendResponseTo property.
`Integer`	`getSequenceCode()` Gets the value of the sequenceCode property.
`void`	`setCallsInConversation(Integer value)` Sets the value of the callsInConversation property.
`void`	`setClient(ClientID value)` Sets the value of the client property.
`void`	`setConversationID(String value)` Sets the value of the conversationID property.
`void`	`setPriority(Byte value)` Sets the value of the priority property.
`void`	`setQueuePriority(Priority value)` Sets the value of the queuePriority property.
`void`	`setRequestType(RequestType value)` Sets the value of the requestType property.
`void`	`setSaveOptions(Options.SaveOptions value)` Sets the value of the saveOptions property.
`void`	`setScheduledTime(Date value)` Sets the value of the scheduledTime property.
`void`	`setSequenceCode(Integer value)` Sets the value of the sequenceCode property.
`String`	`toString()` Generates a String representation of the contents of this type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - client
```
protected ClientID client
```
  - sendResponseTo
```
protected List<AsyncResponse> sendResponseTo
```
  - saveOptions
```
protected Options.SaveOptions saveOptions
```
  - priority
```
protected Byte priority
```
  - conversationID
```
protected String conversationID
```
  - sequenceCode
```
protected Integer sequenceCode
```
  - callsInConversation
```
protected Integer callsInConversation
```
  - scheduledTime
```
protected Date scheduledTime
```
  - requestType
```
protected RequestType requestType
```
  - queuePriority
```
protected Priority queuePriority
```
- Constructor Detail
  - Options
```
public Options()
```
- Method Detail
  - getClient
```
public ClientID getClient()
```
    Gets the value of the client property.
    
    Returns:
    
    possible object is ClientID
  - setClient
```
public void setClient(ClientID value)
```
    Sets the value of the client property.
    
    Parameters:
    
    value - allowed object is ClientID
  - getSendResponseTo
```
public List<AsyncResponse> getSendResponseTo()
```
    Gets the value of the sendResponseTo property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the sendResponseTo property.
    For example, to add a new item, do as follows:
```
    getSendResponseTo().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AsyncResponse
  - getSaveOptions
```
public Options.SaveOptions getSaveOptions()
```
    Gets the value of the saveOptions property.
    
    Returns:
    
    possible object is Options.SaveOptions
  - setSaveOptions
```
public void setSaveOptions(Options.SaveOptions value)
```
    Sets the value of the saveOptions property.
    
    Parameters:
    
    value - allowed object is Options.SaveOptions
  - getPriority
```
public Byte getPriority()
```
    Gets the value of the priority property.
    
    Returns:
    
    possible object is Byte
  - setPriority
```
public void setPriority(Byte value)
```
    Sets the value of the priority property.
    
    Parameters:
    
    value - allowed object is Byte
  - getConversationID
```
public String getConversationID()
```
    Gets the value of the conversationID property.
    
    Returns:
    
    possible object is String
  - setConversationID
```
public void setConversationID(String value)
```
    Sets the value of the conversationID property.
    
    Parameters:
    
    value - allowed object is String
  - getSequenceCode
```
public Integer getSequenceCode()
```
    Gets the value of the sequenceCode property.
    
    Returns:
    
    possible object is Integer
  - setSequenceCode
```
public void setSequenceCode(Integer value)
```
    Sets the value of the sequenceCode property.
    
    Parameters:
    
    value - allowed object is Integer
  - getCallsInConversation
```
public Integer getCallsInConversation()
```
    Gets the value of the callsInConversation property.
    
    Returns:
    
    possible object is Integer
  - setCallsInConversation
```
public void setCallsInConversation(Integer value)
```
    Sets the value of the callsInConversation property.
    
    Parameters:
    
    value - allowed object is Integer
  - getScheduledTime
```
public Date getScheduledTime()
```
    Gets the value of the scheduledTime property.
    
    Returns:
    
    possible object is String
  - setScheduledTime
```
public void setScheduledTime(Date value)
```
    Sets the value of the scheduledTime property.
    
    Parameters:
    
    value - allowed object is String
  - getRequestType
```
public RequestType getRequestType()
```
    Gets the value of the requestType property.
    
    Returns:
    
    possible object is RequestType
  - setRequestType
```
public void setRequestType(RequestType value)
```
    Sets the value of the requestType property.
    
    Parameters:
    
    value - allowed object is RequestType
  - getQueuePriority
```
public Priority getQueuePriority()
```
    Gets the value of the queuePriority property.
    
    Returns:
    
    possible object is Priority
  - setQueuePriority
```
public void setQueuePriority(Priority value)
```
    Sets the value of the queuePriority property.
    
    Parameters:
    
    value - allowed object is Priority
  - toString
```
public String toString()
```
    Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin
    
    Overrides:
    
    toString in class Object

Class Options

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

sendResponseTo

saveOptions

priority

conversationID

sequenceCode

callsInConversation

scheduledTime

requestType

queuePriority

Constructor Detail

Options

Method Detail

getClient

setClient

getSendResponseTo

getSaveOptions

setSaveOptions

getPriority

setPriority

getConversationID

setConversationID

getSequenceCode

setSequenceCode

getCallsInConversation

setCallsInConversation

getScheduledTime

setScheduledTime

getRequestType

setRequestType

getQueuePriority

setQueuePriority

toString