ISDMODataLink interface

Deprecated. since 3.0, Use IODataLink Represents the appropriate SDMOData element.

Syntax

public abstract interface ISDMODataLink extends ISDMParserDocument

Derived classes

Members

All members of ISDMODataLink, including inherited members.

Variables
Modifier and Type Variable Description
public static final String ATTRIBUTE_HREF Name of the appropriate SDMOData attribute.
public static final String ATTRIBUTE_REL Name of the appropriate SDMOData attribute.
public static final String ATTRIBUTE_REL_VALUE_EDIT Value option for the appropriate SDMOData parameter.
public static final String ATTRIBUTE_REL_VALUE_SELF Value option for the appropriate SDMOData parameter.
public static final String ATTRIBUTE_SEMANTICS Name of the appropriate SDMOData attribute.
public static final String ATTRIBUTE_TITLE Name of the appropriate SDMOData attribute.
public static final String ATTRIBUTE_VALUEPART_RELATED String that should be part of every rel attribute of a Related Data Link.
public static final String ATTRIBUTE_VALUESUFFIX_SUBSCRIPTION String that should be end of every rel attribute of a Subscription Link.
public static final String ELEMENT_INLINE Name of the appropriate SDMOData element.
public static final String ELEMENT_LINK Name of the appropriate SDMOData element.
public static final String ELEMENT_PARAMETER Name of the appropriate SDMOData element.
public static final String ELEMENT_PARAMETERSET Name of the appropriate SDMOData element.
Methods
Modifier and Type Method Description
public abstract String getHref() Returns the value of the appropriate SDMOData attribute.
public abstract List< ISDMODataEntry > getInlineEntries() Returns the list of SDMOData Entries contained by the appropriate SDMOData 'inline' element.
public abstract List< String > getInputParameterNames() Returns the list of the appropriate SDMOData Parameter elements that should be used as input parameter.
public abstract List< String > getOutputParameterNames() Returns the list of the appropriate SDMOData Parameter elements that should be used as output parameter.
public abstract List< ISDMODataParameter > getParameters() Returns the list of the appropriate SDMOData Parameter elements.
public abstract String getRel() Returns the value of the appropriate SDMOData attribute.
public abstract ISDMODataSchema getSchema() Returns the Schema that is to be used for 'Inline entries'.
public abstract String getSemantics() Returns The value of the appropriate SDMOData extension (vCard) attribute.
public abstract String getTargetCollectionId() Returns the Id of the collection that this link points to (if any)
public abstract String getTitle() Returns the value of the appropriate SDMOData attribute.
public abstract String getUrl() Returns the full URL for this SDMOData Link object without parameters.
public abstract String getUrlWithParameters(Map< String, String >) Returns the full URL for this SDMOData Link object extended with the given parameter names and values.
public abstract void setSchema(ISDMODataSchema) Sets the Schema that is to be used for 'Inline entries'.
public abstract void setTargetCollectionId(String) Maintains the Id of the collection that this link points to (if any)
Inherited members from ISDMParserDocument
Modifier and Type Member Description
public static final String ATTRIBUTE_ETAG Name of the appropriate SDMOData element.
public static final String ATTRIBUTE_VALUEPREFIX_EDMTYPE Value prefix for EDM Type type values.
public abstract ISDMParserDocument clone() Creates a copy of this object.
public static Map< String, String > DEFAULT_PREFIXMAPPING The default XML Namespace-to-Prefix mapping used for building XMLS.
public static final String[] EDMDATETIME_PATTERNS Possible EDM DateTime patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String[] EDMDATETIMEOFFSET_PATTERNS Possible EDM TimeOffset patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String EDMTIME_PATTERN EDM Time pattern.
public static String ELEMENT_FEED Name of the appropriate SDMOData element.
public static final String ELEMENT_ID Name of the appropriate SDMOData element.
public abstract String getAttribute(String...) Returns the value of the first attribute with the given route.
public abstract List< String > getAttributes(String...) Returns all the values of attributes with the given route.
public abstract Map< String, String > getChildAttributeMap(String...) Returns all the name-value pairs of attributes contained by the element with the given route.
public abstract List< String > getChildAttributes(String...) Returns all the values of attributes contained by the element with the given route.
public abstract List< ISDMParserDocument > getChildDocuments(String...) Returns the elements contained by the element with the given route.
public abstract List< ISDMParserDocument > getChildDocumentsWithAttribute(String, String, String...) Returns the elements contained by the element with the given route and having the given attribute with the given value.
public abstract List< ISDMParserDocument > getChildDocumentsWithAttribute(String, String, boolean, String...) Returns the elements contained by the element with the given route and having the given attribute with the given value.
public abstract ISDMParserDocument getDocument(String...) Returns the first element with the given route.
public abstract List< ISDMParserDocument > getDocuments(String...) Returns all the elements with the given route.
public abstract List< ISDMParserDocument > getDocumentsWithAttribute(String, String, String...) Returns the elements with the given route that contains the given attribute with the given value.
public abstract List< ISDMParserDocument > getDocumentsWithAttribute(String, String, boolean, String...) Returns the elements with the given route that contains the given attribute with the given value.
public abstract ISDMParserDocument getDocumentWithAttribute(String, String, String...) Returns the first element with the given route that contains the given attribute with the given value.
public abstract ISDMParserDocument getDocumentWithAttribute(String, String, boolean, String...) Returns the first element with the given route that contains the given attribute with the given value.
public abstract String getElementName() Returns The name of the root element of this document.
public abstract String getFunctionImportComplexPropertyValue(String...)  
public abstract String getPrefixForUri(String) Returns the appropriate name-space prefix for the given XML name-space URI.
public abstract String[] getStrings() Returns all the string values contained by this document.
public abstract String getValue(String...) Returns the value of the first element with the given route.
public abstract List< String > getValues(String...) Returns all the values of elements with the given route.
public abstract void putAttribute(String, String...) Sets the value of the attribute with the given route If attribute does not exist it will be created as well as all other non existing elements in the route.
public abstract void putDocument(ISDMParserDocument, String...) Insert the document under the element with the given route inserted document will be placed before already existing documents with the same route name under All missing elements from the route will be created.
public abstract void putValue(String, String...) Sets the value of the first element with the given route.
public abstract boolean removeAttribute(String...) Removes first element with the given route.
public abstract boolean removeAttributes(String...) Removes all the attribute with the given route.
public abstract boolean removeDocument(String...) Removes first element with the given route For removing multiple element use setDocuemtns with null arguments.
public static final String ROOT_DOCUMENT_NAME The default root element name for a new document.
public abstract void setAttributes(List< String >, String...) Sets all the values of the attributes with the given route Values will be paired to attributes in order Attributes with greater or equals index than size of new values will be untouched Attributes paired with null values will be removed.
public abstract void setDocuments(List< ISDMParserDocument >, String...) Replaces all the elements with the given route Documents will be paired to elements in order Elements with greater or equals index than size of new elements will be untouched Element paired with null will be removed.
public abstract void setElementName(String, String...) Sets the name of the root element with the given route Use empty route for setting root name of this document.
public abstract void setValues(List< String >, String...) Sets all the values of the elements with the given rout Values will be paired to elements in order Elements with greater or equals index than size of new values will be untouched Null values will be treated as empty strings.
public abstract String toXMLString() Returns the XML string representation of this object.
public static final String XMLNS_APPLICATION_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_ATOM_URI Constant for XMLNS URI: http://www.w3.org/2005/Atom.
public static final String XMLNS_DATASERVICES_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_EDM_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/05/edm.
public static final String XMLNS_EDMX_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/06/edmx.
public static final String XMLNS_GENERICPLAYER_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData/GenericPlayer.
public static final String XMLNS_METADATA_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices/metadata.
public static final String XMLNS_SAP_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData.
Inherited members from ISDMPersistable
Modifier and Type Member Description
public void read(BufferedReader)  
public void write(BufferedWriter)