oracle.panama.model
Interface Module

All Superinterfaces:

ModelObject, Service, XMLObject

All Known Subinterfaces:

LocalModule

public interface Module

extends Service

A Module is a pointer to a "modulable" service with well known name called "virtual" URL. The modules could be local or remote.

See Also:

LocalModule

Field Summary

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

Type	Method
java.lang.String	getAdminURL() Gets the URL to the admin page for this module.
java.lang.String	getAsyncAddress(DeliveryType deliveryType) Gets the async address (like news@oraclemobile.com) for a delivery type
AsyncArguments	getAsyncArguments() Get async arguments
java.lang.String	getAsyncName() Gets the asyncName property value.
Arguments	getInputArguments() Get arguments for the Service
java.lang.String	getLanguage() Gets the Language property
Arguments	getMergedInputArguments() Get merged arguments from all associated services in the alias link list
OutputArguments	getMergedOutputArguments() Get merged arguments from all associated services in the alias link list
OutputArguments	getOutputArguments() Get OutputArguments for the Alias
java.lang.String	getParameterDelimiter() Gets the parameter delimiter property value.
java.lang.String	getServiceHelpText() Gets the Help text.
java.lang.String	getVirtualURL() Gets the virtual URL for this module.
boolean	isAsyncEnabled() Is the module async enabled?.
void	setAdminURL(java.lang.String url) Sets the URL to the admin page for this module.
void	setAsyncAddress(DeliveryType deliveryType, java.lang.String address) Sets the async address for a delivery type
void	setAsyncArguments(AsyncArguments asyncArgs) Set async arguments.
void	setAsyncName(java.lang.String asyncName) Sets the asyncName property value
void	setInputArguments(Arguments args) Set arguments for the Service
void	setLanguage(java.lang.String language) Sets the Language property value
void	setOutputArguments(OutputArguments outputArguments) Set OutputArguments for the Alias
void	setParameterDelimiter(java.lang.String parameterDelimiter) Sets the parameter delimiter property value
void	setServiceHelpText(java.lang.String serviceHelpText) Sets the Help text
void	setVirtualURL(java.lang.String url) Sets the virtual URL for this module.

Methods inherited from interface oracle.panama.model.Service

getAreaId, getCategory, getCost, getDescription, getGroups, getParent, getPrimaryAudio, getPrimaryImage, getSecondaryAudio, getSecondaryImage, getSequenceNo, getShortName, getTransformer, getURL, getURLPathParameter, getUserOwner, invoke, isValid, isViewCustomizable, isVisible, removeAllGroups, setAreaId, setCategory, setCost, setDescription, setGroups, setParent, setPrimaryAudio, setPrimaryImage, setSecondaryAudio, setSecondaryImage, setSequenceNo, setShortName, setUserOwner, setValid, setViewCustomizable, 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

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier

TYPEID

public static final int TYPEID

The type id of this class.

Method Detail

getVirtualURL

public java.lang.String getVirtualURL()

Gets the virtual URL for this module.

Returns:

String the virtual URL for this module.

setVirtualURL

public void setVirtualURL(java.lang.String url)

Sets the virtual URL for this module.

Parameters:

url - the virtual URL for this module.

getAdminURL

public java.lang.String getAdminURL()

Gets the URL to the admin page for this module.

Returns:

String the URL to the admin page for this module.

setAdminURL

public void setAdminURL(java.lang.String url)

Sets the URL to the admin page for this module.

Parameters:

url - the URL to the admin page for this module.

getInputArguments

public Arguments getInputArguments()

Get arguments for the Service

Returns:

Element with arguments or null if none exists

setInputArguments

public void setInputArguments(Arguments args)

Set arguments for the Service

Parameters:

arg - the arguments

getMergedInputArguments

public Arguments getMergedInputArguments()

Get merged arguments from all associated services in the alias link list

Returns:

merged Arguments

getOutputArguments

public OutputArguments getOutputArguments()

Get OutputArguments for the Alias

Returns:

OutputArguments or null if none exists

setOutputArguments

public void setOutputArguments(OutputArguments outputArguments)

Set OutputArguments for the Alias

Parameters:

arg - the OutputArguments

getMergedOutputArguments

public OutputArguments getMergedOutputArguments()

Get merged arguments from all associated services in the alias link list

Returns:

merged Arguments

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

isAsyncEnabled

public boolean isAsyncEnabled()

Is the module async enabled?. The module inherits this property from the master service in the service chain .

Returns:

true if the master service is async enabled

getAsyncName

public java.lang.String getAsyncName()

Gets the asyncName property value. The aysncName of the Link is used by Async agent to identify the service.

Returns:

the async name

setAsyncName

public void setAsyncName(java.lang.String asyncName)

Sets the asyncName property value

Parameters:

asyncName - the new value of the property

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

Parameters:

serviceHelp - the new value of service help text

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

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

getAsyncAddress

public java.lang.String getAsyncAddress(DeliveryType 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

setAsyncAddress

public void setAsyncAddress(DeliveryType deliveryType,
                            java.lang.String address)

Sets the async address for a delivery type

Parameters:

deliveryType - the delivery type

address - the address