Package com.arbortext.epic.cms

Interface CMSSession

All Known Implementing Classes:
CMSSessionImpl
public interface CMSSession
The CMSSession interface represents a content management system (CMS) session.
Since:
Epic 5.2

  • Field Details

    • CMS_BURST_POLICY_NEVER

      static final int CMS_BURST_POLICY_NEVER
      The adapter does not support bursting.
      See Also:

    • CMS_BURST_POLICY_ON_CHECKIN

      static final int CMS_BURST_POLICY_ON_CHECKIN
      The adapter performs bursting during document check-in.
      See Also:

    • CMS_BURST_NO_BOUNDARY

      static final int CMS_BURST_NO_BOUNDARY
      This element is not configured to be burst.
      See Also:

    • CMS_BURST_FILE_ENTITY

      static final int CMS_BURST_FILE_ENTITY
      This element is configured to burst as a file entity.
      See Also:

    • CMS_BURST_VIRTUAL_DOC

      static final int CMS_BURST_VIRTUAL_DOC
      This element is configured to burst as a virtual document.
      See Also:

    • CMS_BURST_XINCLUDE

      static final int CMS_BURST_XINCLUDE
      This element is configured to burst as an xinclude.
      See Also:

    • CMS_BURST_FULLTEXT

      static final int CMS_BURST_FULLTEXT
      Enable full text indexing on the top most object.
      See Also:

    • CMS_BURST_IMPORT_FILEENTS

      static final int CMS_BURST_IMPORT_FILEENTS
      Import file entities.
      See Also:

    • CMS_BURST_NO_IMPORT_FILEENTS

      static final int CMS_BURST_NO_IMPORT_FILEENTS
      Do not import file entities.
      See Also:

    • CMS_BURST_IMPORT_GRAPHICS

      static final int CMS_BURST_IMPORT_GRAPHICS
      Import graphic files.
      See Also:

    • CMS_BURST_NO_IMPORT_GRAPHICS

      static final int CMS_BURST_NO_IMPORT_GRAPHICS
      Do not import graphic files.
      See Also:

    • CMS_BURST_ELEMENTS

      static final int CMS_BURST_ELEMENTS
      Burst on element boundaries.
      See Also:

    • CMS_BURST_NO_ELEMENTS

      static final int CMS_BURST_NO_ELEMENTS
      Ignore element boundaries.
      See Also:

    • CMS_BURST_TOP_FILENAME

      static final int CMS_BURST_TOP_FILENAME
      Use the file name for the topmost object name.
      See Also:

    • CMS_BURST_NO_TOP_FILENAME

      static final int CMS_BURST_NO_TOP_FILENAME
      Do not use the file name for the topmost object name.
      See Also:

    • CMS_BURST_TOP_LOCK

      static final int CMS_BURST_TOP_LOCK
      Lock the topmost object for editing.
      See Also:

    • CMS_BURST_NO_TOP_LOCK

      static final int CMS_BURST_NO_TOP_LOCK
      Do not lock the topmost object.
      See Also:

    • CMS_BURST_USE_LOCATION_RULES

      static final int CMS_BURST_USE_LOCATION_RULES
      Follow location rules for child objects even if useroverride=on.
      See Also:

    • CMS_CREATE_LOCKED

      static final int CMS_CREATE_LOCKED
      The object is initially locked.
      See Also:

    • CMS_CREATE_VIRTUAL_CONTAINER

      static final int CMS_CREATE_VIRTUAL_CONTAINER
      The object will be a virtual document container. Objects which will reference child objects via File Entity or XInclude need not specify this flag.
      See Also:

    • CMS_OPERATION_ENABLED

      static final short CMS_OPERATION_ENABLED
      Operation is allowed in the current state.
      See Also:

    • CMS_OPERATION_NOT_ENABLED

      static final short CMS_OPERATION_NOT_ENABLED
      Operation is not allowed in the current state. If any methods in the category are called, they will raise a CMSException with error code CMSException.OPERATION_NOT_ENABLED_ERR.
      See Also:

    • CMS_OPERATION_NOT_SUPPORTED

      static final short CMS_OPERATION_NOT_SUPPORTED
      Operation is not supported by the adapter. If any methods in the category are called, they will raise a CMSException with error code CMSException.UNIMP_ERR.
      See Also:

    • CMS_OPERATION_UNKNOWN

      static final short CMS_OPERATION_UNKNOWN
      Operation is not recognized by the adapter. This may be returned if a new category was added to PTC Arbortext Editor but the adapter has not been updated. The caller can assume that methods in the category are enabled (they will throw CMSException.UNIMP_ERR if not implemented).
      See Also:

  • Method Details

    • getBurstPolicy

      int getBurstPolicy() throws CMSException
      Represents the burst policy of the adapter. The value is one of the CMSBurstPolicy enumerated constants.
      Throws:
      CMSException - Raised for any error.

    • getBurstUserOverride

      boolean getBurstUserOverride() throws CMSException
      Set to true if this session has the user override set to on for bursting-related options such as object names. This setting allows the user to override certain options that would otherwise be completely dictated by the bursting rules. Set to false if it is not. This setting prevents the user from overriding the bursting options.
      Throws:
      CMSException - Raised for any error.

    • getConnected

      boolean getConnected()
      Set to true if the session is still connected. Set to false if it is not.

    • getCurrentUser

      String getCurrentUser() throws CMSException
      Specifies the current CMS user name. This will normally match the loginId parameter to the CMSAdapter.connect() method which established this session.
      Throws:
      CMSException - Raised for any error.

    • getDefaultFolder

      String getDefaultFolder() throws CMSException
      Specifies the Logical ID of the current user's default folder.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setDefaultFolder

      void setDefaultFolder(String defaultFolder) throws CMSException
      Specifies the Logical ID of the current user's default folder.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getFullTextSearch

      boolean getFullTextSearch() throws CMSException
      Indicates whether to index new documents for full-text searching. Not all adapters will implement full text searching.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setFullTextSearch

      void setFullTextSearch(boolean fullTextSearch) throws CMSException
      Indicates whether to index new documents for full-text searching. Not all adapters will implement full text searching.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getObjectReuse

      boolean getObjectReuse() throws CMSException
      Indicates whether the session supports object reuse during bursting by maintaining a Logical ID and filename cache. See the setFileMappingEntry for more details.
      Throws:
      CMSException - Raised for any error.

    • getAclId

      int getAclId()
      Represent the session ID associated with the CMSSession object. You can use this ID with the PTC Arbortext Command Language (ACL) programming language. If the session is no longer valid, the aclld value is an invalid session ID (-1 ).

    • getSessionToken

      String getSessionToken() throws CMSException
      Specifies an adapter-specific session identifier that can be used to make calls directly into the CMS vendor API.
      This attribute might not be supported by all adapters.
      Throws:
      CMSException - Raised for any error.

    • getAdapter

      CMSAdapter getAdapter() throws CMSException
      Specifies the CMSAdapter object associated with this session.
      Throws:
      CMSException - Raised for any error accessing this attribute.

    • disconnect

      void disconnect() throws CMSException
      Closes the CMS session. Only the connected attribute can be safely accessed after this method is called.
      Throws:
      CMSException - Raised for any error.

    • getAttribute

      String getAttribute(String attribute) throws CMSException
      Reads the value of a session attribute. Attributes are identified by name. The attribute names supported by this method will vary with each adapter.
      Parameters:
      attribute - Specifies the attribute name.
      Returns:
      The attribute value.
      Throws:
      CMSException - Raised for any error.

    • setAttribute

      void setAttribute(String attribute, String value) throws CMSException
      Sets the value of a session attribute. The attribute names supported by this method will vary with each adapter.
      Parameters:
      attribute - Specifies the attribute name.
      value - Specifies the attribute value.
      Throws:
      CMSException - Raised for any error.

    • objectExists

      boolean objectExists(String logicalId) throws CMSException
      Indicates whether an object exists in the CMS. The object is identified by a Logical ID. It is sufficient for this method to ensure that the Logical ID or Persistent Object Identifier (POID) format is correct. To verify the object's actual existence in the CMS, and its accessibility, Application.constructObject must be used.
      Parameters:
      logicalId - Specifies a Logical ID.
      Returns:
      Returns true if the object exists. Returns false if it does not.
      Throws:
      CMSException - If an error occurs.

    • logicalIdToPoid

      String logicalIdToPoid(String logicalId) throws CMSException
      Translates a Logical ID to a Persistent Object Identifier (POID). POIDs are used internally by PTC Arbortext Editor and PTC Arbortext Publishing Engine and are not normally used by an application developer.
      Parameters:
      logicalId - Specifies the Logical ID to translate.
      Returns:
      A POID.
      Throws:
      CMSException - If an error occurs.

    • poidToLogicalId

      String poidToLogicalId(String poid, String label) throws CMSException
      Translates a Persistent Object Identifier (POID) and version to a Logical ID. POIDs are used internally by PTC Arbortext Editor and PTC Arbortext Publishing Engine and are not normally used by an Application Developer.
      Parameters:
      poid - Specifies the POID to translate.
      label - Specifies the optional version label. The syntax is adapter-specific.
      Returns:
      A Logical ID.
      Throws:
      CMSException - If an error occurs.

    • poidToLogicalId

      String poidToLogicalId(String poid) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • getFileMappingEntry

      String getFileMappingEntry(String pathname) throws CMSException
      Checks whether a resolved path name already exists in the CMS. You use this method to avoid creating multiple CMS objects from a single source file -- for example, by loading multiple entity references to one file. Before calling this method, use the objectReuse attribute to determine if this session is managing file mapping entries or not.
      Parameters:
      pathname - Specifies the resolved entity path name. This should be a normalized form of a local resource path. For example on Windows-based systems, the following paths all represent the same local resource:
      • c:\graphics\engine.jpg
      • c:\Graphics\Engine.JPG
      • c:\graphics\..\graphics\engine.jpg
      For this reason, the caller should normalize this path in a consistent manner before calling this method.
      Returns:
      Returns the associated Logical ID, if it is in the CMS. Returns null if it is not.
      Throws:
      CMSException - If an error occurs.

    • setFileMappingEntry

      void setFileMappingEntry(String pathname, String logicalId) throws CMSException
      Instructs the adapter to persistently store a path name to a Logical ID association. If a mapping already exists for the path name, it will be replaced with the new Logical ID. Use this method in conjunction with the getFileMappingEntry method to prevent creating multiple CMS objects based on a single file.
      The getFileMappingEntry and setFileMappingEntry calls are not atomic. During bursting, a new CMS object is created between the getFileMappingEntry and setFileMappingEntry calls. If multiple processes are performing burst operations, the result might be multiple CMS objects for the same source file. For example, assume process A and process B both call the getFileMappingEntry method at the same time and find that an association does not currently exist. Both processes then create new CMS objects and call the setFileMappingEntry method to create the association. The last setFileMappingEntry call takes precedence, and its CMS object will be reused by subsequent burst operations. The other CMS object continues to exist and be referenced by its XML document.
      There is no standard way to tell the adapter to remove a path name to Logical ID mapping.
      Parameters:
      pathname - Specifies the resolved entity path name. See the pathname parameter to the getFileMappingEntry method for information about normalization of this path name.
      logicalId - Specifies the associated Logical ID in the CMS.
      Throws:
      CMSException - If an error occurs.

    • getFile

      String getFile(String logicalId, String notation) throws CMSException
      Downloads an object from the CMS to a local file and returns the local path name. This method is typically used to retrieve graphic objects.
      Parameters:
      logicalId - Specifies the Logical ID.
      notation - Specifies the graphic file format, if applicable.
      Returns:
      A local file name. It can be assumed that the adapter is tracking the files it returns and it will manage them appropriately. The application developer must not delete this file.
      Throws:
      CMSException - If an error occurs.

    • getFile

      String getFile(String logicalId) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • putFile

      String putFile(String filename, String objectName, String folderLogicalId, String notation, String objType) throws CMSException
      Stores a file in the CMS. If the adapter is tracking imported files (see the objectReuse attribute), an entry is created in the persistent lookup table associating the filename with the new Logical ID. See the getFileMappingEntry method for more details.
      Parameters:
      filename - Specifies the path name to store. Because the adapter may create a file mapping entry, this path should be normalized. See the getFileMappingEntry for more details.
      objectName - Specifies the name of the CMS object to create. This is the suggested name. The adapter is allowed to use a variant of this name if, for example, the CMS disallows two objects with the same name in the same folder. The actual name used can be obtained by calling the Application.constructObject method with the returned Logical ID and accessing that object's name attribute.
      folderLogicalId - Specifies the location of the new object in the CMS. This may be the Logical ID of a folder or it may be in an adapter-specific path format.
      notation - Specifies the graphic file format. This is optional.
      objType - Specifies the CMS object type for new object. If not supplied, the bursting rules are consulted to determine the object type.
      Returns:
      The Logical ID of the new object.
      Throws:
      CMSException - If an error occurs.

    • putFile

      String putFile(String filename, String objectName, String folderLogicalId, String notation) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • burstDocument

      void burstDocument(Document doc, String name, String folderLogicalId, int flags, String logFile) throws CMSException
      Bursts the specified file system document using this session. If the specified document contains more than one top-level element, it will not be burst.
      Parameters:
      doc - Specifies the document to burst. The document must be a file system object.
      name - Specifies the name to use for the topmost object. If the value of this parameter is null or empty, then the bursting rules are consulted.The adapter is allowed to use a variant of this name if, for example, the CMS disallows two objects with the same name in the same folder. The actual name used can be obtained by accessing the CMSObject attribute on the ADocument after a successful burst and then accessing that object's name attribute.
      folderLogicalId - Specifies the destination folder for all objects created. If the value of this parameter is null or empty, then the bursting rules are consulted. This may be the Logical ID of a folder or it may be in an adapter-specific path format.If your system-wide bursting configuration specification has the useroverride setting set to on, then the folder parameter provides a user-specified destination folder for all objects created. If the value of this parameter is null or empty, then the bursting rules determine in which folders the new objects are created.If your system-wide bursting configuration specification has the useroverride setting set to off, then the folder parameter is not used and the bursting rules determine in which folders the new objects are created.See the burstUserOverride attribute for more details.
      flags - Specifies the flags which control the bursting behavior. The value is a bit-wise OR of the CMSSessBurstFlags constants. The negative flag settings override session defaults.
      logFile - Specifies the full path of a local log file to which this method will append diagnostic information related to bursting this document.The given document is now associated with a new top-level object in the CMS. The CMSObject attribute of the ADocument interface can be used to access information about the new top-level object.
      Throws:
      CMSException - Raised for any error bursting the document.

    • burstDocument

      void burstDocument(Document doc, String name, String folderLogicalId, int flags) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • burstDocument

      void burstDocument(Document doc, String name, String folderLogicalId) throws CMSException
      Method overload which omits the last 2 parameters.
      Throws:
      CMSException

    • burstDocument

      void burstDocument(Document doc, String name) throws CMSException
      Method overload which omits the last 3 parameters.
      Throws:
      CMSException

    • burstDocument

      void burstDocument(Document doc) throws CMSException
      Method overload which omits the last 4 parameters.
      Throws:
      CMSException

    • clearBurstConfig

      void clearBurstConfig() throws CMSException
      This is a special method for administrators to use while they are developing the burst configuration files. It clears out all of the burst configuration settings you have loaded and reloads the system-wide settings. The document type-specific configurations are loaded as they are needed -- for example, when a document of that document type is burst. This enables new settings to be tested without having to exit PTC Arbortext Editor. This method does not change the folder that PTC Arbortext Editor uses to load burst configuration files.
      Throws:
      CMSException - Raised for any error.

    • createObjectFromSubtree

      CMSObject createObjectFromSubtree(String name, String folderLogicalId, Node start, Node end, int flags, String objType) throws CMSException
      Creates a new CMS object, assigning content from an in-memory document. If the new object is a folder or an empty document, use null values for the start and end parameters. If bursting rules are setup, you may use them to supply or override some of the parameter values.
      After successful completion, the given DOM Nodes will be associated with the new CMS object. However, this does not replace the Nodes with a file entity or XInclude reference and so the association will be lost when the containing document is closed unless some additional action is performed.
      Parameters:
      name - Specifies the name of the new CMS object. The adapter is allowed to use a variant of this name if, for example, the CMS disallows two objects with the same name in the same folder. The actual name used can be obtained by accessing the name attribute of the returned CMSObject.
      folderLogicalId - Specifies the folder to put the object in. This may be the Logical ID of a folder or it may be in an adapter-specific path format.
      start - Specifies the DOM Node representing the first node to be included in the new object.
      end - Specifies the DOM Node representing the last node to be included in the new object. This node should be the same as the start node or a subsequent sibling of it.
      flags - Specifies the creation options. The value is determined by a bit-wise OR of the CMSCreateFlags constants.
      objType - Specifies the CMS object type for the new object.
      Returns:
      A new object handle.
      Throws:
      CMSException - If an error occurs.

    • createObjectFromSubtree

      CMSObject createObjectFromSubtree(String name, String folderLogicalId, Node start, Node end, int flags) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • createObjectFromSubtree

      CMSObject createObjectFromSubtree(String name, String folderLogicalId, Node start, Node end) throws CMSException
      Method overload which omits the last 2 parameters.
      Throws:
      CMSException

    • createNewObject

      CMSObject createNewObject(String name, String folderLogicalId, Document doc, int flags, String objType) throws CMSException
      Creates an empty CMS object of the same type as the specified document. If bursting rules are set up, you may use them to supply or override some of the parameter values.
      Parameters:
      name - Specifies the name of the new CMS object. The adapter is allowed to use a variant of this name if, for example, the CMS disallows two objects with the same name in the same folder. The actual name used can be obtained by accessing the name attribute of the returned CMSObject.
      folderLogicalId - Specifies the folder to put the object in. This may be the Logical ID of a folder or it may be in an adapter-specific path format.
      doc - Provides context information for the creation of the object.
      flags - Specifies the creation options. The value is determined by a bit-wise OR of the CMSCreateFlags constants.
      objType - Specifies the CMS object type for the new object.
      Returns:
      A new object handle.
      Throws:
      CMSException - If an error occurs.

    • createNewObject

      CMSObject createNewObject(String name, String folderLogicalId, Document doc, int flags) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • createNewObject

      CMSObject createNewObject(String name, String folderLogicalId, Document doc) throws CMSException
      Method overload which omits the last 2 parameters.
      Throws:
      CMSException

    • createFolder

      CMSObject createFolder(String name, String folderLogicalId, String objType) throws CMSException
      Creates a new CMS folder object
      Parameters:
      name - Specifies the name of the new CMS folder object. The adapter is allowed to use a variant of this name if, for example, the CMS disallows two objects with the same name in the same folder. The actual name used can be obtained by accessing the name attribute of the returned CMSObject.
      folderLogicalId - Specifies the folder to put the object in. This may be the Logical ID of a folder or it may be in an adapter-specific path format.
      objType - Specifies the CMS object type for the new folder object.
      Returns:
      A new object handle.
      Throws:
      CMSException - If an error occurs.

    • createFolder

      CMSObject createFolder(String name, String folderLogicalId) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • invokeExtension

      PropertyMap invokeExtension(int opcode, PropertyMap map) throws CMSException
      Invokes an adapter-specific extension function. Some adapters provide functionality beyond the standard CMS API.
      Parameters:
      opcode - Specifies the adapter-specific value which identifies the extension method to invoke.
      map - Specifies the collection of adapter-specific parameters to the specified extension method.
      Returns:
      A PropertyMap populated with adapter-specific content.
      Throws:
      CMSException - Raised for any error calling the extension method.

    • search

      CMSBrowseIterator search(String criteria) throws CMSException
      Searches the CMS for objects that match the specified search criteria. The criteria string is created by the search dialog. Its format is adapter-specific.
      Parameters:
      criteria - Specifies the adapter-specific string containing search criteria.
      Returns:
      An iterator over search results. The iterator returns CMSBrowseItem objects.
      Throws:
      CMSException - If an error occurs.

    • getUserData

      String getUserData(String key) throws CMSException
      Retrieves application data from the session. This method enables user interface or application code to retrieve named data that was previously stored by calling the setUserData method.
      Parameters:
      key - Specifies the unique key used to identify the data.
      Returns:
      Returns the data associated with the given key. Returns null if there is none.
      Throws:
      CMSException - Raised for any error.

    • setUserData

      void setUserData(String key, String data) throws CMSException
      Stores some application data on the session. Any existing data for the same key is replaced by the new data. This method enables user interface or application code to associate named data with the session, which it can retrieve later by calling the getUserData method. User data only exists in memory, and is not stored between sessions.
      Some adapters may support additional arguments to certain methods by having the application call setUserData with a predefined key just before calling the method. The adapter documentation will describe any such additional arguments.
      Parameters:
      key - Specifies the unique key used to identify the data.
      data - Specifies the data to associate with the given key, or null to remove any existing data for the key.
      Throws:
      CMSException - Raised for any error.

    • setOldUserData

      void setOldUserData(String data)
      Can be used to allow some methods and properties in this interface to work with older adapters ("Oracle iFS Adapter" or "Documentum Adapter"). Some older adapters require usage of a "user data" field with certain ACL functions (such as those starting with sess_ or dobj_). This allows such functionality of older adapters to be accessed via this AOM interface.
      This may be used with the following methods...
      • disconnect()
      • getFile()
      • putFile()
      • createObjectFromSubtree()
      • createNewObject()
      • search()

      This stores the given data for use with the next method call which can make use of it. After that method call, the stored data will be automatically erased so it won't affect future calls.This should only be used with older adapters and will have no effect on newer adapters.The data is stored directly with this AOM object. If this object is disposed before the method call, the data will not be available for use by the method. To avoid any issues, set the data immediately before making the method call.
      Parameters:
      data - Specifies the value to store as the old user data.

    • getBurstBoundaryType

      int getBurstBoundaryType(Node node) throws CMSException
      For the given node, determines the burst boundary type according to the bursting rules associated with this session.
      Parameters:
      node - Specifies the DOM Node to look up in the burst rules.
      Returns:
      Returns one of the CMSBurstBoundaryType enumerated types describing the bursting rule for the given node.
      Throws:
      CMSException - If an error occurs.

    • getDefaultCreateInfo

      PropertyMap getDefaultCreateInfo() throws CMSException
      Returns the default object creation information that is not specific to any particular document type. This information is defined in 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_FILE_REFERENCE String Determines whether Insert and Share Object will create an entity or an XInclude. Allowed values are xinclude or entity.
      IO_CRE_FULL_TEXT_SEARCH Number Determines whether the object is flagged for full text searching. Allowed values are 0 and 1.
      IO_CRE_LATEST_ID String Specifies the default version label that indicates an object is the "official" current version.
      IO_CRE_LOGICAL_ID String Specifies the default version label that tells the adapter to load the working copy of an object. If no working copy exists, the adapter loads the "official" current copy.
      IO_CRE_MAX_LEN Number Specifies the default maximum name length for CMS objects.
      IO_CRE_ROOT_TYPE String Specifies the root object type for PTC Arbortext Editor and PTC Arbortext Publishing Engine objects.
      IO_CRE_TEMP_ID String Specifies the default version label that indicates an object is a working copy.
      IO_CRE_TOP_LOCKED Number Determines whether the topmost CMS object is locked for editing after bursting. Allowed values are 0 and 1.
      Returns:
      A PropertyMap containing the requested information.
      Throws:
      CMSException - If an error occurs.

    • getGraphicCreateInfo

      PropertyMap getGraphicCreateInfo(Node graphicNode) throws CMSException
      Returns the default creation information for a new graphic object. This information is defined in 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_LOCATION String Specifies the default location for new graphics. 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 graphics.
      IO_CRE_LABEL String Specifies the default version label for graphics.
      Parameters:
      graphicNode - Represents a graphic tag. Elements are designated as graphic tags by a document type's DCF (document configuration file) file or by the document's current Styler stylesheet. The stylesheet overrides the DCF file.
      Returns:
      A PropertyMap containing the requested information.
      Throws:
      CMSException - If an error occurs.

    • getRangeCreateInfo

      PropertyMap getRangeCreateInfo(Node start, Node end, boolean isTop) throws CMSException
      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, PTC Arbortext Editor and PTC 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.
      Parameters:
      start - Specifies the first node in the range to consider.
      end - 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.
      isTop - 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:
      A PropertyMap containing the requested information.
      Throws:
      CMSException - If an error occurs.

    • refreshObjectStatus

      void refreshObjectStatus()
      To improve performance, the internal implementation keeps track of the lock and read-only status of all constructed objects. This method will cause all constructed objects to refresh this information from the adapter. All appropriate views will be updated (if needed) to reflect any change in an object's status.

    • createEvent

      Event createEvent(String eventType) throws CMSException
      Creates a CMSSession event.
      Parameters:
      eventType - Specifies the type of Event interface to be created. The only event module supported by this method is "CMSSessionEvents". If the Event is to be dispatched with the dispatchEvent method, the appropriate event init method must be called after creation in order to initialize the Event's values. As an example, a user wishing to synthesize a CMSSessionConstructEvent would call createEvent with the parameter "CMSSESSIONCONSTRUCTEVENTS". The initCMSSessionEvent method could then be called on the newly created CMSSessionConstructEvent to set the specific type of CMSSessionConstructEvent to be dispatched and to set its context information.
      Returns:
      The newly created Event.
      Throws:
      CMSException - NOT_SUPPORTED_ERR: Raised if the implementation does not support the type of Event interface requested.
      Since:
      Arbortext 5.4

    • verifyOperationEnabledInCurrentState

      short verifyOperationEnabledInCurrentState(String operation) throws CMSException
      Indicates whether an operation is allowed in the current state. Some adapters support more than one mode, and different operations may be allowed in each mode. PTC Arbortext Editor does not define what modes or states are possible. Instead, it asks the adapter which operations are enabled in the current state.
      Parameters:
      operation - Specifies the type of operation. The following table lists the valid strings for the operation parameter, along with the corresponding AOM methods.
      operation Methods
      createObjectMethods CMSSession.createNewObject, CMSSession.createObjectFromSubtree
      createFolderMethods CMSSession.createFolder
      burstMethods CMSObject.burst, CMSSession.burstDocument
      checkinoutMethods CMSObject.checkin, CMSObject.checkout, CMSObject.cancelCheckout
      attributeMethods CMSObject.getAttribute, CMSObject.getAttributes, CMSObject.setAttribute, CMSObject.setAttributes
      fileContentMethods CMSSession.getFile, CMSSession.putFile
      fileMappingMethods CMSSession.getFileMappingEntry, CMSSession.putFileMapping Entry
      deleteObjectMethods CMSObject.deleteObject
      moveObjectMethods CMSObject.moveObject
      searchMethods CMSObject.search
      childTraversalMethods CMSObject.getChildren
      parentTraversalMethods CMSObject.getParents
      versionTraversalMethods CMSObject.getVersions
      burstConfigMethods CMSSession.getBurstUseroverride, CMSSession.getDefaultCreateInfo, CMSSession.getGraphicCreateInfo, CMSSession.getObjectReuse, CMSSession.getRangeCreateInfo
      Returns:
      One of the CMSSession.OPERATION_ constants which indicates whether the operation is enabled in the current state.
      Throws:
      CMSException - UNIMP_ERR: Raised if the adapter does not implement this method. In that case, the caller may assume that the operation is enabled.
      Since:
      Arbortext 5.4