public interface BaseDefinition
RecordDefinition
and DocumentDefinition
interfaces.Modifier and Type | Method and Description |
---|---|
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.
|
java.util.List |
getContainers()
Returns a modifiable list of
ContainerReference instances into which the object
defined by this definition instance is to be filed. |
java.lang.String |
getId()
Returns the
Id field of the BaseDefinition instance. |
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.
|
java.util.List |
getPermissionValues()
Returns a modifiable list of
PermissionValue instances to be assigned
to the object defined by this definition instance. |
java.util.List |
getPropertyValues()
Returns a modifiable list of
PropertyValue instances to be assigned
to the object defined by this definition instance. |
void |
setId(java.lang.String id)
Sets the
Id field of the BaseDefinition instance. |
java.lang.String getObjectStoreIdent()
String
ObjectStore identifier.java.lang.String getClassIdent()
String
CE ClassDescription identifier.java.util.List getPropertyValues()
PropertyValue
instances to be assigned
to the object defined by this definition instance.
This collection can be empty.List
containing the PropertyValue
instances.java.util.List getPermissionValues()
PermissionValue
instances to be assigned
to the object defined by this definition instance.
This collection can be empty.List
containing the PermissionValue
instances.java.util.List getContainers()
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
.List
containing the ContainerReference
instances.java.lang.String getId()
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.
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.void setId(java.lang.String id)
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.
id
- The string Id to eventually assign to the corresponding CE Object.© Copyright IBM Corp. 2006, 2013. All Rights Reserved.