Package com.arbortext.epic.cms

Interface CMSObject

All Known Implementing Classes:
CMSObjectImpl
public interface CMSObject
The CMSObject interface represents a reference to a content management system (CMS) object. If a document references the same child object twice then there will be two different references to that same child CMS object. Each reference will have its own distinct CMSObject object that can have different properties from the other. For example, the start and end properties would be different for each.
Since:
Epic 5.2

  • Field Details

    • CMS_SAVE_OBJECT_ATTR

      static final int CMS_SAVE_OBJECT_ATTR
      Indicates to save the attributes.
      Will force the adapter to commit any pending attribute changes for this object into the CMS.
      See Also:

    • CMS_SAVE_OBJECT_CONTENT

      static final int CMS_SAVE_OBJECT_CONTENT
      Indicates to save the object's content into the CMS.
      See Also:

    • CMS_SAVE_OBJECT_DECLS

      static final int CMS_SAVE_OBJECT_DECLS
      Indicates to save the XML/SGML declarations.
      For adapters which do not support the separate saving of declarations, just include this along with the CMS_SAVE_OBJECT_CONTENT bit since the declarations will be saved with the content.
      See Also:

    • CMS_SAVE_OBJECT_NO_PI

      static final int CMS_SAVE_OBJECT_NO_PI
      Do not save processing instructions (PIs).
      See Also:

    • CMS_SAVE_OBJECT_CHILDREN

      static final int CMS_SAVE_OBJECT_CHILDREN
      Indicates to save the object's children (recursively) when the object is saved.
      See Also:

    • CMS_LOCK_FORCE

      static final int CMS_LOCK_FORCE
      Break existing locks (if supported).
      See Also:

    • CMSOBJECT_CLASS_UNKNOWN

      static final int CMSOBJECT_CLASS_UNKNOWN
      The class type is unknown.
      See Also:

    • CMSOBJECT_CLASS_CONTAINER

      static final int CMSOBJECT_CLASS_CONTAINER
      The class type is a virtual document object with children.
      See Also:

    • CMSOBJECT_CLASS_LEAF

      static final int CMSOBJECT_CLASS_LEAF
      The class type is a virtual document object with no children.
      See Also:

    • CMSOBJECT_CLASS_EXPANDED_FILE_ENTITY

      static final int CMSOBJECT_CLASS_EXPANDED_FILE_ENTITY
      The class type is an expanded file entity.
      See Also:

    • CMSOBJECT_CLASS_UNEXPANDED_FILE_ENTITY

      static final int CMSOBJECT_CLASS_UNEXPANDED_FILE_ENTITY
      The class type is an unexpanded file entity.
      See Also:

    • CMSOBJECT_CLASS_FILE_ENTITY_WINDOW

      static final int CMSOBJECT_CLASS_FILE_ENTITY_WINDOW
      The class type is a file entity open for editing in a separate window.
      See Also:

    • CMSOBJECT_CLASS_INCLUDE

      static final int CMSOBJECT_CLASS_INCLUDE
      The class type is an included object (via XInclude).
      See Also:

    • CMSOBJECT_CLASS_FALLBACK

      static final int CMSOBJECT_CLASS_FALLBACK
      The class type is fallback markup for an XInclude that could not be expanded.
      See Also:

    • CMSOBJECT_STATUS_UNLOCKED

      static final int CMSOBJECT_STATUS_UNLOCKED
      Indicates that this object is not locked or checked out by any user.
      See Also:

    • CMSOBJECT_STATUS_LOCKED_BY_ME

      static final int CMSOBJECT_STATUS_LOCKED_BY_ME
      Indicates that this object is locked or checked out by the current user.
      See Also:

    • CMSOBJECT_STATUS_LOCKED_BY_OTHER

      static final int CMSOBJECT_STATUS_LOCKED_BY_OTHER
      Indicates that this object is locked or checked out by another user.
      See Also:

    • CMS_BURST_SET_METADATA

      static final int CMS_BURST_SET_METADATA
      Indicates that, in addition to possibly creating new child objects via bursting, metadata on the object should be set according to the rules in the applicable burst configuration file.
      See Also:

  • Method Details

    • getObjectClass

      int getObjectClass() throws CMSException
      Specifies the class of the CMS object. The value is one of the CMSObjectClassType enumerated constants.
      Throws:
      CMSException - Raised for any error accessing this attribute.

    • getStart

      Node getStart() throws CMSException
      Specifies the first DOM Node associated with the object reference. You can reference a given CMS object in multiple places in either a single document or multiple documents. See the allReferences attribute for more details.
      This may be null if this object reference is not currently associated with any DOM Nodes. For example, this could represent a folder object or an object whose content has not yet been loaded into a document.
      Throws:
      CMSException - Raised for any error accessing this attribute.

    • getEnd

      Node getEnd() throws CMSException
      Specifies the last DOM Node associated with the object reference. You can reference a given CMS object in multiple places in either a single document or multiple documents. See allReferences for more details.
      This may be null if this object reference is not currently associated with any DOM Nodes. For example, this could represent a folder object or an object whose content has not yet been loaded into a document.
      Throws:
      CMSException - Raised for any error accessing this attribute.

    • getModified

      boolean getModified() throws CMSException
      Will be true if the object's content has been modified in memory and has not yet been saved.
      Throws:
      CMSException - Raised for any error accessing this attribute.

    • getReadOnly

      boolean getReadOnly() throws CMSException
      Indicates whether the object's content is read-only. Note that this is independent of whether the current user has this object checked out because some adapter's may allow for such a combination.
      Throws:
      CMSException - Raised for any error.

    • getLockStatus

      int getLockStatus() throws CMSException
      Specifies the lock status of this CMS object. The value is one of the CMSObjectLockStatusType enumerated constants.
      Throws:
      CMSException - Raised for any error.

    • getLockable

      boolean getLockable() throws CMSException
      Indicates whether the current user can attempt to lock the object. For example, if another user has the object checked out, this attribute should be false.
      A true value is not a guarantee that a checkout will succeed since, for example, another user could have checked this out in the mean time.
      Throws:
      CMSException - Raised for any error.

    • getLockOwner

      String getLockOwner() throws CMSException
      Specifies the CMS user name that currently holds the lock. Returns an empty string if the object is not locked.
      Throws:
      CMSException - Raised for any error.

    • getLockStatusDisplay

      String getLockStatusDisplay() throws CMSException
      Specifies a human-readable string describing the lock status. For example, the value of this attribute could be "locked", "unlocked", and so forth. The returned string can be displayed in the user interface and should be localized.
      Throws:
      CMSException - Raised for any error accessing this attribute.

    • getSession

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

    • getName

      String getName() throws CMSException
      Specifies the name of object. This is normally a human-readable name and is used primarily for display purposes.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setName

      void setName(String name) throws CMSException
      Specifies the name of object. This is normally a human-readable name and is used primarily for display purposes.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getPermission

      String getPermission() throws CMSException
      Specifies the permissions associated with the object in a human-readable string. The format of the string is adapter-specific and is for display purposes only.
      Throws:
      CMSException - Raised for any error.

    • getCreationDate

      String getCreationDate() throws CMSException
      Specifies the object's creation date in an adapter-specific human-readable form.
      Throws:
      CMSException - Raised for any error.

    • getModificationDate

      String getModificationDate() throws CMSException
      Specifies the object's last modification date in an adapter-specific human-readable form.
      Throws:
      CMSException - Raised for any error.

    • getVersion

      String getVersion() throws CMSException
      Specifies the CMS version ID of the object in an adapter-specific format. This is for display purposes only.
      Throws:
      CMSException - Raised for any error.

    • getInstanceDoctypeName

      String getInstanceDoctypeName() throws CMSException
      Specifies the object's instance document type name. If the object's content contains a document type declaration such as...
      <!DOCTYPE book PUBLIC "-//Arbortext//DTD DocBook XML V4.0//EN" "axdocbook.dtd">
      then this attribute would represent the string book. Note that this value has nothing to do with the DTD or Schema associated with this object.
      Some XML instances do not contain a document type declaration and so this value would be an empty string.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setInstanceDoctypeName

      void setInstanceDoctypeName(String instanceDoctypeName) throws CMSException
      Specifies the object's instance document type name. If the object's content contains a document type declaration such as...
      <!DOCTYPE book PUBLIC "-//Arbortext//DTD DocBook XML V4.0//EN" "axdocbook.dtd">
      then this attribute would represent the string book. Note that this value has nothing to do with the DTD or Schema associated with this object.
      Some XML instances do not contain a document type declaration and so this value would be an empty string.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getPublicId

      String getPublicId() throws CMSException
      Specifies the Public ID of the object's DTD or Schema.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setPublicId

      void setPublicId(String publicId) throws CMSException
      Specifies the Public ID of the object's DTD or Schema.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getSystemId

      String getSystemId() throws CMSException
      Specifies the System ID of the object's DTD or Schema.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setSystemId

      void setSystemId(String systemId) throws CMSException
      Specifies the System ID of the object's DTD or Schema.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getEncoding

      String getEncoding() throws CMSException
      Specifies the character encoding of the object's content.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setEncoding

      void setEncoding(String encoding) throws CMSException
      Specifies the character encoding of the object's content.
      For most adapters, this attribute would only be available if the object was currently loaded.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getContentType

      String getContentType() throws CMSException
      Specifies the type of the object's content.
      For non-graphics, this may be one of the following values:
      • xml
      • sgml
      • html
      • text
      • ascii

      For graphics and non-markup documents, this will be a file extension ("bmp", "gif", "jpg", "svg", "doc", etc.).
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setContentType

      void setContentType(String contentType) throws CMSException
      Specifies the type of the object's content.
      For non-graphics, this may be one of the following values:
      • xml
      • sgml
      • html
      • text
      • ascii

      For graphics and non-markup documents, this will be a file extension ("bmp", "gif", "jpg", "svg", "doc", etc.).
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getTagName

      String getTagName() throws CMSException
      Specifies the tag name for the top-level element in the object. The value is blank for objects with unstructured content.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setTagName

      void setTagName(String tagName) throws CMSException
      Specifies the tag name for the top-level element in the object. The value is blank for objects with unstructured content.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getIsVirtualDocContainer

      boolean getIsVirtualDocContainer() throws CMSException
      Indicates whether the object contains references to child objects which are virtual document objects. Objects that reference all of their children using file entities, XIncludes, and graphic tags are not virtual document containers.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setIsVirtualDocContainer

      void setIsVirtualDocContainer(boolean isVirtualDocContainer) throws CMSException
      Indicates whether the object contains references to child objects which are virtual document objects. Objects that reference all of their children using file entities, XIncludes, and graphic tags are not virtual document containers.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getHasChildRefs

      boolean getHasChildRefs() throws CMSException
      Specifies whether non-folder objects have any child object references.
      A true value suggests that the getChildren method can safely be called to enumerate the children.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setHasChildRefs

      void setHasChildRefs(boolean hasChildRefs) throws CMSException
      Specifies whether non-folder objects have any child object references.
      A true value suggests that the getChildren method can safely be called to enumerate the children.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getIsLatestVersion

      boolean getIsLatestVersion() throws CMSException
      Indicates whether this version is the most recent version of the object on a particular CMS branch.
      Throws:
      CMSException - Raised for any error.

    • getSize

      int getSize() throws CMSException
      Specifies the size of the object content in bytes. This is optional and some adapters may choose to not implement it.
      Throws:
      CMSException - Raised for any error.

    • getFullTextIndexed

      boolean getFullTextIndexed() throws CMSException
      Indicates whether the document is marked for full text indexing.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • setFullTextIndexed

      void setFullTextIndexed(boolean fullTextIndexed) throws CMSException
      Indicates whether the document is marked for full text indexing.
      Throws:
      CMSException - Raised for any error.
      CMSException - Raised for any error.

    • getPoid

      String getPoid() throws CMSException
      Specifies the Persistent Object Identifier (POID) associated with the object. This is different from a Logical ID, which can represent different versions of an object over time. For example, the Logical ID could represent the "LATEST" version of the object. The POID always references the same version of the object. An application programmer seldom needs to use a POID. Instead, they should mainly use the logicalId attribute.
      Throws:
      CMSException - Raised for any error accessing this attribute.

    • getLogicalId

      String getLogicalId() throws CMSException
      Specifies the Logical ID of the object used for external binding. A Logical ID identifies a class of objects, any one of which may be selected at any given time. For example, a Logical ID can identify a specific version of a specific CMS object (fixed reference) or the current version (floating reference). Logical IDs are valid across sessions, and are stored inside structured documents. At any time, you can translate a Logical ID into a POID that identifies a specific version of a specific object.
      Throws:
      CMSException - Raised for any error.

    • getCmsObjectType

      String getCmsObjectType() throws CMSException
      Specifies the name of the CMS object type.
      Throws:
      CMSException - Raised for any error.

    • getComment

      String getComment() throws CMSException
      Specifies the check in or check out comment for the object.
      There is currently no standard way of setting the comment for an object. This must be handled in an adapter-specific way.
      Throws:
      CMSException - Raised for any error.

    • getCmsPathName

      String getCmsPathName() throws CMSException
      Specifies the path name of object in the CMS. If the object exists in multiple folders, any one of the folder paths could be returned.
      Throws:
      CMSException - Raised for any error.

    • getIsFolder

      boolean getIsFolder() throws CMSException
      Indicates whether the object is a folder or folder subtype.
      Throws:
      CMSException - Raised for any error.

    • getAclId

      int getAclId()
      Specifies the dobj ID equivalent to this CMSObject object. You can use this ID with the Arbortext Command Language (ACL) programming language. If this object is no longer valid, the attribute value will be 0 (an invalid dobj ID).
      Each access returns a new dobj ID. The caller is responsible for calling the ACL dobj_close() function on each returned valid ID. Calling dobj_close() does not affect the original CMSObject or the IDs returned previously.

    • getEnclosingObject

      CMSObject getEnclosingObject() throws CMSException
      Specifies the object reference that encloses this particular CMS object reference. If this is a top level object, the value is null.
      For example, if the user inserts reference to a "chapter" object into a checked out "book" object (via File Entity or XInclude) then the enclosingObject for the "chapter" object reference would be the containing "book" object.
      Throws:
      CMSException - Raised for any error.

    • getAllReferences

      CMSObjectList getAllReferences() throws CMSException
      Returns a collection of all active object references to the same associated CMS object version.
      Each CMSObject represents a specific reference (or usage) of a CMS object. If a CMS object references (through File Entity or XInclude) the same child object twice in different parts of the document content, then each reference would have its own CMSObject object. Use the allReferences attribute to write application code that iterates over all open references to this CMS object. Note that the class attribute of each reference may be different.
      This attribute can return object references from multiple distinct documents.
      Throws:
      CMSException - Raised for any error.

    • getValid

      boolean getValid() throws CMSException
      Indicates whether this still represents a valid object reference. For example, if the associated session has been disconnected then this object reference is considered invalid.
      Throws:
      CMSException - Raised for any error.

    • burst

      CMSObject burst(int flags) throws CMSException
      Bursts the checked out object. The bursting process follows the established defaults and specific rules for the associated document type. If the object contains sibling (that is, more than one) top-level elements, it is not burst.
      Parameters:
      flags - Specifies how to burst the object. The value is determined through a bit-wise OR of the CMSBurstFlags constants.
      Returns:
      This object or, possibly, a new CMSObject which has been burst.
      Throws:
      CMSException - If an error occurs.

    • burst

      CMSObject burst() throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • save

      void save(int flags) throws CMSException
      Saves a CMS object without checking it in (interim save). The object remains checked out.
      Some adapters may support the saving of attributes for objects which are not checked out. See the CMS_SAVE_OBJECT_ATTR enumerated constant.
      Parameters:
      flags - Specifies how to save the object. The value is determined through a bit-wise OR of the CMSSaveFlags constants.
      Throws:
      CMSException - If an error occurs.

    • getAttribute

      String getAttribute(String attribute, int index) throws CMSException
      Reads the value of an attribute. Attributes are identified by name. If the attribute has more than one value, an index is used to identify which value to return.
      To get the values of multiple attributes, use the getAttributes method.
      Parameters:
      attribute - Specifies the attribute name.
      index - Specifies the repeating attribute index (zero-based).
      Returns:
      The attribute value.
      Throws:
      CMSException - Raised for any error.

    • getAttribute

      String getAttribute(String attribute) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • setAttribute

      void setAttribute(String attribute, String value, int index) throws CMSException
      Sets the value of an attribute. Attributes are identified by name.
      To set the values of multiple attributes, use the setAttributes method.
      Parameters:
      attribute - Specifies the attribute name.
      value - Specifies the attribute value.
      index - Specifies the repeating attribute index (zero-based).
      Throws:
      CMSException - Raised for any error.

    • setAttribute

      void setAttribute(String attribute, String value) throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • getAttributes

      PropertyMap getAttributes(StringList attributes) throws CMSException
      Gets the values for a list of attributes. Attributes with a single value are stored as String entries in the returned PropertyMap. Attributes with multiple values are stored as StringList entries.
      Parameters:
      attributes - Specifies the array of attributes to retrieve. If the value is null, all attributes are retrieved.If an adapter does not support a null value, it will throw a CMSException with a code value of UNIMP_ERR.
      Returns:
      A PropertyMap containing the requested attribute names and values.
      Throws:
      CMSException - Raised for any error.

    • getAttributes

      PropertyMap getAttributes() throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • setAttributes

      void setAttributes(PropertyMap attributeValues) throws CMSException
      Sets the values for a list of attributes. The calling function passes a PropertyMap containing entries for each of the attributes to be set. Attributes with a single value are stored as String entries in the PropertyMap. Attributes with multiple values are stored as StringList entries.
      Parameters:
      attributeValues - Specifies the PropertyMap containing attribute names and values.
      Throws:
      CMSException - Raised for any error.

    • checkout

      CMSObject checkout(int flags) throws CMSException
      Locks the CMS object for modification. If the CMS_LOCK_FORCE flag is set and the object is locked by another user, the object will be forcibly unlocked if the caller has that right.
      The exact semantics of this method are adapter-specific. For example, if a CMS does not support versioning then this may simply "lock" the object to prevent other users from editing it.
      Parameters:
      flags - Specifies the optional flags controlling the checkout. The value is determined through a bit-wise OR of CMSLockFlags constants.
      Returns:
      This object, or possibly a new CMSObject representing the working copy.
      Throws:
      CMSException - Raised for any error.

    • checkout

      CMSObject checkout() throws CMSException
      Method overload which omits the last parameter.
      Throws:
      CMSException

    • checkin

      CMSObject checkin() throws CMSException
      Checks the object in to the CMS. To properly update the revised object in the CMS, you must save the object before calling this method.
      Returns:
      This object, or possibly a new CMSObject representing the checked in object.
      Throws:
      CMSException - If an error occurs.

    • cancelCheckout

      CMSObject cancelCheckout() throws CMSException
      Unlocks the object in the CMS without updating it. The adapter can optionally return the previous version of the object.
      Returns:
      This object, or possibly a new CMSObject representing the previous version.
      Throws:
      CMSException - If an error occurs.

    • deleteObject

      void deleteObject() throws CMSException
      Deletes the object from the CMS. All versions of the object will be deleted. After calling this method, you can no longer use this CMSObject object.
      If the CMS supports referential integrity, this will fail if any of the deleted object versions are referenced as children of other objects.
      Throws:
      CMSException - If an error occurs.

    • move

      void move(CMSObject targetFolder) throws CMSException
      Moves the object to a new folder in the CMS.
      Parameters:
      targetFolder - Specifies the target folder object.
      Throws:
      CMSException - Raised for any error.

    • getChildren

      CMSBrowseIterator getChildren() throws CMSException
      Retrieves the contents of a folder or the children of a document object.
      Returns:
      The iterator over the object's children. The iterator returns CMSBrowseItem objects.
      Throws:
      CMSException - Raised for any error.

    • getParents

      CMSBrowseIterator getParents() throws CMSException
      Returns an iterator over the set of documents that reference this object.
      Returns:
      The iterator over the objects that reference the specified object. The iterator returns CMSBrowseItem objects.
      Throws:
      CMSException - Raised for any error.

    • getVersions

      CMSBrowseIterator getVersions() throws CMSException
      Returns an iterator over all versions of the object.
      Returns:
      An iterator over all versions of the object. The iterator returns CMSBrowseItem objects.
      Throws:
      CMSException - Raised for any error.

    • getUserData

      String getUserData(String key) throws CMSException
      Retrieves application data from the object. 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:
      The data associated with the given key, or null if there is none.
      Throws:
      CMSException - If an error occurs.

    • setUserData

      void setUserData(String key, String data) throws CMSException
      Stores some application data on the object. 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 object, that it can later retrieve by calling the getUserData method. User data only exists in memory and is not stored persistently.
      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 - If an error occurs.

    • setOldUserData

      void setOldUserData(String data)
      This method can be used to allow some properties and methods 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...
      • getChildren()
      • getParents()
      • getVersions()
      • save()
      • checkout()
      • checkin()
      • cancelCheckout()
      • deleteObject()
      • move()

      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 affect 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.

    • releaseReference

      void releaseReference()
      Releases this reference to the underlying repository object. After this call, most methods on this object will throw a CMSException with a code value of INVALID_CMSOBJECT_ERR. However, the valid attribute is always safe to access and will return false in this case.

    • 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.
      Since:
      Arbortext 5.3

    • createEvent

      Event createEvent(String eventType) throws CMSException
      Creates an event of type CMSObjectEvent.
      Parameters:
      eventType - Specifies the type of Event interface to be created. The only event module supported by this method is CMSObjectEvents. 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 CMSObjectPreCheckin event would call createEvent with the parameter "CMSObjectPreCheckin". The initCMSObjectEvent method could then be called on the newly created CMSObjectEvent to set the specific type of CMSObjectEvent 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