com.sap.smp.client.odata.metadata.impl

Class ODataMetaFunctionImportDefaultImpl

java.lang.Object

com.sap.smp.client.odata.metadata.impl.AnnotableDefaultImpl

com.sap.smp.client.odata.metadata.impl.ODataMetaFunctionImportDefaultImpl

All Implemented Interfaces:

ODataMetaAnnotable, ODataMetaFunctionImport, java.io.Serializable

public class ODataMetaFunctionImportDefaultImpl
extends AnnotableDefaultImpl
implements ODataMetaFunctionImport

Default implementation of ODataMetaFunctionImport.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ODataMetaFunctionImportDefaultImpl(java.lang.String name, java.lang.String returnTypeName, boolean isReturnCollection, java.lang.String returnEntitySetName, java.lang.String callMethod, java.util.Map<java.lang.String,ODataMetaFunctionParameter> parameters, java.util.Map<AnnotationName,java.lang.String> annotations) Constructor function import default implementation.
ODataMetaFunctionImportDefaultImpl(java.lang.String name, java.lang.String returnTypeName, boolean isReturnCollection, java.lang.String returnEntitySetName, java.lang.String callMethod, java.util.Map<java.lang.String,ODataMetaFunctionParameter> parameters, java.util.Map<AnnotationName,java.lang.String> annotations, java.util.Map<AnnotationName,ODataMetaAnnotation> v4annotations) Constructor function import default implementation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAnnotation(AnnotationName name) Retrieves the annotation value of the function import specified by the given fully qualified annotation name.
java.lang.String	getAnnotation(java.lang.String namespace, java.lang.String name) Retrieves the annotation value of the function import specified by the given annotation namespace and localname.
java.util.Set<AnnotationName>	getAnnotationNames() Retrieves the set of annotation names of the entity set.
java.lang.String	getCallMethod() Retrieves the HTTP method name (GET, POST, ...).
java.lang.String	getName() Retrieves the name of the function import.
ODataMetaFunctionParameter	getParameter(java.lang.String name) Retrieves the function parameter specified by the given name.
java.util.Set<java.lang.String>	getParameterNames() Retrieves the set of parameter names of the function import.
java.lang.String	getReturnEntitySetName() Retrieves the entity set name of the return type.
java.lang.String	getReturnTypeName() Retrieves the return type name (part of edm:ReturnType attribute).
int	hashCode()
boolean	isReturnCollection() Checks if the return type is collection.

Methods inherited from class com.sap.smp.client.odata.metadata.impl.AnnotableDefaultImpl

getVocabularyAnnotation, getVocabularyAnnotation, getVocabularyAnnotationNames, setVocabularyAnnotations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.smp.client.odata.metadata.ODataMetaAnnotable

getVocabularyAnnotation, getVocabularyAnnotation, getVocabularyAnnotationNames

Constructor Detail

ODataMetaFunctionImportDefaultImpl

public ODataMetaFunctionImportDefaultImpl(java.lang.String name,
                                          java.lang.String returnTypeName,
                                          boolean isReturnCollection,
                                          java.lang.String returnEntitySetName,
                                          java.lang.String callMethod,
                                          java.util.Map<java.lang.String,ODataMetaFunctionParameter> parameters,
                                          java.util.Map<AnnotationName,java.lang.String> annotations)

Constructor function import default implementation.

Parameters:

name - name of the function import. MUST be non-null, otherwise IllegalArgumentException is thrown

returnTypeName - the return type name (part of edm:ReturnType attribute). It can be fully qualified entity type name, edm type or the complex type name.

isReturnCollection - specifies if the return type is collection

returnEntitySetName - the entity set name of the return type

callMethod - the HTTP method name

parameters - map of parameters where the key is the name of a parameter and the value is the metadata representation of the parameter. MUST be non-null, otherwise IllegalArgumentException is thrown

annotations - map of annotations where the key is the fully qualified annotation name and the value is the annotation value. MUST be non-null, otherwise IllegalArgumentException is thrown

Throws:

java.lang.IllegalArgumentException - if name parameter is null

ODataMetaFunctionImportDefaultImpl

public ODataMetaFunctionImportDefaultImpl(java.lang.String name,
                                          java.lang.String returnTypeName,
                                          boolean isReturnCollection,
                                          java.lang.String returnEntitySetName,
                                          java.lang.String callMethod,
                                          java.util.Map<java.lang.String,ODataMetaFunctionParameter> parameters,
                                          java.util.Map<AnnotationName,java.lang.String> annotations,
                                          java.util.Map<AnnotationName,ODataMetaAnnotation> v4annotations)

