Programmer's Guide > Interfaces > CMSSession interface > getRangeCreateInfo method
  
getRangeCreateInfo method
Returns the default creation information for a new object, according to the given start and end Nodes. This information can be defined in a configuration file that is specific to the document type associated with the given Nodes. As a fallback, Arbortext Editor and Arbortext Publishing Engine will use the atidefaults configuration file.
The information is returned in a PropertyMap. The following table shows the supported key string values:
Key
Value Type
Value Description
IO_CRE_NAME
String
Specifies the default name for the new object, according to the default naming rules.
IO_CRE_LOCATION
String
Specifies the default location for the new object. This may be the Logical ID of a folder or it may be in an adapter-specific path format.
IO_CRE_OBJECT_TYPE
String
Specifies the default object type for the new object.
IO_CRE_LABEL
String
Specifies the default version label for the new object.
getRangeCreateInfo(start, end, isTop)
Parameters
Nodestart
Specifies the first node in the range to consider.
Nodeend
Specifies the last node in the range to consider. This node should be the same as the start node or a subsequent sibling of it.
booleanisTop
Indicates whether the "topmost is filename" naming rule is being used.
If true and the associated burst configuration file has <namerule rule="topmost-is-filename"/> as the very first defaultnamecriteria then the returned IO_CRE_NAME value will be derived from the name (if any) of the document containing the start and end Nodes.
Otherwise, the naming rules in the associated burst configuration file are used to generate the name.
Returns
PropertyMap. A PropertyMap containing the requested information.
Throws
CMSException
If an error occurs.