com.filenet.rm.bds
Interface BaseDefinition
All known subinterfaces:
- public interface BaseDefinition
RecordDefinition
and DocumentDefinition
interfaces.
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getClassIdent()
Returns the identifier (either Name or Id property) of the CE
ClassDescription on which the object defined by this definition
will be based upon.
|
|
getContainers()
Returns a modifiable list of
ContainerReference instances into which the object
defined by this definition instance is to be filed.
|
|
getId()
Returns the
Id field of the BaseDefinition instance.
|
|
getObjectStoreIdent()
Returns the identifier (either Name or Id property) of the ObjectStore
onto which the item defined by this definition will reside upon.
|
|
getPermissionValues()
Returns a modifiable list of
PermissionValue instances to be assigned
to the object defined by this definition instance.
|
|
getPropertyValues()
Returns a modifiable list of
PropertyValue instances to be assigned
to the object defined by this definition instance.
|
|
setId(java.lang.String id)
Sets the
Id field of the BaseDefinition instance.
|
Method Detail
getObjectStoreIdent
- java.lang.String getObjectStoreIdent( )
Returns the identifier (either Name or Id property) of the ObjectStore
onto which the item defined by this definition will reside upon.
Returns:
the
String
ObjectStore identifier. getClassIdent
- java.lang.String getClassIdent( )
Returns the identifier (either Name or Id property) of the CE
ClassDescription on which the object defined by this definition
will be based upon.
Returns:
the
String
CE ClassDescription identifier. getPropertyValues
- java.util.List getPropertyValues( )
Returns a modifiable list of
PropertyValue
instances to be assigned
to the object defined by this definition instance.
This collection can be empty.
Returns:
a
List
containing the PropertyValue
instances. getPermissionValues
- java.util.List getPermissionValues( )
Returns a modifiable list of
PermissionValue
instances to be assigned
to the object defined by this definition instance.
This collection can be empty.
Returns:
a
List
containing the PermissionValue
instances. getContainers
- java.util.List getContainers()
Returns a modifiable list of
ContainerReference
instances into which the object
defined by this definition instance is to be filed.
This collection can be empty for a DocumentDefinition
but not
for a RecordDefinition
.
Returns:
a
List
containing the ContainerReference
instances. getId
- java.lang.String getId()
Returns the
Id
field of the BaseDefinition
instance.
Prior to committal/declaration, this Id value represents the value
previously specified via setId(String)
or
null
if no such call has been previously made.
After sucessful committal/declaration, the returned value represents the Id
property value assigned to corresponding document/record, respectively.
The format of the Id must be that of a GUID string, namely "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hexadecimal character.
Returns:
a
String
version of the new object's Id property.
Returns null
if called before the declaration
and/or committal process has occurred and no previous
setId(String)
call has been made. setId
- void setId(java.lang.String id)
Sets the
Id
field of the BaseDefinition
instance.
This method allows the BDS client to pre-define an Id value
for the object that is eventually created based upon this
BaseDefinition
.
The format of the Id must be that of a GUID string, namely "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hexadecimal character.
Parameters:
id
- The string Id to eventually assign to the corresponding CE Object.