com.sage.swt.client.sdata
Interface SDataInfo

All Known Implementing Classes:

DefaultSDataInfo, DefaultServiceSDataInfo

public interface SDataInfo

Interface for an SDATA information object associated with an SDATA resource or service operation.

Method Summary

java.lang.String	getConnectionID()
java.lang.String	getDataSet(java.lang.String application) Returns the dataset name that will be used in the SDATA URL (for example, "SAMINC").
java.lang.String	getSchemaURL(ConnectionInfo conInfo) Returns the SDATA URL (minus the http portion) that can be used for issuing SDATA schema requests.
com.google.gwt.xml.client.Element	getSDataInfoElement(com.google.gwt.xml.client.Document doc) Returns an XML DOM element that represents the information stored in this object - and can be used to store the information declaratively.
java.lang.String	getSDataURL(ConnectionInfo conInfo) Returns the SDATA URL (minus the http portion) that can be used for issuing SDATA requests.

Method Detail

getSDataURL

java.lang.String getSDataURL(ConnectionInfo conInfo)

Returns the SDATA URL (minus the http portion) that can be used for issuing SDATA requests.

Returns:

the SDATA URL (minus the http portion) that can be used for issuing SDATA requests.

Throws:

java.lang.IllegalArgumentException

getSchemaURL

java.lang.String getSchemaURL(ConnectionInfo conInfo)

Returns the SDATA URL (minus the http portion) that can be used for issuing SDATA schema requests.

Returns:

the SDATA URL (minus the http portion) that can be used for issuing SDATA schema requests.

Throws:

java.lang.IllegalArgumentException

getDataSet

java.lang.String getDataSet(java.lang.String application)

Returns the dataset name that will be used in the SDATA URL (for example, "SAMINC"). If this isn't specified, the parent's SDataInfo information will be returned. If no datasets are specified anywhere in the chain of ancestors, a "-" will be returned (which represents the default dataset of the application).

Returns:

The dataset name that will be used in the SDATA URL (for example, "SAMINC"). If this isn't specified, the parent's SDataInfo information will be returned. If no datasets are specified anywhere in the chain of ancestors, a "-" will be returned (which represents the default dataset of the application).

getSDataInfoElement

com.google.gwt.xml.client.Element getSDataInfoElement(com.google.gwt.xml.client.Document doc)

Returns an XML DOM element that represents the information stored in this object - and can be used to store the information declaratively. If the object is empty, then this should return null.

Parameters:

doc - An Document

Returns:

An Element if an element was created; otherwise null (which means that there is no information in this object to store in the XML).

getConnectionID

java.lang.String getConnectionID()