public interface Container extends BaseEntity, Persistable
If the more specific form of a container is unknown, then an
underlying Container
instance can be obtained
using the RMFactory.Container
factory class.
RMFactory.Container
Modifier and Type | Method and Description |
---|---|
boolean |
canContain(EntityType type)
Indicates whether or not this
Container is allowed to
contain a child object of the specified EntityType . |
void |
delete(boolean skipValidation,
DeleteMode deleteMode,
java.lang.String reasonForDelete)
Deletes the container from its associated repository.
|
EntityType[] |
getAllowedContaineeTypes()
Returns an array of
EntityType instances
that represent the types of child objects allowed to be contained by
this Container . |
java.lang.String |
getFolderName()
Returns the
FolderName property value for this Container . |
PageableSet<Container> |
getImmediateSubContainers(java.lang.Integer pageSize)
Returns a pageable set of immediate sub-containers belonging to this container.
|
Container |
getParent()
Returns the immediate parent container of this container, if any.
|
java.lang.String |
getPathName()
Returns the
PathName property value for this Container . |
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
EntityType[] getAllowedContaineeTypes()
EntityType
instances
that represent the types of child objects allowed to be contained by
this Container
.EntityType
.boolean canContain(EntityType type)
Container
is allowed to
contain a child object of the specified EntityType
.type
- the specified EntityType
.true
if the type is allowed, false
otherwise.java.lang.String getFolderName()
FolderName
property value for this Container
.String
value.java.lang.String getPathName()
PathName
property value for this Container
.String
value.Container getParent()
Container
instance or null
if no such parent exists.PageableSet<Container> getImmediateSubContainers(java.lang.Integer pageSize)
pageSize
- optional page size to use. If null
then the repository
default value is used.PageableSet
of Container
instances.void delete(boolean skipValidation, DeleteMode deleteMode, java.lang.String reasonForDelete)
false
, then any validation
failure prevents the deletion from occurring and an exception is
thrown.
All sub-containers in this instance's sub-hierarchy are also deleted. All single-filed records contained within this instance's sub-hierarchy are also deleted, however any multi-filed records are simply unfiled from any containers targeted for deletion.
skipValidation
- true
to skip delete validation.deleteMode
- one of the DeleteMode
enumeration values.reasonForDelete
- text used to support auditing.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.