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:

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
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	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

addDeviceGroup, addDeviceGroup, addDeviceGroup, createPresets, createPresets, deletePresets, deletePresets, getAdminURL, getAllPresets, getAreaId, getCategory, getCost, getCustomizationPageURL, getDescription, getDeviceGroupAssociations, getGroups, getParent, getPresets, getPresets, getPrimaryAudio, getPrimaryImage, getSecondaryAudio, getSecondaryImage, getSequenceNo, getServiceAccessPoints, getShortName, getTransformer, getURL, getURLPathParameter, getURLPathParameter, getUserOwner, getVirtualURL, invoke, isRedirectHelp, isSessionless, isValid, isViewCustomizable, isVisible, removeAllDeviceGroups, removeAllGroups, setAdminURL, setAreaId, setCategory, setCost, setCustomizationPageURL, setDescription, setGroups, setParent, setPrimaryAudio, setPrimaryImage, setRedirectHelp, setSecondaryAudio, setSecondaryImage, setSequenceNo, setShortName, setUserOwner, setValid, setViewCustomizable, setVirtualURL, setVisible

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

TYPEID

public static final int TYPEID

The type id of this class.

See Also:

Constant Field Values

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier

See Also:

Constant Field Values

Method Detail

addDeviceTransformer

public void addDeviceTransformer(Transformer transformer)

Add a customized transformer for a specific device

Parameters:

transformer - the Transformer

getAsyncArguments

public AsyncArguments getAsyncArguments()

Get async arguments

Returns:

AsyncArguments

getDeviceTransformers

public Transformer[] getDeviceTransformers()

Returns:

the customized transformers for this MasterService or null if none

getInitArguments

public Arguments getInitArguments()

Get init Arguments for the MasterService

Returns:

Aruments or null if none exists

getInputArguments

public Arguments getInputArguments()

Get input Arguments for the MasterService

Returns:

Aruments or null if none exists

getLanguage

public java.lang.String getLanguage()

Gets the Language property

Returns:

the language property value

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()

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()

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()

getModelAdapter

public Adapter getModelAdapter()

Returns:

the current Adapter for this master service

getOutputArguments

public OutputArguments getOutputArguments()

Get OutputArguments for the MasterService

Returns:

OutputArguments or null if none exists

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

getResultTransformersNames

public java.util.Enumeration getResultTransformersNames()

Returns:

Enumeration the list of all ResultTransformers names

getServiceHelpText

public java.lang.String getServiceHelpText()

Gets the Help text

Returns:

the help text

getTextResultTransformer

public java.lang.String getTextResultTransformer(java.lang.String section)

Parameters:

section - the PAsection

Returns:

String the ResultTransformer

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

isAsyncEnabled

public boolean isAsyncEnabled()

Is the master service async enabled?

Returns:

true if the master service is async enabled

isCacheable

public boolean isCacheable()

Gets the cacheable property (boolean) value.

isModulable

public boolean isModulable()

Gets the modulable property (boolean) value.

isSilent

public boolean isSilent()

isSupportsVariableAsyncArgs

public boolean isSupportsVariableAsyncArgs()

Does async service support variable arguments?

Returns:

true if the async service supports variable arguments

isUserSpecific

public boolean isUserSpecific()

Whether the content returned by Service user specific?

Returns:

true if the content returned by service is user specific

removeDeviceTransformer

public void removeDeviceTransformer(Transformer transformer)

Remove a customized transformer

Parameters:

transformer - the transformer

removeResultTransformer

public void removeResultTransformer(java.lang.String section)

Parameters:

section - the PAsection

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

setAsyncEnabled

public void setAsyncEnabled(boolean asyncEnabled)

Sets the asyncEnabled property value

Parameters:

asyncEnabled - the new property value

setCacheable

public void setCacheable(boolean cacheable)

Sets the cacheable property (boolean) value.

setInitArguments

public void setInitArguments(Arguments args)

Set init Arguments for the MasterService

Parameters:

args - the arguments

setInputArguments

public void setInputArguments(Arguments args)

Set input Arguments for the MasterService

Parameters:

args - the arguments

setLanguage

public void setLanguage(java.lang.String language)

Sets the Language property value

Parameters:

language - the new property value

setModulable

public void setModulable(boolean modulable)

Sets the modulable property (boolean) value.

setOutputArguments

public void setOutputArguments(OutputArguments outputArguments)

Set OutputArguments for the MasterService

Parameters:

outputArguments - the OutputArguments

setParameterDelimiter

public void setParameterDelimiter(java.lang.String parameterDelimiter)

Sets the parameter delimiter property value

Parameters:

parameterDelimiter - the new property value

setServiceHelpText

public void setServiceHelpText(java.lang.String serviceHelpText)

Sets the Help text

Parameters:

serviceHelpText - the new value of service help text

setSessionless

public void setSessionless(boolean sessionless)

Sets sessionless property value

Parameters:

sessionless - the new property value

setSilent

public void setSilent(boolean silent)

setSupportsVariableAsyncArgs

public void setSupportsVariableAsyncArgs(boolean supportsVariableAsyncArgs)

Sets the value of supportsVariableAsyncArgs property value

Parameters:

supportsVariableAsyncArgs - the new property value

setTextResultTransformer

public void setTextResultTransformer(java.lang.String section,
                                     java.lang.String transformer)

Parameters:

section - the PAsection

transformer - the ResultTransformer

setUserSpecific

public void setUserSpecific(boolean userSpecific)

Sets the userSpecifc property (boolean) value.

Parameters:

userSpecific - the user specific property value

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