Oracle Application Server Wireless Java API Reference
B10400-01

oracle.panama.model
Interface AsyncService

All Superinterfaces:
ModelObject, Service, XMLObject
All Known Subinterfaces:
Alert, Link, LocalModule, Module

public interface AsyncService
extends Service

The AsyncService is an "abstract" interface and handles all generic aspects of an async service.


Field Summary
static java.lang.String TYPENAME
          The constant class type identifier

 

Fields inherited from interface oracle.panama.model.Service
CATEGORY_MASTER, CATEGORY_SERVICE, CATEGORY_USER_HOME, TYPEID

 

Method Summary
 void addAsyncAddress(DeliveryType deliveryType, java.lang.String address)
          Adds async address for a delivery type
 void addAsyncName(java.lang.String asyncName)
          Adds an async name for the service
 java.lang.String getAsyncAddress(DeliveryType deliveryType)
          Deprecated. Replaced by getAsyncAddresses(DeliveryType) Gets the async address (like news@oraclemobile.com) for a delivery type
 java.lang.String[] getAsyncAddresses(DeliveryType deliveryType)
          Gets the async addresses (like news@oraclemobile.com) for a delivery type
 AsyncArguments getAsyncArguments()
          Gets async arguments
 java.lang.String getAsyncName()
          Deprecated. Replaced by getAsyncNames() Gets the asyncName property value. The aysncName of the Link is used by Async agent to identify the service.
 java.lang.String[] getAsyncNames()
          Gets the list of asyncNames.
 java.lang.String getParameterDelimiter()
          Gets the parameter delimiter property value.
 java.lang.String getServiceHelpText()
          Gets the Help text.
 boolean isAsyncEnabled()
          Is the alias async enabled?.
 boolean isSilent()
           
 boolean isSupportsVariableAsyncArgs()
          Does async service support variable arguments?
 void removeAsyncAddress(DeliveryType deliveryType, java.lang.String address)
          Removes an async address for a delivery type
 void removeAsyncName(java.lang.String asyncName)
          Removes an async name
 void setAsyncAddress(DeliveryType deliveryType, java.lang.String address)
          Deprecated. Replaced by setAsyncAddresses(DeliveryType, String[]) Sets the async address for a delivery type
 void setAsyncAddresses(DeliveryType deliveryType, java.lang.String[] addresses)
          Sets the async addresses for a delivery type
 void setAsyncArguments(AsyncArguments asyncArgs)
          Set async arguments.
 void setAsyncName(java.lang.String asyncName)
          Deprecated. Replaced by setAsyncNames(String[] ) Sets the asyncName property value
 void setAsyncNames(java.lang.String[] asyncNames)
          Sets the asyncNames property value
 void setParameterDelimiter(java.lang.String parameterDelimiter)
          Sets the parameter delimiter property value
 void setServiceHelpText(java.lang.String serviceHelpText)
          Sets the Help text

 

Methods inherited from interface oracle.panama.model.Service
createPresets, createPresets, deletePresets, deletePresets, getAdminURL, getAllPresets, getAreaId, getCategory, getCost, getCustomizationPageURL, getDescription, getGroups, getParent, getPresets, getPresets, getPrimaryAudio, getPrimaryImage, getSecondaryAudio, getSecondaryImage, getSequenceNo, getServiceAccessPoints, getServiceCategories, getShortName, getTransformer, getURL, getURLPathParameter, getURLPathParameter, getUserOwner, getVirtualURL, invoke, isRedirectHelp, isSessionless, isValid, isViewCustomizable, isVisible, removeAllGroups, setAdminURL, setAreaId, setCategory, setCost  

Methods inherited from interface oracle.panama.model.ModelObject
delete, getCreatedDate, getId, getLastModifiedDate, getName, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

 

Methods inherited from interface oracle.panama.model.XMLObject
setXML, toXML

 

Field Detail

TYPENAME

public static final java.lang.String TYPENAME
The constant class type identifier
See Also:
Constant Field Values
Method Detail

