EntitySet (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.EntitySet

All Implemented Interfaces:

BindingPath
```
public class EntitySet
extends java.lang.Object
implements BindingPath
```
Encapsulates the metadata of an OData entity set. Also used for OData EntitySet.isSingleton entities.

See Also:

DataService.createEntity, DataService.updateEntity, DataService.deleteEntity, DataService.getEntity, DataService.getEntityList.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EntitySet.Index` Metadata for an index on the containing entity set.
`static class`	`EntitySet.IndexList` A list of item type `EntitySet.Index`.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COLUMN_TABLE` Table type for column-based storage.
`static java.lang.String`	`NO_TABLE` Special value for `EntitySet.table` to indicate that this entity set should not be stored in the database.
`static java.lang.String`	`ROW_TABLE` Table type for row-based storage.
`static EntitySet`	`undefined`

Constructor Summary

Constructors
Constructor and Description

EntitySet()

Constructors
Constructor and Description
`EntitySet()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Annotation`	`getAnnotation(java.lang.String term)` Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
`AnnotationMap`	`getAnnotations()` Return map of annotations for this model element.
`EntitySet`	`getBinding(java.lang.String name)` Lookup an existing navigation property binding by name.
`boolean`	`getCanBeRemoved()` Return can this model element be removed by `DataService.refreshMetadata`.
`boolean`	`getCheckDeletes()` Return should the affected row count for local deletes be checked, to ensure that each expected deleted row was actually deleted? Defaults to `true`.
`boolean`	`getCheckUpdates()` Return should the affected row count for local updates be checked, to ensure that each expected updated row was actually updated? Defaults to `true`.
`StringList`	`getCreateRoles()` Return security roles permitted for a user to be able to create entities in this entity set.
`SelectItemList`	`getDefaultSelect()` Return list of default selection items for this entity set.
`StringList`	`getDeleteRoles()` Return security roles permitted for a user to be able to delete entities from this entity set.
`java.lang.String`	`getDeltaView()` Return (nullable) Delta-tracking view for this entity set (if different from the `EntitySet.table`).
`int`	`getDownloadOrder()` Return a custom download order for use in synchronization.
`Annotation`	`getDownloadQuery()` Return (nullable) Annotation for SQL download query (if any), otherwise `null`.
`EntityType`	`getEntityType()` Return entity type for entities in this set.
`boolean`	`getGeneratedKey()` Return does this entity set require a generated primary key.
`EntitySet.IndexList`	`getIndexes()` Return secondary indexes to be created in the database.
`java.lang.String`	`getKeyGenerator()` Return (nullable) Name of key generator sequence (if `EntitySet.generatedKey` is `true`).
`java.lang.String`	`getLocalName()` Return the local name of this set within its owning `EntityContainer`, e.g.
`EntitySetMetrics`	`getMetrics()` Return metrics for runtime use of this entity set.
`java.lang.String`	`getName()` Return synonym for `EntitySet.qualifiedName`.
`boolean`	`getPartitionByClient()` Return should the database table for this entity set be partitioned by client?
`EntitySetMap`	`getPathBindings()` Return map of bindings from navigation properties to entity sets.
`java.lang.String`	`getQualifiedName()` Return the name of this set qualified by its owning `EntityContainer` name, e.g.
`StringList`	`getReadRoles()` Return security roles permitted for a user to be able to read entities from this entity set.
`java.lang.String`	`getResourcePath()` Return the name of this set as it should be referenced in resource paths (e.g.
`java.lang.String`	`getSchema()` Return (nullable) Schema that contains the table.
`boolean`	`getSelectAfterCreate()` Return should entities be reselected after create, to ensure that database-generated column values will be available afterwards? Defaults to `true`.
`boolean`	`getSelectAfterUpdate()` Return should entities be reselected after update, to ensure that database-generated column values will be available afterwards? Defaults to `true`.
`int`	`getSourceLine()` Return source line number for this schema element within its defining schema.
`boolean`	`getSurrogateKey()` Return does this entity set use a system-generated surrogate key for persistence, rather than its model-defined primary key.
`int`	`getSystemFlags()` For internal use only.
`java.lang.String`	`getTable()` Return (nullable) Database table for this entity set.
`java.lang.String`	`getTableType()` Return (nullable) Database table type for this entity set.
`java.lang.String`	`getTargetPath()` Return the name of this set qualified by its owning `DataSchema` and `EntityContainer` names, e.g.
`boolean`	`getTrackChanges()` Return set to `false` to disable change tracking for this entity set.
`boolean`	`getTrackDownloads()` Return set to `false` to disable download tracking for this entity set.
`StringList`	`getUpdateRoles()` Return security roles permitted for a user to be able to update entities in this entity set.
`int`	`getUploadBatchSize()` Return upload batch size (defaults to 20)
`boolean`	`hasBackendEtag()` Return does this entity set have a backend etag column?
`boolean`	`hasOfflineKey()` Return does this entity set have an offline key column?
`boolean`	`hasOfflineState()` Return does this entity set have an error state column?
`boolean`	`hasVersionColumn()` Return does this entity set have a row version column?
`boolean`	`isDownloadable()` Return is this entity downloadable?
`boolean`	`isDownloadFilter()` Return is this entity set intended for use as a filter in SQL download queries?
`boolean`	`isExtension()` Return `true` if this set was added since metadata was originally loaded.
`boolean`	`isImportedFromSQL()` Return is this entity set imported from an existing SQL database table?
`boolean`	`isLocal()` Return is this a local entity set? A local entity set exists only in the local database (for application use), not the backend system.
`boolean`	`isRemoved()` Return has this model element been removed by a successful call to `DataService.refreshMetadata`? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
`boolean`	`isSingleton()` Return does this entity set represent an OData singleton entity?
`boolean`	`isSystem()` Return is this a system entity set? A system entity set exists only in the local database (for internal use), not the backend system.
`boolean`	`isUploadable()` Return is this entity uploadable?
`void`	`setBackendEtag(boolean value)` Set does this entity set have a backend etag column?
`void`	`setCanBeRemoved(boolean value)` Set can this model element be removed by `DataService.refreshMetadata`.
`void`	`setCheckDeletes(boolean value)` Set should the affected row count for local deletes be checked, to ensure that each expected deleted row was actually deleted? Defaults to `true`.
`void`	`setCheckUpdates(boolean value)` Set should the affected row count for local updates be checked, to ensure that each expected updated row was actually updated? Defaults to `true`.
`void`	`setCreateRoles(StringList value)` Set security roles permitted for a user to be able to create entities in this entity set.
`void`	`setDeleteRoles(StringList value)` Set security roles permitted for a user to be able to delete entities from this entity set.
`void`	`setDeltaView(java.lang.String value)` Set delta-tracking view for this entity set (if different from the `EntitySet.table`).
`void`	`setDownloadable(boolean value)` Set is this entity downloadable?
`void`	`setDownloadFilter(boolean value)` Set is this entity set intended for use as a filter in SQL download queries?
`void`	`setDownloadOrder(int value)` Set a custom download order for use in synchronization.
`void`	`setDownloadQuery(Annotation value)` Set annotation for SQL download query (if any), otherwise `null`.
`void`	`setEntityType(EntityType value)` Set entity type for entities in this set.
`void`	`setExtension(boolean value)` Set `true` if this set was added since metadata was originally loaded.
`void`	`setGeneratedKey(boolean value)` Set does this entity set require a generated primary key.
`void`	`setImportedFromSQL(boolean value)` Set is this entity set imported from an existing SQL database table?
`void`	`setIndexes(EntitySet.IndexList value)` Set secondary indexes to be created in the database.
`void`	`setKeyGenerator(java.lang.String value)` Set name of key generator sequence (if `EntitySet.generatedKey` is `true`).
`void`	`setLocal(boolean value)` Set is this a local entity set? A local entity set exists only in the local database (for application use), not the backend system.
`void`	`setLocalName(java.lang.String value)` Set the local name of this set within its owning `EntityContainer`, e.g.
`void`	`setOfflineKey(boolean value)` Set does this entity set have an offline key column?
`void`	`setOfflineState(boolean value)` Set does this entity set have an error state column?
`void`	`setPartitionByClient(boolean value)` Set should the database table for this entity set be partitioned by client?
`void`	`setQualifiedName(java.lang.String value)` Set the name of this set qualified by its owning `EntityContainer` name, e.g.
`void`	`setReadRoles(StringList value)` Set security roles permitted for a user to be able to read entities from this entity set.
`void`	`setRemoved(boolean value)` Set has this model element been removed by a successful call to `DataService.refreshMetadata`? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
`void`	`setResourcePath(java.lang.String value)` Set the name of this set as it should be referenced in resource paths (e.g.
`void`	`setSchema(java.lang.String value)` Set schema that contains the table.
`void`	`setSelectAfterCreate(boolean value)` Set should entities be reselected after create, to ensure that database-generated column values will be available afterwards? Defaults to `true`.
`void`	`setSelectAfterUpdate(boolean value)` Set should entities be reselected after update, to ensure that database-generated column values will be available afterwards? Defaults to `true`.
`void`	`setSingleton(boolean value)` Set does this entity set represent an OData singleton entity?
`void`	`setSourceLine(int value)` Set source line number for this schema element within its defining schema.
`void`	`setSurrogateKey(boolean value)` Set does this entity set use a system-generated surrogate key for persistence, rather than its model-defined primary key.
`void`	`setSystem(boolean value)` Set is this a system entity set? A system entity set exists only in the local database (for internal use), not the backend system.
`void`	`setSystemFlags(int value)` For internal use only.
`void`	`setTable(java.lang.String value)` Set database table for this entity set.
`void`	`setTableType(java.lang.String value)` Set database table type for this entity set.
`void`	`setTargetPath(java.lang.String value)` Set the name of this set qualified by its owning `DataSchema` and `EntityContainer` names, e.g.
`void`	`setTrackChanges(boolean value)` Set set to `false` to disable change tracking for this entity set.
`void`	`setTrackDownloads(boolean value)` Set set to `false` to disable download tracking for this entity set.
`void`	`setUpdateRoles(StringList value)` Set security roles permitted for a user to be able to update entities in this entity set.
`void`	`setUploadable(boolean value)` Set is this entity uploadable?
`void`	`setUploadBatchSize(int value)` Set upload batch size (defaults to 20)
`void`	`setVersionColumn(boolean value)` Set does this entity set have a row version column?
`java.lang.String`	`toString()`
`static EntitySet`	`undefinedIfNull(EntitySet entitySet)` Return `EntitySet.undefined` if `entitySet` is `null`, otherwise return `entitySet`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_TABLE
```
public static final java.lang.String NO_TABLE
```
    Special value for EntitySet.table to indicate that this entity set should not be stored in the database.
    
    See Also:
    
    Constant Field Values
  - COLUMN_TABLE
```
public static final java.lang.String COLUMN_TABLE
```
    Table type for column-based storage.
    
    See Also:
    
    Constant Field Values
  - ROW_TABLE
```
public static final java.lang.String ROW_TABLE
```
    Table type for row-based storage.
    
    See Also:
    
    Constant Field Values
  - undefined
```
public static final EntitySet undefined
```
- Constructor Detail
  - EntitySet
```
public EntitySet()
```
- Method Detail
  - getAnnotation
```
public Annotation getAnnotation(java.lang.String term)
```
    Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
    
    See Also:
    
    EntitySet.annotations and AnnotationMap.get, for looking up annotations that might not exist.
    
    Parameters:
    
    term - The term name.
    
    Returns:
    
    The annotation.
  - getAnnotations
```
public AnnotationMap getAnnotations()
```
    Return map of annotations for this model element. For annotations without qualifiers, the entry key is the annotation term name. For annotations with qualifiers, the entry key is the annotation term name, then "#", then the annotation qualifier.
    
    See Also:
    
    Annotation, AnnotationTerm.
    
    Returns:
    
    Map of annotations for this model element.
  - getBinding
```
public EntitySet getBinding(java.lang.String name)
```
    Lookup an existing navigation property binding by name.
    
    See Also:
    
    EntitySet.pathBindings and EntitySetMap.get, for looking up bindings that might not exist.
    
    Parameters:
    
    name - Name of the property.
    
    Returns:
    
    The bound entity set.
  - getCanBeRemoved
```
public boolean getCanBeRemoved()
```
    Return can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.
    
    See Also:
    
    EntitySet.isRemoved.
    
    Returns:
    
    Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.
  - getCheckDeletes
```
public boolean getCheckDeletes()
```
    Return should the affected row count for local deletes be checked, to ensure that each expected deleted row was actually deleted? Defaults to true.
    
    Returns:
    
    Should the affected row count for local deletes be checked, to ensure that each expected deleted row was actually deleted? Defaults to true.
  - getCheckUpdates
```
public boolean getCheckUpdates()
```
    Return should the affected row count for local updates be checked, to ensure that each expected updated row was actually updated? Defaults to true.
    
    Returns:
    
    Should the affected row count for local updates be checked, to ensure that each expected updated row was actually updated? Defaults to true.
  - getCreateRoles
```
public StringList getCreateRoles()
```
    Return security roles permitted for a user to be able to create entities in this entity set. The user need only belong to one of the roles.
    
    Returns:
    
    Security roles permitted for a user to be able to create entities in this entity set.
  - getDefaultSelect
```
public SelectItemList getDefaultSelect()
```
    Return list of default selection items for this entity set.
    
    Returns:
    
    List of default selection items for this entity set.
  - getDeleteRoles
```
public StringList getDeleteRoles()
```
    Return security roles permitted for a user to be able to delete entities from this entity set. The user need only belong to one of the roles.
    
    Returns:
    
    Security roles permitted for a user to be able to delete entities from this entity set.
  - getDeltaView
```
public java.lang.String getDeltaView()
```
    Return (nullable) Delta-tracking view for this entity set (if different from the EntitySet.table).
    
    Returns:
    
    (nullable) Delta-tracking view for this entity set (if different from the EntitySet.table).
  - getDownloadOrder
```
public int getDownloadOrder()
```
    Return a custom download order for use in synchronization. The entity set with the lowest downloadOrder value is downloaded first. The download sequence for two entity sets with the same downloadOrder will be the same as the order of the EntitySet definitions in the service CSDL.
    
    Returns:
    
    A custom download order for use in synchronization.
  - getDownloadQuery
```
public Annotation getDownloadQuery()
```
    Return (nullable) Annotation for SQL download query (if any), otherwise null.
    
    Returns:
    
    (nullable) Annotation for SQL download query (if any), otherwise null.
  - getEntityType
```
public EntityType getEntityType()
```
    Return entity type for entities in this set.
    
    Returns:
    
    Entity type for entities in this set.
  - getGeneratedKey
```
public boolean getGeneratedKey()
```
    Return does this entity set require a generated primary key.
    
    Returns:
    
    Does this entity set require a generated primary key.
  - getIndexes
```
public EntitySet.IndexList getIndexes()
```
    Return secondary indexes to be created in the database.
    
    Returns:
    
    Secondary indexes to be created in the database.
  - getKeyGenerator
```
public java.lang.String getKeyGenerator()
```
    Return (nullable) Name of key generator sequence (if EntitySet.generatedKey is true).
    
    Returns:
    
    (nullable) Name of key generator sequence (if EntitySet.generatedKey is true).
  - getLocalName
```
public java.lang.String getLocalName()
```
    Return the local name of this set within its owning EntityContainer, e.g. "MyEntitySet".
    
    Returns:
    
    The local name of this set within its owning EntityContainer, e.g. "MyEntitySet".
  - getMetrics
```
public EntitySetMetrics getMetrics()
```
    Return metrics for runtime use of this entity set.
    
    Returns:
    
    Metrics for runtime use of this entity set.
  - getName
```
public java.lang.String getName()
```
    Return synonym for EntitySet.qualifiedName.
    
    Returns:
    
    Synonym for EntitySet.qualifiedName.
  - getPartitionByClient
```
public boolean getPartitionByClient()
```
    Return should the database table for this entity set be partitioned by client?
    
    Returns:
    
    Should the database table for this entity set be partitioned by client?
  - getPathBindings
```
public EntitySetMap getPathBindings()
```
    Return map of bindings from navigation properties to entity sets.
    
    Returns:
    
    Map of bindings from navigation properties to entity sets.
  - getQualifiedName
```
public java.lang.String getQualifiedName()
```
    Return the name of this set qualified by its owning EntityContainer name, e.g. "MyContainer.MyEntitySet". The Entity container prefix is omitted for the "default" entity container in the outermost schema.
    
    Returns:
    
    The name of this set qualified by its owning EntityContainer name, e.g. "MyContainer.MyEntitySet".
  - getReadRoles
```
public StringList getReadRoles()
```
    Return security roles permitted for a user to be able to read entities from this entity set. The user need only belong to one of the roles.
    
    Returns:
    
    Security roles permitted for a user to be able to read entities from this entity set.
  - getResourcePath
```
public java.lang.String getResourcePath()
```
    Return the name of this set as it should be referenced in resource paths (e.g. localName for OData V4, qualifiedName for OData V2).
    
    Returns:
    
    The name of this set as it should be referenced in resource paths (e.g. localName for OData V4, qualifiedName for OData V2).
  - getSchema
```
public java.lang.String getSchema()
```
    Return (nullable) Schema that contains the table.
    
    Returns:
    
    (nullable) Schema that contains the table.
  - getSelectAfterCreate
```
public boolean getSelectAfterCreate()
```
    Return should entities be reselected after create, to ensure that database-generated column values will be available afterwards? Defaults to true.
    
    Returns:
    
    Should entities be reselected after create, to ensure that database-generated column values will be available afterwards? Defaults to true.
  - getSelectAfterUpdate
```
public boolean getSelectAfterUpdate()
```
    Return should entities be reselected after update, to ensure that database-generated column values will be available afterwards? Defaults to true.
    
    Returns:
    
    Should entities be reselected after update, to ensure that database-generated column values will be available afterwards? Defaults to true.
  - getSourceLine
```
public int getSourceLine()
```
    Return source line number for this schema element within its defining schema.
    
    Returns:
    
    Source line number for this schema element within its defining schema.
  - getSurrogateKey
```
public boolean getSurrogateKey()
```
    Return does this entity set use a system-generated surrogate key for persistence, rather than its model-defined primary key.
    
    See Also:
    
    EntityValue.systemKey.
    
    Returns:
    
    Does this entity set use a system-generated surrogate key for persistence, rather than its model-defined primary key.
  - getSystemFlags
```
public int getSystemFlags()
```
    For internal use only.
    
    Returns:
    
    (internal use only)
  - getTable
```
public java.lang.String getTable()
```
    Return (nullable) Database table for this entity set.
    
    Returns:
    
    (nullable) Database table for this entity set.
  - getTableType
```
public java.lang.String getTableType()
```
    Return (nullable) Database table type for this entity set. If unset, the default table type depends on the target database.
    
    See Also:
    
    #constants) (COLUMN_TABLE, ROW_TABLE).
    
    Returns:
    
    (nullable) Database table type for this entity set.
  - getTargetPath
```
public java.lang.String getTargetPath()
```
    Return the name of this set qualified by its owning DataSchema and EntityContainer names, e.g. "MySchema.MyContainer/MyEntitySet".
    
    Returns:
    
    The name of this set qualified by its owning DataSchema and EntityContainer names, e.g. "MySchema.MyContainer/MyEntitySet".
  - getTrackChanges
```
public boolean getTrackChanges()
```
    Return set to false to disable change tracking for this entity set. Defaults to true.
    
    Returns:
    
    Set to false to disable change tracking for this entity set. Defaults to true.
  - getTrackDownloads
```
public boolean getTrackDownloads()
```
    Return set to false to disable download tracking for this entity set. Defaults to true.
    
    Returns:
    
    Set to false to disable download tracking for this entity set. Defaults to true.
  - getUpdateRoles
```
public StringList getUpdateRoles()
```
    Return security roles permitted for a user to be able to update entities in this entity set. The user need only belong to one of the roles.
    
    Returns:
    
    Security roles permitted for a user to be able to update entities in this entity set.
  - getUploadBatchSize
```
public int getUploadBatchSize()
```
    Return upload batch size (defaults to 20)
    
    Returns:
    
    Upload batch size (defaults to 20)
  - hasBackendEtag
```
public boolean hasBackendEtag()
```
    Return does this entity set have a backend etag column?
    
    Returns:
    
    Does this entity set have a backend etag column?
  - hasOfflineKey
```
public boolean hasOfflineKey()
```
    Return does this entity set have an offline key column?
    
    Returns:
    
    Does this entity set have an offline key column?
  - hasOfflineState
```
public boolean hasOfflineState()
```
    Return does this entity set have an error state column?
    
    Returns:
    
    Does this entity set have an error state column?
  - hasVersionColumn
```
public boolean hasVersionColumn()
```
    Return does this entity set have a row version column?
    
    Returns:
    
    Does this entity set have a row version column?
  - isDownloadFilter
```
public boolean isDownloadFilter()
```
    Return is this entity set intended for use as a filter in SQL download queries?
    
    Returns:
    
    Is this entity set intended for use as a filter in SQL download queries?
  - isDownloadable
```
public boolean isDownloadable()
```
    Return is this entity downloadable?
    
    Returns:
    
    Is this entity downloadable?
  - isExtension
```
public boolean isExtension()
```
    Return true if this set was added since metadata was originally loaded.
    
    Returns:
    
    true if this set was added since metadata was originally loaded.
  - isImportedFromSQL
```
public boolean isImportedFromSQL()
```
    Return is this entity set imported from an existing SQL database table?
    
    Returns:
    
    Is this entity set imported from an existing SQL database table?
  - isLocal
```
public boolean isLocal()
```
    Return is this a local entity set? A local entity set exists only in the local database (for application use), not the backend system.
    
    Returns:
    
    Is this a local entity set?
  - isRemoved
```
public boolean isRemoved()
```
    Return has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
    
    See Also:
    
    EntitySet.canBeRemoved.
    
    Returns:
    
    Has this model element been removed by a successful call to `DataService.refreshMetadata`?
  - isSingleton
```
public boolean isSingleton()
```
    Return does this entity set represent an OData singleton entity?
    
    Returns:
    
    Does this entity set represent an OData singleton entity?
  - isSystem
```
public boolean isSystem()
```
    Return is this a system entity set? A system entity set exists only in the local database (for internal use), not the backend system.
    
    Returns:
    
    Is this a system entity set?
  - isUploadable
```
public boolean isUploadable()
```
    Return is this entity uploadable?
    
    Returns:
    
    Is this entity uploadable?
  - setBackendEtag
```
public void setBackendEtag(boolean value)
```
    Set does this entity set have a backend etag column?
    
    Parameters:
    
    value - Does this entity set have a backend etag column?
  - setCanBeRemoved
```
public void setCanBeRemoved(boolean value)
```
    Set can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.
    
    See Also:
    
    EntitySet.isRemoved.
    
    Parameters:
    
    value - Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.
  - setCheckDeletes
```
public void setCheckDeletes(boolean value)
```
    Set should the affected row count for local deletes be checked, to ensure that each expected deleted row was actually deleted? Defaults to true.
    
    Parameters:
    
    value - Should the affected row count for local deletes be checked, to ensure that each expected deleted row was actually deleted? Defaults to true.
  - setCheckUpdates
```
public void setCheckUpdates(boolean value)
```
    Set should the affected row count for local updates be checked, to ensure that each expected updated row was actually updated? Defaults to true.
    
    Parameters:
    
    value - Should the affected row count for local updates be checked, to ensure that each expected updated row was actually updated? Defaults to true.
  - setCreateRoles
```
public void setCreateRoles(StringList value)
```
    Set security roles permitted for a user to be able to create entities in this entity set. The user need only belong to one of the roles.
    
    Parameters:
    
    value - Security roles permitted for a user to be able to create entities in this entity set.
  - setDeleteRoles
```
public void setDeleteRoles(StringList value)
```
    Set security roles permitted for a user to be able to delete entities from this entity set. The user need only belong to one of the roles.
    
    Parameters:
    
    value - Security roles permitted for a user to be able to delete entities from this entity set.
  - setDeltaView
```
public void setDeltaView(java.lang.String value)
```
    Set delta-tracking view for this entity set (if different from the EntitySet.table).
    
    Parameters:
    
    value - Delta-tracking view for this entity set (if different from the EntitySet.table).
  - setDownloadFilter
```
public void setDownloadFilter(boolean value)
```
    Set is this entity set intended for use as a filter in SQL download queries?
    
    Parameters:
    
    value - Is this entity set intended for use as a filter in SQL download queries?
  - setDownloadOrder
```
public void setDownloadOrder(int value)
```
    Set a custom download order for use in synchronization. The entity set with the lowest downloadOrder value is downloaded first. The download sequence for two entity sets with the same downloadOrder will be the same as the order of the EntitySet definitions in the service CSDL.
    
    Parameters:
    
    value - A custom download order for use in synchronization.
  - setDownloadQuery
```
public void setDownloadQuery(Annotation value)
```
    Set annotation for SQL download query (if any), otherwise null.
    
    Parameters:
    
    value - Annotation for SQL download query (if any), otherwise null.
  - setDownloadable
```
public void setDownloadable(boolean value)
```
    Set is this entity downloadable?
    
    Parameters:
    
    value - Is this entity downloadable?
  - setEntityType
```
public void setEntityType(EntityType value)
```
    Set entity type for entities in this set.
    
    Parameters:
    
    value - Entity type for entities in this set.
  - setExtension
```
public void setExtension(boolean value)
```
    Set true if this set was added since metadata was originally loaded.
    
    Parameters:
    
    value - true if this set was added since metadata was originally loaded.
  - setGeneratedKey
```
public void setGeneratedKey(boolean value)
```
    Set does this entity set require a generated primary key.
    
    Parameters:
    
    value - Does this entity set require a generated primary key.
  - setImportedFromSQL
```
public void setImportedFromSQL(boolean value)
```
    Set is this entity set imported from an existing SQL database table?
    
    Parameters:
    
    value - Is this entity set imported from an existing SQL database table?
  - setIndexes
```
public void setIndexes(EntitySet.IndexList value)
```
    Set secondary indexes to be created in the database.
    
    Parameters:
    
    value - Secondary indexes to be created in the database.
  - setKeyGenerator
```
public void setKeyGenerator(java.lang.String value)
```
    Set name of key generator sequence (if EntitySet.generatedKey is true).
    
    Parameters:
    
    value - Name of key generator sequence (if EntitySet.generatedKey is true).
  - setLocal
```
public void setLocal(boolean value)
```
    Set is this a local entity set? A local entity set exists only in the local database (for application use), not the backend system.
    
    Parameters:
    
    value - Is this a local entity set?
  - setLocalName
```
public void setLocalName(java.lang.String value)
```
    Set the local name of this set within its owning EntityContainer, e.g. "MyEntitySet".
    
    Parameters:
    
    value - The local name of this set within its owning EntityContainer, e.g. "MyEntitySet".
  - setOfflineKey
```
public void setOfflineKey(boolean value)
```
    Set does this entity set have an offline key column?
    
    Parameters:
    
    value - Does this entity set have an offline key column?
  - setOfflineState
```
public void setOfflineState(boolean value)
```
    Set does this entity set have an error state column?
    
    Parameters:
    
    value - Does this entity set have an error state column?
  - setPartitionByClient
```
public void setPartitionByClient(boolean value)
```
    Set should the database table for this entity set be partitioned by client?
    
    Parameters:
    
    value - Should the database table for this entity set be partitioned by client?
  - setQualifiedName
```
public void setQualifiedName(java.lang.String value)
```
    Set the name of this set qualified by its owning EntityContainer name, e.g. "MyContainer.MyEntitySet". The Entity container prefix is omitted for the "default" entity container in the outermost schema.
    
    Parameters:
    
    value - The name of this set qualified by its owning EntityContainer name, e.g. "MyContainer.MyEntitySet".
  - setReadRoles
```
public void setReadRoles(StringList value)
```
    Set security roles permitted for a user to be able to read entities from this entity set. The user need only belong to one of the roles.
    
    Parameters:
    
    value - Security roles permitted for a user to be able to read entities from this entity set.
  - setRemoved
```
public void setRemoved(boolean value)
```
    Set has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
    
    See Also:
    
    EntitySet.canBeRemoved.
    
    Parameters:
    
    value - Has this model element been removed by a successful call to `DataService.refreshMetadata`?
  - setResourcePath
```
public void setResourcePath(java.lang.String value)
```
    Set the name of this set as it should be referenced in resource paths (e.g. localName for OData V4, qualifiedName for OData V2).
    
    Parameters:
    
    value - The name of this set as it should be referenced in resource paths (e.g. localName for OData V4, qualifiedName for OData V2).
  - setSchema
```
public void setSchema(java.lang.String value)
```
    Set schema that contains the table.
    
    Parameters:
    
    value - Schema that contains the table.
  - setSelectAfterCreate
```
public void setSelectAfterCreate(boolean value)
```
    Set should entities be reselected after create, to ensure that database-generated column values will be available afterwards? Defaults to true.
    
    Parameters:
    
    value - Should entities be reselected after create, to ensure that database-generated column values will be available afterwards? Defaults to true.
  - setSelectAfterUpdate
```
public void setSelectAfterUpdate(boolean value)
```
    Set should entities be reselected after update, to ensure that database-generated column values will be available afterwards? Defaults to true.
    
    Parameters:
    
    value - Should entities be reselected after update, to ensure that database-generated column values will be available afterwards? Defaults to true.
  - setSingleton
```
public void setSingleton(boolean value)
```
    Set does this entity set represent an OData singleton entity?
    
    Parameters:
    
    value - Does this entity set represent an OData singleton entity?
  - setSourceLine
```
public void setSourceLine(int value)
```
    Set source line number for this schema element within its defining schema.
    
    Parameters:
    
    value - Source line number for this schema element within its defining schema.
  - setSurrogateKey
```
public void setSurrogateKey(boolean value)
```
    Set does this entity set use a system-generated surrogate key for persistence, rather than its model-defined primary key.
    
    See Also:
    
    EntityValue.systemKey.
    
    Parameters:
    
    value - Does this entity set use a system-generated surrogate key for persistence, rather than its model-defined primary key.
  - setSystem
```
public void setSystem(boolean value)
```
    Set is this a system entity set? A system entity set exists only in the local database (for internal use), not the backend system.
    
    Parameters:
    
    value - Is this a system entity set?
  - setSystemFlags
```
public void setSystemFlags(int value)
```
    For internal use only.
    
    Parameters:
    
    value - (internal use only)
  - setTable
```
public void setTable(java.lang.String value)
```
    Set database table for this entity set.
    
    Parameters:
    
    value - Database table for this entity set.
  - setTableType
```
public void setTableType(java.lang.String value)
```
    Set database table type for this entity set. If unset, the default table type depends on the target database.
    
    See Also:
    
    #constants) (COLUMN_TABLE, ROW_TABLE).
    
    Parameters:
    
    value - Database table type for this entity set.
  - setTargetPath
```
public void setTargetPath(java.lang.String value)
```
    Set the name of this set qualified by its owning DataSchema and EntityContainer names, e.g. "MySchema.MyContainer/MyEntitySet".
    
    Parameters:
    
    value - The name of this set qualified by its owning DataSchema and EntityContainer names, e.g. "MySchema.MyContainer/MyEntitySet".
  - setTrackChanges
```
public void setTrackChanges(boolean value)
```
    Set set to false to disable change tracking for this entity set. Defaults to true.
    
    Parameters:
    
    value - Set to false to disable change tracking for this entity set. Defaults to true.
  - setTrackDownloads
```
public void setTrackDownloads(boolean value)
```
    Set set to false to disable download tracking for this entity set. Defaults to true.
    
    Parameters:
    
    value - Set to false to disable download tracking for this entity set. Defaults to true.
  - setUpdateRoles
```
public void setUpdateRoles(StringList value)
```
    Set security roles permitted for a user to be able to update entities in this entity set. The user need only belong to one of the roles.
    
    Parameters:
    
    value - Security roles permitted for a user to be able to update entities in this entity set.
  - setUploadBatchSize
```
public void setUploadBatchSize(int value)
```
    Set upload batch size (defaults to 20)
    
    Parameters:
    
    value - Upload batch size (defaults to 20)
  - setUploadable
```
public void setUploadable(boolean value)
```
    Set is this entity uploadable?
    
    Parameters:
    
    value - Is this entity uploadable?
  - setVersionColumn
```
public void setVersionColumn(boolean value)
```
    Set does this entity set have a row version column?
    
    Parameters:
    
    value - Does this entity set have a row version column?
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - undefinedIfNull
```
public static EntitySet undefinedIfNull(EntitySet entitySet)
```
    Return EntitySet.undefined if entitySet is null, otherwise return entitySet.
    
    Parameters:
    
    entitySet - (nullable) Entity set, or null.
    
    Returns:
    
    EntitySet.undefined if entitySet is null, otherwise return entitySet.

Class EntitySet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_TABLE

COLUMN_TABLE

ROW_TABLE

undefined

Constructor Detail

EntitySet

Method Detail

getAnnotation

getAnnotations

getBinding

getCanBeRemoved

getCheckDeletes

getCheckUpdates

getCreateRoles

getDefaultSelect

getDeleteRoles

getDeltaView

getDownloadOrder

getDownloadQuery

getEntityType

getGeneratedKey

getIndexes

getKeyGenerator

getLocalName

getMetrics

getName

getPartitionByClient

getPathBindings

getQualifiedName

getReadRoles

getResourcePath

getSchema

getSelectAfterCreate

getSelectAfterUpdate

getSourceLine

getSurrogateKey

getSystemFlags

getTable

getTableType

getTargetPath

getTrackChanges

getTrackDownloads

getUpdateRoles

getUploadBatchSize

hasBackendEtag

hasOfflineKey

hasOfflineState

hasVersionColumn

isDownloadFilter

isDownloadable

isExtension

isImportedFromSQL

isLocal

isRemoved

isSingleton

isSystem

isUploadable

setBackendEtag

setCanBeRemoved

setCheckDeletes

setCheckUpdates

setCreateRoles

setDeleteRoles

setDeltaView

setDownloadFilter

setDownloadOrder

setDownloadQuery

setDownloadable

setEntityType

setExtension

setGeneratedKey

setImportedFromSQL

setIndexes