Interface JPAStructuredType
- All Superinterfaces:
JPAElement
- All Known Subinterfaces:
JPAEntityType
External view on an Intermediate Structured Type.
- Author:
- Oliver Grande
-
Method Summary
Modifier and TypeMethodDescriptiongetAssociation(String internalName)getAssociationPath(String externalName)Searches for an AssociationPath defined by the name used in the OData metadata in all the navigation properties that are available for this type via the OData service.Searches in the navigation properties that are available for this type via the OData service.getAttribute(String internalName)getAttribute(org.apache.olingo.server.api.uri.UriResourceProperty uriResourceItem)List of the path to all collection properties of this type.getDeclaredAssociation(JPAAssociationPath associationPath)In case the type is within the given association path, the sub-path is returned.getDeclaredAssociation(String externalName)List of all associations that are declared at this type.List of all associations that are declared at this type.List of all associations that are declared at this type.List of all associations that are declared at this type.List of all attributes that are available for this type via the OData service.List of all protected Attributes including protection/claim information.Class<?>booleanMethods inherited from interface com.sap.olingo.jpa.metadata.core.edm.mapper.api.JPAElement
getExternalFQN, getExternalName, getInternalName
-
Method Details
-
getAssociation
- Throws:
ODataJPAModelException
-
getAssociationPath
Searches for an AssociationPath defined by the name used in the OData metadata in all the navigation properties that are available for this type via the OData service. That is:- All not ignored navigation properties of this type.
- All not ignored navigation properties from super types.
- All not ignored navigation properties from embedded types.
- Parameters:
externalName-- Returns:
- Throws:
ODataJPAModelException
-
getAssociationPathList
Searches in the navigation properties that are available for this type via the OData service. That is:- All not ignored navigation properties of this type.
- All not ignored navigation properties from super types.
- All not ignored navigation properties from embedded types.
- Returns:
- null if no navigation property found.
- Throws:
ODataJPAModelException
-
getAttribute
- Throws:
ODataJPAModelException
-
getAttribute
JPAAttribute getAttribute(org.apache.olingo.server.api.uri.UriResourceProperty uriResourceItem) throws ODataJPAModelException- Throws:
ODataJPAModelException
-
getAttributes
- Throws:
ODataJPAModelException
-
getCollectionAttributesPath
List of the path to all collection properties of this type. That is:- All not ignored collection properties of this type.
- All not ignored collection properties from super types.
- All not ignored collection properties from embedded types.
- Returns:
- Throws:
ODataJPAModelException
-
getDeclaredAssociation
JPAAssociationPath getDeclaredAssociation(JPAAssociationPath associationPath) throws ODataJPAModelExceptionIn case the type is within the given association path, the sub-path is returned. E.g. structured type is AdministrativeInformation and associationPath = AdministrativeInformation/Created/User Created/User is returned.- Parameters:
associationPath-- Returns:
- Throws:
ODataJPAModelException
-
getDeclaredAssociation
- Throws:
ODataJPAModelException
-
getDeclaredAssociations
List of all associations that are declared at this type. That is:- All navigation properties of this type.
- All navigation properties from super types.
- Returns:
- Throws:
ODataJPAModelException
-
getDeclaredAttributes
List of all associations that are declared at this type. That is:- All properties of this type.
- All properties from super types.
- Returns:
- Throws:
ODataJPAModelException
-
getDeclaredCollectionAttributes
List of all associations that are declared at this type. That is:- All collection properties of this type.
- All collection properties from super types.
- Returns:
- Throws:
ODataJPAModelException
-
getPath
List of all associations that are declared at this type. That is:- All not ignored collection properties of this type.
- All not ignored collection properties from super types.
- Returns:
- Throws:
ODataJPAModelException
-
getPathList
List of all attributes that are available for this type via the OData service. That is:- All not ignored properties of the type.
- All not ignored properties from super types.
- All not ignored properties from embedded types.
- Returns:
- List of all attributes that are available via the OData service.
- Throws:
ODataJPAModelException
-
getProtections
List of all protected Attributes including protection/claim information. That is:- All not ignored protected properties of the type.
- All not ignored protected properties from super types.
- All not ignored protected properties from embedded types.
- Returns:
- Throws:
ODataJPAModelException
-
getTypeClass
Class<?> getTypeClass() -
isAbstract
boolean isAbstract()
-