getAsyncName

public java.lang.String getAsyncName()
Deprecated. Replaced by getAsyncNames() Gets the asyncName property value. The aysncName of the Link is used by Async agent to identify the service.
Returns:
the async name

getAsyncNames

public java.lang.String[] getAsyncNames()
Gets the list of asyncNames. The aysncName of the Link is used by Async agent to identify the service.
Returns:
array of async names

setAsyncName

public void setAsyncName(java.lang.String asyncName)
Deprecated. Replaced by setAsyncNames(String[] ) Sets the asyncName property value
Parameters:
asyncName - the new value of the property

setAsyncNames

public void setAsyncNames(java.lang.String[] asyncNames)
Sets the asyncNames property value
Parameters:
asyncNames - array of async names

addAsyncName

public void addAsyncName(java.lang.String asyncName)
Adds an async name for the service
Parameters:
asyncName - the async name

removeAsyncName

public void removeAsyncName(java.lang.String asyncName)
Removes an async name
Parameters:
asyncName - the async name

getParameterDelimiter

public java.lang.String getParameterDelimiter()
Gets the parameter delimiter property value. The parameter delimiter specifies a string (of max size 2), which can be used as delimiter when the service parameters are passed in command line.
Returns:
the value of parameter delimiter

setParameterDelimiter

public void setParameterDelimiter(java.lang.String parameterDelimiter)
Sets the parameter delimiter property value
Parameters:
parameterDelimiter - the new property value

getServiceHelpText

public java.lang.String getServiceHelpText()
Gets the Help text.
Returns:
the help text

setServiceHelpText

public void setServiceHelpText(java.lang.String serviceHelpText)
Sets the Help text

isSupportsVariableAsyncArgs

public boolean isSupportsVariableAsyncArgs()
Does async service support variable arguments?
Returns:
true if the async service supports variable arguments

isAsyncEnabled

public boolean isAsyncEnabled()
Is the alias async enabled?. The Link inherits this property from the final service in the service chain .
Returns:
true if the final master service is async enabled

getAsyncAddress

public java.lang.String getAsyncAddress(DeliveryType deliveryType)
Deprecated. Replaced by getAsyncAddresses(DeliveryType) Gets the async address (like news@oraclemobile.com) for a delivery type
Parameters:
deliveryType - the delivery type(like sms, e-mail)
Returns:
the async address

getAsyncAddresses

public java.lang.String[] getAsyncAddresses(DeliveryType deliveryType)
Gets the async addresses (like news@oraclemobile.com) for a delivery type
Parameters:
deliveryType - the delivery type(like sms, e-mail)
Returns:
the async address

setAsyncAddress

public void setAsyncAddress(DeliveryType deliveryType,
                            java.lang.String address)
Deprecated. Replaced by setAsyncAddresses(DeliveryType, String[]) Sets the async address for a delivery type
Parameters:
deliveryType - the delivery type
address - the address

setAsyncAddresses

public void setAsyncAddresses(DeliveryType deliveryType,
                              java.lang.String[] addresses)
Sets the async addresses for a delivery type
Parameters:
deliveryType - the delivery type
addresses - array of address

addAsyncAddress

public void addAsyncAddress(DeliveryType deliveryType,
                            java.lang.String address)
Adds async address for a delivery type
Parameters:
deliveryType - the delivery type

removeAsyncAddress

public void removeAsyncAddress(DeliveryType deliveryType,
                               java.lang.String address)
Removes an async address for a delivery type
Parameters:
deliveryType - the delivery type

getAsyncArguments

public AsyncArguments getAsyncArguments()
Gets async arguments
Returns:
AsyncArguments

setAsyncArguments

public void setAsyncArguments(AsyncArguments asyncArgs)
Set async arguments. This method is used to set
Parameters:
asyncArgs - the async arguments.

isSilent

public boolean isSilent()

Oracle Application Server Wireless Java API Reference
B10400-01

Copyright © 2003 Oracle Corporation. All Rights Reserved.