Constructor function import default implementation.

Parameters:

name - name of the function import. MUST be non-null, otherwise IllegalArgumentException is thrown

returnTypeName - the return type name (part of edm:ReturnType attribute). It can be fully qualified entity type name, edm type or the complex type name.

isReturnCollection - specifies if the return type is collection

returnEntitySetName - the entity set name of the return type

callMethod - the HTTP method name

parameters - map of parameters where the key is the name of a parameter and the value is the metadata representation of the parameter. MUST be non-null, otherwise IllegalArgumentException is thrown

annotations - map of annotations where the key is the fully qualified annotation name and the value is the annotation value. MUST be non-null, otherwise IllegalArgumentException is thrown

v4annotations - Odata v4.0 vocabulary-based annotations

Throws:

java.lang.IllegalArgumentException - if name parameter is null

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ODataMetaFunctionImport

Retrieves the name of the function import.

Specified by:

getName in interface ODataMetaFunctionImport

Returns:

the name of the function import, always non-null

getReturnTypeName

public java.lang.String getReturnTypeName()

Description copied from interface: ODataMetaFunctionImport

Retrieves the return type name (part of edm:ReturnType attribute). It can be fully qualified entity type name, edm type or the complex type name.

Specified by:

getReturnTypeName in interface ODataMetaFunctionImport

Returns:

the return type name. It can be fully qualified entity type name, edm type or the complex type name. It can be null if not specified in the CSDL.

isReturnCollection

public boolean isReturnCollection()

Description copied from interface: ODataMetaFunctionImport

Checks if the return type is collection.

Specified by:

isReturnCollection in interface ODataMetaFunctionImport

Returns:

true if the return type is collection. If there is no return type specified in the CSDL it returns false.

getReturnEntitySetName

public java.lang.String getReturnEntitySetName()

Description copied from interface: ODataMetaFunctionImport

Retrieves the entity set name of the return type.

Specified by:

getReturnEntitySetName in interface ODataMetaFunctionImport

Returns:

the entity set name of the return type (edm:EntitySet). It can be null if not specified in CSDL.

getCallMethod

public java.lang.String getCallMethod()

Description copied from interface: ODataMetaFunctionImport

Retrieves the HTTP method name (GET, POST, ...).

Specified by:

getCallMethod in interface ODataMetaFunctionImport

Returns:

the HTTP method name (m:HttpMethod), can be null

getParameterNames

public java.util.Set<java.lang.String> getParameterNames()

Description copied from interface: ODataMetaFunctionImport

Retrieves the set of parameter names of the function import.

Specified by:

getParameterNames in interface ODataMetaFunctionImport

Returns:

set of the parameter names, always non-null

getParameter

public ODataMetaFunctionParameter getParameter(java.lang.String name)

Description copied from interface: ODataMetaFunctionImport

Retrieves the function parameter specified by the given name.

Specified by:

getParameter in interface ODataMetaFunctionImport

Parameters:

name - name of the parameter. MUST be non-null, otherwise NullPointerException is thrown

Returns:

metadata representation of the function parameter if found, null otherwise

getAnnotationNames

public java.util.Set<AnnotationName> getAnnotationNames()

Description copied from interface: ODataMetaFunctionImport

Retrieves the set of annotation names of the entity set.

Specified by:

getAnnotationNames in interface ODataMetaFunctionImport

Returns:

the set of annotation names of the entity set, always non-null

getAnnotation

public java.lang.String getAnnotation(AnnotationName name)

Description copied from interface: ODataMetaFunctionImport

Retrieves the annotation value of the function import specified by the given fully qualified annotation name.

Specified by:

getAnnotation in interface ODataMetaFunctionImport

Parameters:

name - fully qualified annotation name. MUST be non-null, otherwise NullPointerException is thrown

Returns:

the annotation value of the function import if found, null otherwise

getAnnotation

public java.lang.String getAnnotation(java.lang.String namespace,
                                      java.lang.String name)

Description copied from interface: ODataMetaFunctionImport

Retrieves the annotation value of the function import specified by the given annotation namespace and localname.

Specified by:

getAnnotation in interface ODataMetaFunctionImport

Parameters:

namespace - namespace of the annotation, can be null

name - localname of the annotation. MUST be non-null, otherwise NullPointerException is thrown

Returns:

the annotation value of the function import if found, null otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object