Overview  Package   Class  Tree  Deprecated  Index  Help 
 Oracle Application Server Wireless Java API Reference
B10400-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.panama.model
Interface MasterService

All Superinterfaces:
ModelObject, Service, XMLObject
All Known Subinterfaces:
DeliveryService
public interface MasterService
extends Service

The MasterService is the "final" Service, and the template for all other Services. It always uses an Adapter to communicate with the external source.

See Also:
oracle.panama.rt.RuntimeAdapter, Adapter

Field Summary
static int TYPEID
          The type id of this class.
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

 

Method Summary
 void addDeviceTransformer(Transformer transformer)
          Add a customized transformer for a specific device
 AsyncArguments getAsyncArguments()
          Get async arguments
 Transformer[] getDeviceTransformers()
           
 Arguments getInitArguments()
          Get init Arguments for the MasterService
 Arguments getInputArguments()
          Get input Arguments for the MasterService
 InvalidationFrequency getInvalidationFrequency()
           
 java.lang.String getLanguage()
          Gets the Language property
 Arguments getMergedInitArguments()
          Get init Arguments for the MasterService that have been merged with the ones from the RuntimeAdapter
 Arguments getMergedInputArguments()
          Get input Arguments for the MasterService that have been merged with the ones from the RuntimeAdapter
 OutputArguments getMergedOutputArguments()
          Get OutputArguments for the MasterService that have been merged with the ones from the RuntimeAdapter
 Adapter getModelAdapter()
           
 OutputArguments getOutputArguments()
          Get OutputArguments for the MasterService
 java.lang.String getParameterDelimiter()
          Gets the parameter delimiter property value.
 java.util.Enumeration getResultTransformersNames()
           
 java.lang.String getServiceHelpText()
          Gets the Help text
 java.lang.String getTextResultTransformer(java.lang.String section)
           
 org.w3c.dom.Element getXMLResultTransformer(java.lang.String section)
           
 boolean isAsyncEnabled()
          Is the master service async enabled?
 boolean isCacheable()
          Gets the cacheable property (boolean) value.
 boolean isModulable()
          Gets the modulable property (boolean) value.
 boolean isSilent()
           
 boolean isSupportsVariableAsyncArgs()
          Does async service support variable arguments?
 boolean isUserSpecific()
          Whether the content returned by Service user specific?
 void removeDeviceTransformer(Transformer transformer)
          Remove a customized transformer
 void removeResultTransformer(java.lang.String section)
           
 void setAsyncArguments(AsyncArguments asyncArgs)
          Set async arguments.
 void setAsyncEnabled(boolean asyncEnabled)
          Sets the asyncEnabled property value
 void setCacheable(boolean cacheable)
          Sets the cacheable property (boolean) value.
 void setInitArguments(Arguments args)
          Set init Arguments for the MasterService
 void setInputArguments(Arguments args)
          Set input Arguments for the MasterService
 void setInvalidationFrequency(InvalidationFrequency value)
           
 void setLanguage(java.lang.String language)
          Sets the Language property value
 void setModulable(boolean modulable)
          Sets the modulable property (boolean) value.
 void setOutputArguments(OutputArguments outputArguments)
          Set OutputArguments for the MasterService
 void setParameterDelimiter(java.lang.String parameterDelimiter)
          Sets the parameter delimiter property value
 void setServiceHelpText(java.lang.String serviceHelpText)
          Sets the Help text
 void setSessionless(boolean sessionless)
          Sets sessionless property value
 void setSilent(boolean silent)
           
 void setSupportsVariableAsyncArgs(boolean supportsVariableAsyncArgs)
          Sets the value of supportsVariableAsyncArgs property value
 void setTextResultTransformer(java.lang.String section, java.lang.String transformer)
           
 void setUserSpecific(boolean userSpecific)
          Sets the userSpecifc property (boolean) value.
 void setXMLResultTransformer(java.lang.String section, org.w3c.dom.Element transformer)
           

 

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

TYPEID

public static final int TYPEID
The type id of this class.
See Also:
Constant Field Values
Method Detail

getLanguage

public java.lang.String getLanguage()
Gets the Language property
Returns:
the language property value

setLanguage

public void setLanguage(java.lang.String language)
Sets the Language property value
Parameters:
language - the new property value

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

isAsyncEnabled

public boolean isAsyncEnabled()
Is the master service async enabled?
Returns:
true if the master service is async enabled

setAsyncEnabled

public void setAsyncEnabled(boolean asyncEnabled)
Sets the asyncEnabled property value
Parameters:
asyncEnabled - the new property value

getModelAdapter

public Adapter getModelAdapter()
Returns:
the current Adapter for this master service

getInitArguments

public Arguments getInitArguments()
Get init Arguments for the MasterService
Returns:
Aruments or null if none exists

