public class EntityContainer
extends java.lang.Object
Represents an OData entity container.
Constructor and Description |
---|
EntityContainer() |
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.
|
EntityContainer |
getBaseContainer()
Return the base container if this container extends another.
|
DataMethodMap |
getDataMethods()
Return the data methods defined by this container.
|
EntitySetMap |
getEntitySets()
Return the entity sets defined by this container.
|
java.lang.String |
getLocalName()
Return the local name of this container within its owning
DataSchema , e.g. |
java.lang.String |
getName()
Return synonym for
EntityContainer.localName . |
java.lang.String |
getQualifiedName()
Return the name of this set qualified by its owning
DataSchema name, e.g. |
StringList |
getSecurityRoles()
Return list of security roles defined for the entity container.
|
StringList |
getServiceUserRoles()
Return list of security role names for authorized service users.
|
EntitySetMap |
getSingletons()
Return the singletons defined by this container.
|
int |
getSourceLine()
Return source line number for this schema element within its defining schema.
|
boolean |
getTrackChanges()
Return set to
true to enable change tracking for all entity sets in this container. |
boolean |
getTrackDownloads()
Return set to
true to enable download tracking for all entity sets in this container. |
StringList |
getViewMetricsRoles()
Return list of security role names for authorized service administrators.
|
boolean |
isCacheDatabase()
Return is this entity container a cache database?
|
boolean |
isDefault()
Return is this the default container within its defining schema?
|
void |
setBaseContainer(EntityContainer value)
Set the base container if this container extends another.
|
void |
setCacheDatabase(boolean value)
Set is this entity container a cache database?
|
void |
setDefault(boolean value)
Set is this the default container within its defining schema?
|
void |
setLocalName(java.lang.String value)
Set the local name of this container within its owning
DataSchema , e.g. |
void |
setQualifiedName(java.lang.String value)
Set the name of this set qualified by its owning
DataSchema name, e.g. |
void |
setSecurityRoles(StringList value)
Set list of security roles defined for the entity container.
|
void |
setServiceUserRoles(StringList value)
Set list of security role names for authorized service users.
|
void |
setSourceLine(int value)
Set source line number for this schema element within its defining schema.
|
void |
setTrackChanges(boolean value)
Set set to
true to enable change tracking for all entity sets in this container. |
void |
setTrackDownloads(boolean value)
Set set to
true to enable download tracking for all entity sets in this container. |
void |
setViewMetricsRoles(StringList value)
Set list of security role names for authorized service administrators.
|
public Annotation getAnnotation(java.lang.String term)
Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
EntityContainer.annotations
and AnnotationMap.get
, for looking up annotations that might not exist.
term
- The term name.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.
public EntityContainer getBaseContainer()
Return the base container if this container extends another.
public DataMethodMap getDataMethods()
Return the data methods defined by this container.
public EntitySetMap getEntitySets()
Return the entity sets defined by this container.
public java.lang.String getLocalName()
Return the local name of this container within its owning DataSchema
, e.g. "MyContainer".
DataSchema
, e.g. "MyContainer".public java.lang.String getName()
Return synonym for EntityContainer.localName
.
EntityContainer.localName
.public java.lang.String getQualifiedName()
Return the name of this set qualified by its owning DataSchema
name, e.g. "MySchema.MyContainer".
DataSchema
name, e.g. "MySchema.MyContainer".public StringList getSecurityRoles()
Return list of security roles defined for the entity container. Such roles do not permit any particular access except as determined by runtime role checks.
DataServlet.isUserInRole
.
public StringList getServiceUserRoles()
Return list of security role names for authorized service users.
public EntitySetMap getSingletons()
Return the singletons defined by this container.
public int getSourceLine()
Return source line number for this schema element within its defining schema.
public boolean getTrackChanges()
Return set to true
to enable change tracking for all entity sets in this container.
true
to enable change tracking for all entity sets in this container.public boolean getTrackDownloads()
Return set to true
to enable download tracking for all entity sets in this container.
true
to enable download tracking for all entity sets in this container.public StringList getViewMetricsRoles()
Return list of security role names for authorized service administrators.
public boolean isCacheDatabase()
Return is this entity container a cache database?
public boolean isDefault()
Return is this the default container within its defining schema?
public void setBaseContainer(EntityContainer value)
Set the base container if this container extends another.
value
- The base container if this container extends another.public void setCacheDatabase(boolean value)
Set is this entity container a cache database?
value
- Is this entity container a cache database?public void setDefault(boolean value)
Set is this the default container within its defining schema?
value
- Is this the default container within its defining schema?public void setLocalName(java.lang.String value)
Set the local name of this container within its owning DataSchema
, e.g. "MyContainer".
value
- The local name of this container within its owning DataSchema
, e.g. "MyContainer".public void setQualifiedName(java.lang.String value)
Set the name of this set qualified by its owning DataSchema
name, e.g. "MySchema.MyContainer".
value
- The name of this set qualified by its owning DataSchema
name, e.g. "MySchema.MyContainer".public void setSecurityRoles(StringList value)
Set list of security roles defined for the entity container. Such roles do not permit any particular access except as determined by runtime role checks.
DataServlet.isUserInRole
.
value
- List of security roles defined for the entity container.public void setServiceUserRoles(StringList value)
Set list of security role names for authorized service users.
value
- List of security role names for authorized service users.public void setSourceLine(int value)
Set source line number for this schema element within its defining schema.
value
- Source line number for this schema element within its defining schema.public void setTrackChanges(boolean value)
Set set to true
to enable change tracking for all entity sets in this container.
value
- Set to true
to enable change tracking for all entity sets in this container.public void setTrackDownloads(boolean value)
Set set to true
to enable download tracking for all entity sets in this container.
value
- Set to true
to enable download tracking for all entity sets in this container.public void setViewMetricsRoles(StringList value)
Set list of security role names for authorized service administrators.
value
- List of security role names for authorized service administrators.