public interface BaseEntity
If the more specific form of an entity is unknown, then an
underlying BaseEntity
instance can be obtained
using the RMFactory.BaseEntity
factory class.
RMFactory.BaseEntity
Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
getAccessAllowed()
Returns a value representing a bit mask of access rights granted to the
current user for this object.
|
RMClassDescription |
getClassDescription()
Returns the
RMClassDescription for this entity. |
java.lang.String |
getClassName()
Provides the name of the repository class from which the entity is instantiated.
|
java.lang.String |
getClientIdentifier()
Provides the client-specific identifying string for the entity.
|
java.util.List<Container> |
getContainedBy()
Provides the collection of
Container instances
in which this entity is filed, if any. |
DomainType |
getDomainType()
Convenience method that indicates the type of
RMDomain in which this
BaseEntity resides. |
EntityType |
getEntityType()
Provides the entity type of this entity.
|
java.lang.String |
getName()
Provides a
Name property value for the entity, if any. |
java.lang.String |
getObjectIdentity()
Provides a unique, repository-specific identifying string for the entity.
|
java.util.List<RMPermission> |
getPermissions()
Provides the
RMPermission collection for this entity. |
RMProperties |
getProperties()
Provides the collection of properties that reflects the state of the
property cache of the entity.
|
Repository |
getRepository()
Provides the repository to which this entity belongs.
|
boolean |
isCreationPending()
Returns
true if this instance represents a new entity
that has not been saved to a repository. |
boolean |
isPlaceholder()
Returns
true if this instance currently represents a placeholder for
an actual repository entity. |
void |
refresh()
Retrieves the entity from its repository updating the values of its existing
internally cached properties.
|
void |
refresh(RMPropertyFilter filter)
Retrieves the entity from its repository updating its internal property cached
based upon the supplied
RMPropertyFilter . |
void |
refresh(java.lang.String[] symbolicPropertyNames)
Retrieves the entity from its repository updating the values of the specified
properties.
|
java.lang.String getClientIdentifier()
getObjectIdentity()
method.String
value.java.lang.String getObjectIdentity()
null
if the entity has not been fetched from the repository.String
value.java.lang.String getClassName()
String
value.RMClassDescription getClassDescription()
RMClassDescription
for this entity.RMClassDescription
instance.java.lang.String getName()
Name
property value for the entity, if any.String
value.EntityType getEntityType()
EntityType
value.Repository getRepository()
Repository
instance.boolean isPlaceholder()
true
if this instance currently represents a placeholder for
an actual repository entity. The actual entity has not
been fetched from the repository. This is typically the case when a
RMFactory.xxx.getInstance method has been used to establish the instance.true
if instance represents a placeholder, false
if instance has been fetched from a repository.boolean isCreationPending()
true
if this instance represents a new entity
that has not been saved to a repository.true
if this instance has not been saved, false
otherwise.RMProperties getProperties()
RMProperties
collection.java.util.List<Container> getContainedBy()
Container
instances
in which this entity is filed, if any.List
of Container
instances.
Can be empty.RAL_RETRIEVING_PARENT_CONTAINER_FAILED
- for any unexpected error.java.util.List<RMPermission> getPermissions()
RMPermission
collection for this entity.List
of RMPermission
instances.void refresh()
void refresh(java.lang.String[] symbolicPropertyNames)
symbolicPropertyNames
- An array of symbolic names of the properties to update.void refresh(RMPropertyFilter filter)
RMPropertyFilter
.filter
- An optional RMPropertyFilter
defining
retrieved properties for the repository instance.
This setting can be null
.java.lang.Integer getAccessAllowed()
Integer
instance. This value can be null
if this object has
not been resolved from the repository.DomainType getDomainType()
RMDomain
in which this
BaseEntity
resides.DomainType
value.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.