getMergedInitArguments

public Arguments getMergedInitArguments()
Get init Arguments for the MasterService that have been merged with the ones from the RuntimeAdapter
Returns:
Aruments or null if none exists
See Also:
RuntimeAdapter.getInitArguments()

setInitArguments

public void setInitArguments(Arguments args)
Set init Arguments for the MasterService

getInputArguments

public Arguments getInputArguments()
Get input Arguments for the MasterService
Returns:
Aruments or null if none exists

getMergedInputArguments

public Arguments getMergedInputArguments()
Get input Arguments for the MasterService that have been merged with the ones from the RuntimeAdapter
Returns:
Aruments or null if none exists
See Also:
RuntimeAdapter.getInputArguments()

setInputArguments

public void setInputArguments(Arguments args)
Set input Arguments for the MasterService

getOutputArguments

public OutputArguments getOutputArguments()
Get OutputArguments for the MasterService
Returns:
OutputArguments or null if none exists

getMergedOutputArguments

public OutputArguments getMergedOutputArguments()
Get OutputArguments for the MasterService that have been merged with the ones from the RuntimeAdapter
Returns:
Aruments or null if none exists
See Also:
RuntimeAdapter.getOutputArguments()

setOutputArguments

public void setOutputArguments(OutputArguments outputArguments)
Set OutputArguments for the MasterService

getDeviceTransformers

public Transformer[] getDeviceTransformers()
Returns:
the customized transformers for this MasterService or null if none

addDeviceTransformer

public void addDeviceTransformer(Transformer transformer)
Add a customized transformer for a specific device
Parameters:
transformer - the Transformer

removeDeviceTransformer

public void removeDeviceTransformer(Transformer transformer)
Remove a customized transformer
Parameters:
transformer - the transformer

getResultTransformersNames

public java.util.Enumeration getResultTransformersNames()
Returns:
Enumeration the list of all ResultTransformers names

getXMLResultTransformer

public org.w3c.dom.Element getXMLResultTransformer(java.lang.String section)
Parameters:
section - the PAsection
Returns:
org.w3c.dom.Element the ResultTransformer as a XML DOM Element

setXMLResultTransformer

public void setXMLResultTransformer(java.lang.String section,
                                    org.w3c.dom.Element transformer)
Parameters:
section - the PAsection
transformer - the ResultTransformer as a XML DOM Element

getTextResultTransformer

public java.lang.String getTextResultTransformer(java.lang.String section)
Parameters:
section - the PAsection
Returns:
String the ResultTransformer

setTextResultTransformer

public void setTextResultTransformer(java.lang.String section,
                                     java.lang.String transformer)
Parameters:
section - the PAsection
transformer - the ResultTransformer

removeResultTransformer

public void removeResultTransformer(java.lang.String section)
Parameters:
section - the PAsection

isCacheable

public boolean isCacheable()
Gets the cacheable property (boolean) value.

setCacheable

public void setCacheable(boolean cacheable)
Sets the cacheable property (boolean) value.

getInvalidationFrequency

public InvalidationFrequency getInvalidationFrequency()
Returns:
InvalidationFrequency the cache invalidation frequency

setInvalidationFrequency

public void setInvalidationFrequency(InvalidationFrequency value)
Parameters:
value - InvalidationFrequency the cache invalidation frequency

getAsyncArguments

public AsyncArguments getAsyncArguments()
Get async arguments
Returns:
AsyncArguments

setAsyncArguments

public void setAsyncArguments(AsyncArguments asyncArgs)
Set async arguments. This method is used to set value or change position of the async attributes defined in the Master Service.
Parameters:
asyncArgs - the async arguments

isModulable

public boolean isModulable()
Gets the modulable property (boolean) value.

setModulable

public void setModulable(boolean modulable)
Sets the modulable property (boolean) value.

isUserSpecific

public boolean isUserSpecific()
Whether the content returned by Service user specific?
Returns:
true if the content returned by service is user specific

setUserSpecific

public void setUserSpecific(boolean userSpecific)
Sets the userSpecifc property (boolean) value.
Parameters:
userSpecific - the user specific property value

isSupportsVariableAsyncArgs

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

setSupportsVariableAsyncArgs

public void setSupportsVariableAsyncArgs(boolean supportsVariableAsyncArgs)
Sets the value of supportsVariableAsyncArgs property value
Parameters:
supportsVariableAsyncArgs - the new property value

isSilent

public boolean isSilent()

setSilent

public void setSilent(boolean silent)

setSessionless

public void setSessionless(boolean sessionless)
Sets sessionless property value
Parameters:
sessionless - the new property value
Overview  Package   Class  Tree  Deprecated  Index  Help 
 Oracle Application Server Wireless Java API Reference
B10400-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2003 Oracle Corporation. All Rights Reserved.