IODataProperty interface

Represents the appropriate OData element.

Package

com.sap.mobile.lib.parser

Syntax

public abstract interface IODataProperty extends IParserDocument

Implemented interfaces

Derived classes

Members

All members of IODataProperty, including inherited members.

Variables
Modifier and Type Variable Description
public static final String ELEMENT_PROPERTY Name of the appropriate OData element.
public static final String ATTRIBUTE_NAME Name of the appropriate OData attribute.
public static final String ATTRIBUTE_TYPE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_NULLABLE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_FIXEDLENGTH Name of the appropriate OData attribute.
public static final String ATTRIBUTE_LABEL Name of the appropriate OData attribute.
public static final String ATTRIBUTE_CREATABLE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_UPDATABLE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_DELETABLE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_SEARCHABLE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_FILTERABLE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_UNICODE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_DEFAULTVALUE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_PRECISION Name of the appropriate OData attribute.
public static final String ATTRIBUTE_SCALE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_COLLATION Name of the appropriate OData attribute.
public static final String ATTRIBUTE_MAXLENGTH Name of the appropriate OData attribute.
public static final String ATTRIBUTE_USEINSEARCH Name of the appropriate OData attribute.
public static final String ATTRIBUTE_VISIBLEINLIST Name of the appropriate OData attribute.
public static final String ATTRIBUTE_VISIBLEINDETAIL Name of the appropriate OData attribute.
public static final String ATTRIBUTE_SEMANTICS Name of the appropriate OData attribute.
public static final String ATTRIBUTE_LIST_DISPLAYORDER Name of the display-order OData attribute.
public static final String ATTRIBUTE_DETAIL_DISPLAYORDER Name of the display-order OData attribute.
Methods
Modifier and Type Method Description
public abstract List< IODataProperty > getChildPropertiesData() Returns all the child properties added to this document with putChildProperty method.
public abstract List< IODataProperty > getChildPropertiesDataWithAttribute(String, String) Returns list of appropriate contained Property OData elements with the given attribute value.
public abstract List< IODataProperty > getChildPropertiesDataWithAttribute(String, String, boolean) Returns list of appropriate contained Property OData elements with the given attribute value.
public abstract IODataProperty getChildPropertyData(String) Return a single child property added with putChildProperty method.
public abstract String getCollation() Returns the value of the appropriate OData attribute.
public abstract String getDefaultValue() Returns the value of the appropriate OData attribute.
public abstract int getDetailDisplayOrder() In current version it return the same value as getListDisplayOrder.
public abstract String getLabel() Returns The value of the appropriate OData attribute.
public abstract int getListDisplayOrder() In current version it returns the same value as getDetailDisplayOrder.
public abstract int getMaxLength() Returns the value of the appropriate OData attribute with defaultValue = 0;.
public abstract String getName() Returns The value of the appropriate OData attribute.
public abstract String getPrecision() Returns the value of the appropriate OData attribute.
public abstract String getScale() Returns the value of the appropriate OData attribute.
public abstract String getSemantics() Returns the value of the appropriate OData attribute with defaultValue = 0;.
public abstract String getType() Returns The value of the appropriate OData attribute.
public abstract String getValue() Returns the value of the property if there is a single property instance that is represented by this object and value is set with setValue method.
public abstract boolean hasFixedLength() Returns The value of the appropriate OData attribute.
public abstract boolean isComplex() Returns if the property has complex type and has child properties.
public abstract boolean isCreatable() Returns The value of the appropriate OData attribute.
public abstract boolean isDeletable() Returns The value of the appropriate OData attribute.
public abstract boolean isFilterable() Returns The value of the appropriate OData attribute.
public abstract boolean isNullable() Returns The value of the appropriate OData attribute.
public abstract boolean isSearchable() Returns The value of the appropriate OData attribute.
public abstract boolean isUnicode() Returns the value of the appropriate OData attribute.
public abstract boolean isUpdatable() Returns The value of the appropriate OData attribute.
public abstract void putChildPropertyData(IODataProperty) Put new child property to this property document.
public abstract void setValue(String) Sets the value of the property, represented by this object.
Inherited members from IParserDocument
Modifier and Type Member Description
public abstract IParserDocument clone() Creates a copy of this object.
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< IParserDocument > getChildDocuments(String...) Returns the elements contained by the element with the given route.
public abstract List< IParserDocument > 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< IParserDocument > 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 IParserDocument getDocument(String...) Returns the first element with the given route.
public abstract List< IParserDocument > getDocuments(String...) Returns all the elements with the given route.
public abstract List< IParserDocument > getDocumentsWithAttribute(String, String, String...) Returns the elements with the given route that contains the given attribute with the given value.
public abstract List< IParserDocument > getDocumentsWithAttribute(String, String, boolean, String...) Returns the elements with the given route that contains the given attribute with the given value.
public abstract IParserDocument getDocumentWithAttribute(String, String, String...) Returns the first element with the given route that contains the given attribute with the given value.
public abstract IParserDocument 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(IParserDocument, 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 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< IParserDocument >, 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.
Inherited members from IPersistable
Modifier and Type Member Description
public void read(BufferedReader)  
public void write(BufferedWriter)  

Usage

May contain additional data retrieved from several source documents