Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBPrivilege

java.lang.Object
  |
  +--com.ibm.mm.beans.CMBPrivilege
All Implemented Interfaces:
java.io.Serializable

public class CMBPrivilege
extends java.lang.Object
implements java.io.Serializable

This is the helper class for the CMBDataManagement bean. This class provides function for checking privileges of data item.

Since:
6.1
See Also:
CMBDataManagement, Serialized Form

Field Summary
static int CMB_PRIV_ADD_CONTENT
          Doc privilege to add pages to a document.
static int CMB_PRIV_ADD_ITEM
          Server privilege to create a new item in the server.
static int CMB_PRIV_ADD_REMOTE_REFERENCE
          Store reference in alternate server.
static int CMB_PRIV_ADD_TO_FOLDER
          Folder privilege to add an item to a folder.
static int CMB_PRIV_ADD_TO_WB
          Server privilege to add an item to a workbasket.
static int CMB_PRIV_ADD_TO_WF
          Server privilege to add an item to a workflow.
static int CMB_PRIV_ADD_TO_WP
          Server privilege to add an item to a work process.
static int CMB_PRIV_CHECK_INOUT
          ItemBase privilege to check-out and check-in an item.
static int CMB_PRIV_CLIP_CONTENT
          Doc privilege to change a document by cliping the image in one or more pages in the document.
static int CMB_PRIV_COMPLETE_WF
          Server privilege to complete an item's workflow.
static int CMB_PRIV_CREATE_ANNOTATION
          Doc privilege to create annotations.
static int CMB_PRIV_CREATE_PERMANENT_ANNOTATION
          Doc privilege to make annotation a permanent part of image - i.e.
static int CMB_PRIV_DELETE_ANNOTATION
          Doc privilege to delete annotations, combined with the other edit and view annotation privileges.
static int CMB_PRIV_DELETE_CONTENT
          Doc privilege to remove a page from a document.
static int CMB_PRIV_DELETE_ITEM
          ItemBase privilege to delete an item from the server.
static int CMB_PRIV_EDIT_ATTRIBUTE
          ItemBase privilege to modify Attribute values.
static int CMB_PRIV_EDIT_AUDIO_ANNOTATION
          Doc privilege to change audio annotations.
static int CMB_PRIV_EDIT_IMAGE_ANNOTATION
          Doc privilege to change bitmap annotations.
static int CMB_PRIV_EDIT_OUTLINE_ANNOTATION
          Doc privilege to change line and highlight annotations (Line, arrow, box, circle, color highlight).
static int CMB_PRIV_EDIT_REDACTION
          Doc privilege to change redaction annotations.
static int CMB_PRIV_EDIT_STAMP_ANNOTATION
          Doc privilege to change stamp annotations.
static int CMB_PRIV_EDIT_TEXT_ANNOTATION
          Doc privilege to change textual annotations (Sticky notes, text, pen).
static int CMB_PRIV_EDIT_VIDEO_ANNOTATION
          Doc privilege to change video annotations.
static int CMB_PRIV_EXPORT
          ItemBase privilege to make an external copy of the item.
static int CMB_PRIV_FAX
          Doc privilege to fax the item (document, folder, process, etc).
static int CMB_PRIV_IMPORT
          User privilege, the client program should allow the user to create new documents from external sources.
