Package com.arbortext.epic.cms

Interface CMSBrowseItem

All Known Implementing Classes:
CMSBrowseItemImpl
public interface CMSBrowseItem
The CMSBrowseItem interface contains information returned from CMSBrowseIterator.getNext(). CMSBrowseItem objects are static and do not reflect changes made after the iterator was created.
Since:
Epic 5.2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CMS_ITEM_LOCKED_ME
    The object is locked or checked out by the current user.
    static final int
    CMS_ITEM_LOCKED_ME_CANT_EDIT
    The object is locked or checked out by the current user, but it cannot be edited.
    static final int
    CMS_ITEM_LOCKED_OTHER
    The object is locked or checked out by another user.
    static final int
    CMS_ITEM_LOCKED_OTHER_CANT_VIEW
    The object is locked or checked out by another user, and it cannot be accessed.
    static final int
    CMS_ITEM_LOCKED_UNKNOWN
    Cannot determine the lock status.
    static final int
    CMS_ITEM_NOT_LOCKED
    The object is not locked or checked out.
    static final int
    CMS_ITEM_NOT_LOCKED_CANT_LOCK
    The object is not locked or checked out, but it cannot be locked by the current user.
    static final int
    CMS_ITEM_TYPE_CONTAINER
    This constant can be combined with the CMS_ITEM_TYPE_DOC constant to indicate that the document object contains other objects.
    static final int
    CMS_ITEM_TYPE_DISABLED
    This constant can be combined with the IO_ITEM_TYPE_DOC and IO_ITEM_TYPE_GRAPHIC constants to indicate that the object should be “disabled”.
    static final int
    CMS_ITEM_TYPE_DOC
    This is a document object.
    static final int
    CMS_ITEM_TYPE_FOLDER
    This is a folder object.
    static final int
    CMS_ITEM_TYPE_GRAPHIC
    This is a graphic or other non-CMS object.
    static final int
    CMS_ITEM_TYPE_PART
    This is a part.
    static final int
    CMS_ITEM_TYPE_UNKNOWN
    This is an unknown object.

  • Method Summary

    Modifier and Type
    Method
    Description
    short
    getApplyOverlay()
    Specifies whether the CMS browser should apply its default icon overlay logic (the corresponding value is 1.) Overlay icons represent an object's lock status.
    String
    getDisplayIcon()
    Specifies the graphic icon used to represent this object instance in the Editor's CMS browser.
    String
    getFullPath()
    Specifies the adapter-specific full path name of the CMS object.
    short
    getItemType()
    Contains a bit mask of the CMSItemType constants.
    short
    getLockStatus()
    Contains one of the CMSLockStatus constants.
    String
    getLogicalId()
    Specifies the object's Logical ID.
    String
    getName()
    Specifies the human-readable object name.
    String
    getRevision()
    Specifies the object's content management system (CMS) version identifier.

  • Field Details

    • CMS_ITEM_TYPE_UNKNOWN

      static final int CMS_ITEM_TYPE_UNKNOWN
      This is an unknown object.
      See Also:

    • CMS_ITEM_TYPE_DOC

      static final int CMS_ITEM_TYPE_DOC
      This is a document object.
      See Also:

    • CMS_ITEM_TYPE_FOLDER

      static final int CMS_ITEM_TYPE_FOLDER
      This is a folder object.
      See Also:

    • CMS_ITEM_TYPE_CONTAINER

      static final int CMS_ITEM_TYPE_CONTAINER
      This constant can be combined with the CMS_ITEM_TYPE_DOC constant to indicate that the document object contains other objects.
      See Also:

    • CMS_ITEM_TYPE_GRAPHIC

      static final int CMS_ITEM_TYPE_GRAPHIC
      This is a graphic or other non-CMS object.
      See Also:

    • CMS_ITEM_TYPE_DISABLED

      static final int CMS_ITEM_TYPE_DISABLED
      This constant can be combined with the IO_ITEM_TYPE_DOC and IO_ITEM_TYPE_GRAPHIC constants to indicate that the object should be “disabled”. This should be used for objects which should not be constructed by the application.
      See Also:

    • CMS_ITEM_TYPE_PART

      static final int CMS_ITEM_TYPE_PART
      This is a part.
      See Also:

    • CMS_ITEM_LOCKED_UNKNOWN

      static final int CMS_ITEM_LOCKED_UNKNOWN
      Cannot determine the lock status.
      See Also:

    • CMS_ITEM_NOT_LOCKED

      static final int CMS_ITEM_NOT_LOCKED
      The object is not locked or checked out.
      See Also:

    • CMS_ITEM_NOT_LOCKED_CANT_LOCK

      static final int CMS_ITEM_NOT_LOCKED_CANT_LOCK
      The object is not locked or checked out, but it cannot be locked by the current user.
      See Also:

    • CMS_ITEM_LOCKED_ME

      static final int CMS_ITEM_LOCKED_ME
      The object is locked or checked out by the current user.
      See Also:

    • CMS_ITEM_LOCKED_ME_CANT_EDIT

      static final int CMS_ITEM_LOCKED_ME_CANT_EDIT
      The object is locked or checked out by the current user, but it cannot be edited. The object may have been checked out in a different context.
      See Also:

    • CMS_ITEM_LOCKED_OTHER

      static final int CMS_ITEM_LOCKED_OTHER
      The object is locked or checked out by another user.
      See Also:

    • CMS_ITEM_LOCKED_OTHER_CANT_VIEW

      static final int CMS_ITEM_LOCKED_OTHER_CANT_VIEW
      The object is locked or checked out by another user, and it cannot be accessed.
      See Also:

  • Method Details

    • getName

      String getName()
      Specifies the human-readable object name.

    • getLogicalId

      String getLogicalId()
      Specifies the object's Logical ID.

    • getRevision

      String getRevision()
      Specifies the object's content management system (CMS) version identifier. This attribute is optional and may contain an empty string.

    • getItemType

      short getItemType()
      Contains a bit mask of the CMSItemType constants.

    • getLockStatus

      short getLockStatus()
      Contains one of the CMSLockStatus constants.

    • getFullPath

      String getFullPath()
      Specifies the adapter-specific full path name of the CMS object. This attribute is optional and may contain an empty string.

    • getDisplayIcon

      String getDisplayIcon() throws CMSException
      Specifies the graphic icon used to represent this object instance in the Editor's CMS browser. The value is a relative pathname, and the standard search path is used. This attribute is optional and may contain an empty string.
      Throws:
      CMSException - UNIMPL_ERR: Raised if the adapter does not support this feature.
      Since:
      Arbortext 5.3

    • getApplyOverlay

      short getApplyOverlay() throws CMSException
      Specifies whether the CMS browser should apply its default icon overlay logic (the corresponding value is 1.) Overlay icons represent an object's lock status. A 0 value indicates that the display icon is a composite icon that includes a lock status icon. This attribute is optional. The default is 1. A 0 value is ignored when no displayIcon is provided.
      Throws:
      CMSException - NOT_IMPLEMENTED_ERR: Raised if the adapter does not support this feature.
      Since:
      Arbortext 5.3