static int CMB_PRIV_LIST_WORKLIST
          List Worklists (i.e.
static int CMB_PRIV_MODIFY_CONTENT
          Doc privilege to modify an image, reorder pages, rotate pages, add or delete pages.
static int CMB_PRIV_MODIFY_MULTI_ANNOTATION
          Server privilege to allow creating, deleting and modifying one or more Annotation objects.
static int CMB_PRIV_MODIFY_MULTI_BASEDOC
          Server privilege to allow creating, deleting and modifying one or more BaseDoc objects.
static int CMB_PRIV_MODIFY_MULTI_NOTE
          Server privilege to allow creating, deleting and modifying one or more Note objects.
static int CMB_PRIV_MODIFY_MULTI_OTHER
          Server privilege to allow creating, deleting and modifying one or more OtherObjects objects.
static int CMB_PRIV_MODIFY_MULTI_RESOURCE
          Server privilege to allow creating, deleting and modifying one or more Resource objects.
static int CMB_PRIV_MODIFY_MULTI_VIEWDATA
          Server privilege to allow creating, deleting and modifying one or more ViewData objects.
static int CMB_PRIV_MODIFY_SINGLE_ANNOTATION
          Server privilege to allow creating, deleting and modifying a single Annotation object.
static int CMB_PRIV_MODIFY_SINGLE_BASEDOC
          Server privilege to allow creating, deleting and modifying a single BaseDoc object.
static int CMB_PRIV_MODIFY_SINGLE_NOTE
          Server privilege to allow creating, deleting and modifying a single Note object.
static int CMB_PRIV_MODIFY_SINGLE_OTHER
          Server privilege to allow creating, deleting and modifying a single OtherObjects object.
static int CMB_PRIV_MODIFY_SINGLE_RESOURCE
          Server privilege to allow creating, deleting and modifying a single Resource object.
static int CMB_PRIV_MODIFY_SINGLE_VIEWDATA
          Server privilege to allow creating, deleting and modifying a single ViewData object.
static short CMB_PRIV_NO
           
static int CMB_PRIV_PRINT
          Doc privilege to print the item (document, folder, process, etc).
static int CMB_PRIV_READ_WB
          Read list (i.e.
static int CMB_PRIV_REMOVE
          Folder privilege to remove an item from a folder.
static int CMB_PRIV_REMOVE_FROM_WB
          Server privilege to remove an item from a workbasket.
static int CMB_PRIV_REMOVE_FROM_WF
          Server privilege to remove item from a workflow.
static int CMB_PRIV_SAVE_ROTATE
          Doc privilege to change a document by rotating the image in one or more pages.
static int CMB_PRIV_SCAN
          User privilege, the client program should allow the user to create new documents from scanned input.
static int CMB_PRIV_SEARCH
          ItemBase privilege to access a document and look at the keyfields.
static short CMB_PRIV_UNKNOWN
           
static int CMB_PRIV_VIEW_ANNOTATION
          Doc privilege to view annotations or 'beneath redaction' (This should probably be an 'ored' list with individual values for each 'type' of annotation or redaction).
static int CMB_PRIV_VIEW_AUDIO_ANNOTATION
          Doc privilege to access audio annotations.
static int CMB_PRIV_VIEW_CONTENT
          Doc privilege to view the item (document, process, etc).
static int CMB_PRIV_VIEW_FOLDER
          Folder privilege to view the contents of a folder.
static int CMB_PRIV_VIEW_HISTORY
          Doc privilege to view the note object in a document (or the history).
static int CMB_PRIV_VIEW_IMAGE_ANNOTATION
          Doc privilege to display bitmap annotations.
static int CMB_PRIV_VIEW_OUTLINE_ANNOTATION
          Doc privilege to display line and highlight annotations (Line, arrow, box, circle, highlight).
static int CMB_PRIV_VIEW_REDACTION
          Doc privilege to display redaction annotations.
static int CMB_PRIV_VIEW_STAMP_ANNOTATION
          Doc privilege to display stamp annotations.
static int CMB_PRIV_VIEW_TEXT_ANNOTATION
          Doc privilege to display textual annotations (Sticky notes, text, pen).
static int CMB_PRIV_VIEW_VIDEO_ANNOTATION
          Doc privilege to present video annotations.
static int CMB_PRIV_WRITE_WB
          Write list (i.e.
static short CMB_PRIV_YES
           
 
Method Summary
 short checkAuthorization(int index)
          Checks authorization of a given privilege.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CMB_PRIV_VIEW_CONTENT

public static final int CMB_PRIV_VIEW_CONTENT
Doc privilege to view the item (document, process, etc).

CMB_PRIV_PRINT

public static final int CMB_PRIV_PRINT
Doc privilege to print the item (document, folder, process, etc).

CMB_PRIV_FAX

public static final int CMB_PRIV_FAX
Doc privilege to fax the item (document, folder, process, etc).

CMB_PRIV_ADD_CONTENT

public static final int CMB_PRIV_ADD_CONTENT
Doc privilege to add pages to a document. It is up to client programs to enforce this privilege properly. This privilege is seperate from modifying or deleting part of a document..

CMB_PRIV_DELETE_CONTENT

public static final int CMB_PRIV_DELETE_CONTENT
Doc privilege to remove a page from a document. This is enforced by client programs, servers only know that the objects have changed, not that a page was deleted.

CMB_PRIV_MODIFY_CONTENT

public static final int CMB_PRIV_MODIFY_CONTENT
Doc privilege to modify an image, reorder pages, rotate pages, add or delete pages.

CMB_PRIV_VIEW_ANNOTATION

public static final int CMB_PRIV_VIEW_ANNOTATION
Doc privilege to view annotations or 'beneath redaction' (This should probably be an 'ored' list with individual values for each 'type' of annotation or redaction).

CMB_PRIV_CREATE_ANNOTATION

public static final int CMB_PRIV_CREATE_ANNOTATION
Doc privilege to create annotations. This should probably be an 'ored' list with individual values for each 'type' of annotation or redaction.

CMB_PRIV_CREATE_PERMANENT_ANNOTATION

public static final int CMB_PRIV_CREATE_PERMANENT_ANNOTATION
Doc privilege to make annotation a permanent part of image - i.e. modify image.

CMB_PRIV_EDIT_OUTLINE_ANNOTATION

public static final int CMB_PRIV_EDIT_OUTLINE_ANNOTATION
Doc privilege to change line and highlight annotations (Line, arrow, box, circle, color highlight).

CMB_PRIV_EDIT_TEXT_ANNOTATION

public static final int CMB_PRIV_EDIT_TEXT_ANNOTATION
Doc privilege to change textual annotations (Sticky notes, text, pen).

CMB_PRIV_EDIT_STAMP_ANNOTATION

public static final int CMB_PRIV_EDIT_STAMP_ANNOTATION
Doc privilege to change stamp annotations.

CMB_PRIV_EDIT_IMAGE_ANNOTATION

public static final int CMB_PRIV_EDIT_IMAGE_ANNOTATION
Doc privilege to change bitmap annotations.

CMB_PRIV_EDIT_REDACTION

public static final int CMB_PRIV_EDIT_REDACTION
Doc privilege to change redaction annotations.

CMB_PRIV_EDIT_AUDIO_ANNOTATION

public static final int CMB_PRIV_EDIT_AUDIO_ANNOTATION
Doc privilege to change audio annotations.

CMB_PRIV_EDIT_VIDEO_ANNOTATION

public static final int CMB_PRIV_EDIT_VIDEO_ANNOTATION
Doc privilege to change video annotations.

CMB_PRIV_VIEW_OUTLINE_ANNOTATION

public static final int CMB_PRIV_VIEW_OUTLINE_ANNOTATION
Doc privilege to display line and highlight annotations (Line, arrow, box, circle, highlight).

CMB_PRIV_VIEW_TEXT_ANNOTATION

public static final int CMB_PRIV_VIEW_TEXT_ANNOTATION
Doc privilege to display textual annotations (Sticky notes, text, pen).

CMB_PRIV_VIEW_STAMP_ANNOTATION

public static final int CMB_PRIV_VIEW_STAMP_ANNOTATION
Doc privilege to display stamp annotations.

CMB_PRIV_VIEW_IMAGE_ANNOTATION

public static final int CMB_PRIV_VIEW_IMAGE_ANNOTATION
Doc privilege to display bitmap annotations.

CMB_PRIV_VIEW_REDACTION

public static final int CMB_PRIV_VIEW_REDACTION
Doc privilege to display redaction annotations.

CMB_PRIV_VIEW_AUDIO_ANNOTATION

public static final int CMB_PRIV_VIEW_AUDIO_ANNOTATION
Doc privilege to access audio annotations.

CMB_PRIV_VIEW_VIDEO_ANNOTATION

public static final int CMB_PRIV_VIEW_VIDEO_ANNOTATION
Doc privilege to present video annotations.

CMB_PRIV_CLIP_CONTENT

public static final int CMB_PRIV_CLIP_CONTENT
Doc privilege to change a document by cliping the image in one or more pages in the document. The server can not enforce this privilege, it is up to client programs.

CMB_PRIV_SAVE_ROTATE

public static final int CMB_PRIV_SAVE_ROTATE
Doc privilege to change a document by rotating the image in one or more pages. The server can not enforce this privilege, it is up to client programs.

CMB_PRIV_VIEW_FOLDER

public static final int CMB_PRIV_VIEW_FOLDER
Folder privilege to view the contents of a folder.

CMB_PRIV_DELETE_ITEM

public static final int CMB_PRIV_DELETE_ITEM
ItemBase privilege to delete an item from the server.

CMB_PRIV_ADD_ITEM

public static final int CMB_PRIV_ADD_ITEM
Server privilege to create a new item in the server.

CMB_PRIV_EXPORT

public static final int CMB_PRIV_EXPORT
ItemBase privilege to make an external copy of the item. The server can not enforce this privilege, it is up to client programs.

CMB_PRIV_SEARCH

public static final int CMB_PRIV_SEARCH
ItemBase privilege to access a document and look at the keyfields. Servers should only return documents that a user can search for and Read the keyfields. Otherwise, it is up to the client application to hide the fields and content of the document or folder.

CMB_PRIV_EDIT_ATTRIBUTE

public static final int CMB_PRIV_EDIT_ATTRIBUTE
ItemBase privilege to modify Attribute values. The Attributes in each Entity will have an additional setting as to whether or not each individual Attribute can be modified.

CMB_PRIV_CHECK_INOUT

public static final int CMB_PRIV_CHECK_INOUT
ItemBase privilege to check-out and check-in an item. When an item is checked-out, the server does not let anyone else check-out the item. Durring check-in any changes to the item are saved in the server. After check-in, others can check-out the item.

CMB_PRIV_ADD_TO_WF

public static final int CMB_PRIV_ADD_TO_WF
Server privilege to add an item to a workflow.

CMB_PRIV_REMOVE_FROM_WF

public static final int CMB_PRIV_REMOVE_FROM_WF
Server privilege to remove item from a workflow.

CMB_PRIV_COMPLETE_WF

public static final int CMB_PRIV_COMPLETE_WF
Server privilege to complete an item's workflow.

CMB_PRIV_ADD_TO_WP

public static final int CMB_PRIV_ADD_TO_WP
Server privilege to add an item to a work process.

CMB_PRIV_ADD_TO_FOLDER

public static final int CMB_PRIV_ADD_TO_FOLDER
Folder privilege to add an item to a folder.

CMB_PRIV_REMOVE

public static final int CMB_PRIV_REMOVE
Folder privilege to remove an item from a folder.

CMB_PRIV_ADD_REMOTE_REFERENCE

public static final int CMB_PRIV_ADD_REMOTE_REFERENCE
Store reference in alternate server.

CMB_PRIV_VIEW_HISTORY

public static final int CMB_PRIV_VIEW_HISTORY
Doc privilege to view the note object in a document (or the history).

CMB_PRIV_ADD_TO_WB

public static final int CMB_PRIV_ADD_TO_WB
Server privilege to add an item to a workbasket.

CMB_PRIV_REMOVE_FROM_WB

public static final int CMB_PRIV_REMOVE_FROM_WB
Server privilege to remove an item from a workbasket.

CMB_PRIV_READ_WB

public static final int CMB_PRIV_READ_WB
Read list (i.e. a list of workbaskets from which user can read).

CMB_PRIV_WRITE_WB

public static final int CMB_PRIV_WRITE_WB
Write list (i.e. a list of workbaskets to which user can write).

CMB_PRIV_LIST_WORKLIST

public static final int CMB_PRIV_LIST_WORKLIST
List Worklists (i.e. enable menu support for worklists).

CMB_PRIV_SCAN

public static final int CMB_PRIV_SCAN
User privilege, the client program should allow the user to create new documents from scanned input.

CMB_PRIV_IMPORT

public static final int CMB_PRIV_IMPORT
User privilege, the client program should allow the user to create new documents from external sources.

CMB_PRIV_MODIFY_SINGLE_ANNOTATION

public static final int CMB_PRIV_MODIFY_SINGLE_ANNOTATION
Server privilege to allow creating, deleting and modifying a single Annotation object. Additional privileges may apply, this privilege reflects the capability of the server. In particular, applications should also check the following privileges:

CMB_PRIV_MODIFY_MULTI_ANNOTATION

public static final int CMB_PRIV_MODIFY_MULTI_ANNOTATION
Server privilege to allow creating, deleting and modifying one or more Annotation objects. Additional privileges may apply, this privilege reflects the capability of the server. In particular, applications should also check the following privileges:

CMB_PRIV_MODIFY_SINGLE_BASEDOC

public static final int CMB_PRIV_MODIFY_SINGLE_BASEDOC
Server privilege to allow creating, deleting and modifying a single BaseDoc object. Additional privileges may apply, this privilege reflects the capability of the server. In particular, applications should also check the following privileges:

CMB_PRIV_MODIFY_MULTI_BASEDOC

public static final int CMB_PRIV_MODIFY_MULTI_BASEDOC
Server privilege to allow creating, deleting and modifying one or more BaseDoc objects. Additional privileges may apply, this privilege reflects the capability of the server. In particular, applications should also check the following privileges:

CMB_PRIV_MODIFY_SINGLE_NOTE

public static final int CMB_PRIV_MODIFY_SINGLE_NOTE
Server privilege to allow creating, deleting and modifying a single Note object. Additional privileges may apply, this privilege reflects the capability of the server. In particular, applications should also check the following privileges:

CMB_PRIV_MODIFY_MULTI_NOTE

public static final int CMB_PRIV_MODIFY_MULTI_NOTE
Server privilege to allow creating, deleting and modifying one or more Note objects. Additional privileges may apply, this privilege reflects the capability of the server. In particular, applications should also check the following privileges:

CMB_PRIV_MODIFY_SINGLE_OTHER

public static final int CMB_PRIV_MODIFY_SINGLE_OTHER
Server privilege to allow creating, deleting and modifying a single OtherObjects object. Additional privileges may apply, this privilege reflects the capability of the server.

CMB_PRIV_MODIFY_MULTI_OTHER

public static final int CMB_PRIV_MODIFY_MULTI_OTHER
Server privilege to allow creating, deleting and modifying one or more OtherObjects objects. Additional privileges may apply, this privilege reflects the capability of the server.

CMB_PRIV_MODIFY_SINGLE_RESOURCE

public static final int CMB_PRIV_MODIFY_SINGLE_RESOURCE
Server privilege to allow creating, deleting and modifying a single Resource object. Additional privileges may apply, this privilege reflects the capability of the server.

CMB_PRIV_MODIFY_MULTI_RESOURCE

public static final int CMB_PRIV_MODIFY_MULTI_RESOURCE
Server privilege to allow creating, deleting and modifying one or more Resource objects. Additional privileges may apply, this privilege reflects the capability of the server.

CMB_PRIV_MODIFY_SINGLE_VIEWDATA

public static final int CMB_PRIV_MODIFY_SINGLE_VIEWDATA
Server privilege to allow creating, deleting and modifying a single ViewData object. Additional privileges may apply, this privilege reflects the capability of the server.

CMB_PRIV_MODIFY_MULTI_VIEWDATA

public static final int CMB_PRIV_MODIFY_MULTI_VIEWDATA
Server privilege to allow creating, deleting and modifying one or more ViewData objects. Additional privileges may apply, this privilege reflects the capability of the server.

CMB_PRIV_DELETE_ANNOTATION

public static final int CMB_PRIV_DELETE_ANNOTATION
Doc privilege to delete annotations, combined with the other edit and view annotation privileges.

CMB_PRIV_YES

public static final short CMB_PRIV_YES

CMB_PRIV_NO

public static final short CMB_PRIV_NO

CMB_PRIV_UNKNOWN

public static final short CMB_PRIV_UNKNOWN
Method Detail

checkAuthorization

public short checkAuthorization(int index)
                         throws java.lang.Exception
Checks authorization of a given privilege.
Parameters:
index - privilege index
Returns:
a short value of the authorization of the privilege index. It could be one of the following values:
  • CMB_PRIV_NO: not authorized
  • CMB_PRIV_YES: is authorized
  • CMB_PRIV_UNKNOWN: authorization of this privilege index is unknown.

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.