Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.starteam
Class Permission

java.lang.Object
  extended by com.starteam.Permission

public final class Permission
extends java.lang.Object

This class defines all the different permission settings used by StarTeam. Note that for historical reasons, permission IDs may overlap. The correct choice of Permission actually depends on the context of the object (ISecurable/ISecurableContainer).

Field Summary
static Permission[] ALL
          The collection of all Permissions
static Permission ALL_PERMISSIONS
          All permissions.
static Permission COMPONENT_CREATE_FILTERS
          The right to create filters
static Permission COMPONENT_CREATE_QUERIES
          The right to create queries ID 0x00400000 is reused across multiple permissions
static Permission FILE_CHECKIN
          The right to check in a file.
static Permission FILE_CHECKOUT
          The right to check out a file.
static Permission GENERIC_AQUIRE_OWNERSHIP
          The right to acquire object ownership.
static Permission GENERIC_CHANGE_ACCESS_RIGHTS
          The right to change security settings of an object.
static Permission GENERIC_CREATE_NEW_OBJECT
          The right to create a new object and place it in the container.
static Permission GENERIC_DELETE_OBJECT
          The right to remove an object from a container (this will be required when an object is being moved from one container to another and may be required when the object is being deleted); this is equivalent to the right to delete (soft-delete) an object.
static Permission GENERIC_MODIFY_OBJECT
          The right to modify object properties (the extent of the right may differ from one object class to the next).
static Permission GENERIC_PURGE_OBJECT
          The right to purge (hard-delete) an object.
static Permission GENERIC_SEE_OBJECT
          The right to see an object and its properties (but not necessarily the physical contents).
static Permission ITEM_ADD_TO_REVISION_LABEL
          The right to add object to a revision label; ID 0x04000000 is reused across multiple permissions
static Permission ITEM_ADD_TO_VIEW_LABEL
          The right to add object to a view label;
static Permission ITEM_BREAK_EXCLUSIVE_LOCK
          The right to break an exclusive lock
static Permission ITEM_CREATE_LINKS
          The right to create links for the object.
static Permission ITEM_DELETE_LINKS
          The right to delete links for the object; ID 0x00080000 is reused across multiple permissions
static Permission ITEM_DETACH_FROM_REVISION_LABEL
          The right to exclude object from a revision label; ID 0x08000000 is reused across multiple permissions
static Permission ITEM_DETACH_FROM_VIEW_LABEL
          The right to exclude object from a view label; ID 0x00010000 is reused across multiple permissions
static Permission ITEM_LOCK_EXCLUSIVELY
          The right to set an exclusive lock
static Permission ITEM_MODIFY_BEHAVIOR
          The right to modify object behavior.
static Permission ITEM_MODIFY_LINKS
          The right to modify the links for an object.
static Permission ITEM_MOVE
          The right to move objects out of the folder (this right is important if the objects themselves are not protected by their own ACLs).
static Permission ITEM_PERFORM_MAINTENANCE
          The right to edit comments etc
static Permission ITEM_SEE_HISTORY
          The right to see object history (if it has any); ID 0x00001000 is reused across multiple permissions
static Permission ITEM_SEE_LINKS
          The right to see object links (if it has any);
static Permission ITEM_SHARE
          The right to share objects out of the folder (this right is important if the objects themselves are not protected by their own ACLs).
static Permission PROMOTION_STATE_MODIFY_STATUS
          The right to modify promotion status ID 0x00020000 is reused across multiple permissions
static Permission SERVER_ADD_COLLABORATION_USER
          The right to add new user to collaboration user group
static Permission SERVER_ADMIN_REMOTELY
          The right to administer server remotely ID 0x04000000 is reused across multiple permissions
static Permission SERVER_ADMIN_USER_ACCOUNTS
          The right to administer user accounts ID 0x08000000 is reused across multiple permissions
static Permission SERVER_ADMINISTER_COMPONENT_RIGHTS
          The right to administer component rights ID 0x00020000 is reused across multiple permissions
static Permission SERVER_CREATE_PROJECT
          The right to create projects ID 0x00010000 is reused across multiple permissions
static Permission SERVER_MODIFY_CONFIGURATION
          The right to modify server settings
static Permission SERVER_MODIFY_SCHEMA
          The right to add/modify property definitions of the objects in the components ID 0x00001000 is reused across multiple permissions
static Permission SERVER_MODIFY_SYSTEM_POLICY
          The right to modify system policy ID 0x02000000 is reused across multiple permissions
static Permission SERVER_REPLICATION_RIGHTS
          The right to allow user impersonation ID 0x00080000 is reused across multiple permissions
static Permission SERVER_VIEW_COMMAND_STATS
          The right to view server command statistics
static Permission SERVER_VIEW_CONFIGURATION
          The right to view server settings ID 0x00400000 is reused across multiple permissions
static Permission SERVER_VIEW_DIAGNOSTICS
          The right to view server diagnostics ID 0x00200000 is reused across multiple permissions
static Permission SERVER_VIEW_LOG
          The right to view server log ID 0x00100000 is reused across multiple permissions
static Permission SERVER_VIEW_SECURITY_LOG
          The right to view security log ID 0x10000000 is reused across multiple permissions
static Permission SERVER_VIEW_SYSTEM_POLICY
          The right to view system policy ID 0x01000000 is reused across multiple permissions
static Permission VIEW_CREATE_REVISION_LABEL
          The right to create a revision label; ID 0x00010000 is reused across multiple permissions
static Permission VIEW_CREATE_VIEW_LABEL
          The right to create a view label;
static Permission VIEW_DEFINE_PROMOTION_MODEL
          The right to define the promotion model ID 0x01000000 is reused across multiple permissions
static Permission VIEW_DELETE_REVISION_LABEL
          The right to delete revision labels;
static Permission VIEW_DELETE_VIEW_LABEL
          The right to delete view labels; on servers prior to version 5.1, same as VIEW_DELETE_LABEL.
static Permission VIEW_EDIT_REVISION_LABEL
          The right to edit revision labels;
static Permission VIEW_EDIT_VIEW_LABEL
          The right to edit view labels;
static Permission VIEW_MODIFY_PROMOTION_STATUS
          The right to modify promotion status ID 0x02000000 is reused across multiple permissions
static Permission VIEW_OVERRIDE_DEFAULT_TYPES
          The right to override project defaults when specifying which item types are initially shared at view creation (for variant views only); ID 0x10000000 is reused across multiple permissions
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares object o with this permission instance
static Permission fromID(int id)
          Gets the first Permission value corresponding to the given ID.
 java.lang.String[] getAdvisoryNames()
          returns a set of advisory user friendly descriptions for this permission Note that some permissions (identified by ID) will return only 1 name, but others may return several.
 int getID()
          return the ID of this Permission instance
 java.lang.String getName()
          the advisory description of this permission
 int hashCode()
          Returns the hashCode for this instance
 java.lang.String toString()
          returns a set of advisory user friendly descriptions for this permission
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ALL_PERMISSIONS

public static final Permission ALL_PERMISSIONS
All permissions.

SERVER_VIEW_COMMAND_STATS

public static final Permission SERVER_VIEW_COMMAND_STATS
The right to view server command statistics

SERVER_ADD_COLLABORATION_USER

public static final Permission SERVER_ADD_COLLABORATION_USER
The right to add new user to collaboration user group

SERVER_VIEW_SECURITY_LOG

public static final Permission SERVER_VIEW_SECURITY_LOG
The right to view security log ID 0x10000000 is reused across multiple permissions

VIEW_OVERRIDE_DEFAULT_TYPES

public static final Permission VIEW_OVERRIDE_DEFAULT_TYPES
The right to override project defaults when specifying which item types are initially shared at view creation (for variant views only); ID 0x10000000 is reused across multiple permissions

SERVER_ADMIN_USER_ACCOUNTS

public static final Permission SERVER_ADMIN_USER_ACCOUNTS
The right to administer user accounts ID 0x08000000 is reused across multiple permissions

ITEM_DETACH_FROM_REVISION_LABEL

public static final Permission ITEM_DETACH_FROM_REVISION_LABEL
The right to exclude object from a revision label; ID 0x08000000 is reused across multiple permissions

See Also:
Permission.ITEM_DETACH_FROM_VIEW_LABEL

SERVER_ADMIN_REMOTELY

public static final Permission SERVER_ADMIN_REMOTELY
The right to administer server remotely ID 0x04000000 is reused across multiple permissions

ITEM_ADD_TO_REVISION_LABEL

public static final Permission ITEM_ADD_TO_REVISION_LABEL
The right to add object to a revision label; ID 0x04000000 is reused across multiple permissions

See Also:
Permission.ITEM_ADD_TO_VIEW_LABEL

SERVER_MODIFY_SYSTEM_POLICY

public static final Permission SERVER_MODIFY_SYSTEM_POLICY
The right to modify system policy ID 0x02000000 is reused across multiple permissions

VIEW_MODIFY_PROMOTION_STATUS

public static final Permission VIEW_MODIFY_PROMOTION_STATUS
The right to modify promotion status ID 0x02000000 is reused across multiple permissions

SERVER_VIEW_SYSTEM_POLICY

public static final Permission SERVER_VIEW_SYSTEM_POLICY
The right to view system policy ID 0x01000000 is reused across multiple permissions

VIEW_DEFINE_PROMOTION_MODEL

public static final Permission VIEW_DEFINE_PROMOTION_MODEL
The right to define the promotion model ID 0x01000000 is reused across multiple permissions

SERVER_MODIFY_CONFIGURATION

public static final Permission SERVER_MODIFY_CONFIGURATION
The right to modify server settings

SERVER_VIEW_CONFIGURATION

public static final Permission SERVER_VIEW_CONFIGURATION
The right to view server settings ID 0x00400000 is reused across multiple permissions

VIEW_DELETE_VIEW_LABEL

public static final Permission VIEW_DELETE_VIEW_LABEL
The right to delete view labels; on servers prior to version 5.1, same as VIEW_DELETE_LABEL.

See Also:
ID 0x00400000 is reused across multiple permissions

COMPONENT_CREATE_QUERIES

public static final Permission COMPONENT_CREATE_QUERIES
The right to create queries ID 0x00400000 is reused across multiple permissions

COMPONENT_CREATE_FILTERS

public static final Permission COMPONENT_CREATE_FILTERS
The right to create filters

SERVER_VIEW_DIAGNOSTICS

public static final Permission SERVER_VIEW_DIAGNOSTICS
The right to view server diagnostics ID 0x00200000 is reused across multiple permissions

VIEW_EDIT_VIEW_LABEL

public static final Permission VIEW_EDIT_VIEW_LABEL
The right to edit view labels;

See Also:
ID 0x00200000 is reused across multiple permissions

FILE_CHECKOUT

public static final Permission FILE_CHECKOUT
The right to check out a file. ID 0x00200000 is reused across multiple permissions

SERVER_VIEW_LOG

public static final Permission SERVER_VIEW_LOG
The right to view server log ID 0x00100000 is reused across multiple permissions

VIEW_CREATE_VIEW_LABEL

public static final Permission VIEW_CREATE_VIEW_LABEL
The right to create a view label;

See Also:
ID 0x100000 is reused across multiple permissions

FILE_CHECKIN

public static final Permission FILE_CHECKIN
The right to check in a file. ID 0x00100000 is reused across multiple permissions

SERVER_REPLICATION_RIGHTS

public static final Permission SERVER_REPLICATION_RIGHTS
The right to allow user impersonation ID 0x00080000 is reused across multiple permissions

ITEM_DELETE_LINKS

public static final Permission ITEM_DELETE_LINKS
The right to delete links for the object; ID 0x00080000 is reused across multiple permissions

VIEW_DELETE_REVISION_LABEL

public static final Permission VIEW_DELETE_REVISION_LABEL
The right to delete revision labels;

See Also:
ID 0x00040000 is reused across multiple permissions

ITEM_MODIFY_LINKS

public static final Permission ITEM_MODIFY_LINKS
The right to modify the links for an object. ID 0x00040000 is reused across multiple permissions

SERVER_ADMINISTER_COMPONENT_RIGHTS

public static final Permission SERVER_ADMINISTER_COMPONENT_RIGHTS
The right to administer component rights ID 0x00020000 is reused across multiple permissions

ITEM_CREATE_LINKS

public static final Permission ITEM_CREATE_LINKS
The right to create links for the object. ID 0x00020000 is reused across multiple permissions

VIEW_EDIT_REVISION_LABEL

public static final Permission VIEW_EDIT_REVISION_LABEL
The right to edit revision labels;

See Also:
ID 0x00020000 is reused across multiple permissions

PROMOTION_STATE_MODIFY_STATUS

public static final Permission PROMOTION_STATE_MODIFY_STATUS
The right to modify promotion status ID 0x00020000 is reused across multiple permissions

SERVER_CREATE_PROJECT

public static final Permission SERVER_CREATE_PROJECT
The right to create projects ID 0x00010000 is reused across multiple permissions

VIEW_CREATE_REVISION_LABEL

public static final Permission VIEW_CREATE_REVISION_LABEL
The right to create a revision label; ID 0x00010000 is reused across multiple permissions

See Also:
Permission.VIEW_CREATE_VIEW_LABEL

ITEM_DETACH_FROM_VIEW_LABEL

public static final Permission ITEM_DETACH_FROM_VIEW_LABEL
The right to exclude object from a view label; ID 0x00010000 is reused across multiple permissions

See Also:
Permission.ITEM_DETACH_FROM_REVISION_LABEL

ITEM_MOVE

public static final Permission ITEM_MOVE
The right to move objects out of the folder (this right is important if the objects themselves are not protected by their own ACLs). Note that in StarTeam server versions 11.0 or earlier, both share and move operations share the same access rights.

ITEM_ADD_TO_VIEW_LABEL

public static final Permission ITEM_ADD_TO_VIEW_LABEL
The right to add object to a view label;

See Also:
Permission.ITEM_ADD_TO_REVISION_LABEL

ITEM_SEE_LINKS

public static final Permission ITEM_SEE_LINKS
The right to see object links (if it has any);

SERVER_MODIFY_SCHEMA

public static final Permission SERVER_MODIFY_SCHEMA
The right to add/modify property definitions of the objects in the components ID 0x00001000 is reused across multiple permissions

ITEM_SEE_HISTORY

public static final Permission ITEM_SEE_HISTORY
The right to see object history (if it has any); ID 0x00001000 is reused across multiple permissions

ITEM_PERFORM_MAINTENANCE

public static final Permission ITEM_PERFORM_MAINTENANCE
The right to edit comments etc

ITEM_MODIFY_BEHAVIOR

public static final Permission ITEM_MODIFY_BEHAVIOR
The right to modify object behavior.

ITEM_SHARE

public static final Permission ITEM_SHARE
The right to share objects out of the folder (this right is important if the objects themselves are not protected by their own ACLs). Note that for StarTeam Server versions 11.0 or earlier, both share and move operations share the same access rights.

GENERIC_CREATE_NEW_OBJECT

public static final Permission GENERIC_CREATE_NEW_OBJECT
The right to create a new object and place it in the container.

GENERIC_PURGE_OBJECT

public static final Permission GENERIC_PURGE_OBJECT
The right to purge (hard-delete) an object.

GENERIC_DELETE_OBJECT

public static final Permission GENERIC_DELETE_OBJECT
The right to remove an object from a container (this will be required when an object is being moved from one container to another and may be required when the object is being deleted); this is equivalent to the right to delete (soft-delete) an object.

GENERIC_MODIFY_OBJECT

public static final Permission GENERIC_MODIFY_OBJECT
The right to modify object properties (the extent of the right may differ from one object class to the next).

GENERIC_SEE_OBJECT

public static final Permission GENERIC_SEE_OBJECT
The right to see an object and its properties (but not necessarily the physical contents).

ITEM_BREAK_EXCLUSIVE_LOCK

public static final Permission ITEM_BREAK_EXCLUSIVE_LOCK
The right to break an exclusive lock

ITEM_LOCK_EXCLUSIVELY

public static final Permission ITEM_LOCK_EXCLUSIVELY
The right to set an exclusive lock

GENERIC_CHANGE_ACCESS_RIGHTS

public static final Permission GENERIC_CHANGE_ACCESS_RIGHTS
The right to change security settings of an object.

GENERIC_AQUIRE_OWNERSHIP

public static final Permission GENERIC_AQUIRE_OWNERSHIP
The right to acquire object ownership.

ALL

public static final Permission[] ALL
The collection of all Permissions

Method Detail

fromID

public static Permission fromID(int id)
Gets the first Permission value corresponding to the given ID. since several permission bitmasks are shared across different objects. Use extreme caution when using this method. The returned permission object has no context; i.e it has no advisory name

Parameters:
id - The ID of a Permission value.
Returns:
The corresponding Permission value, or null.

getID

public int getID()
return the ID of this Permission instance

Returns:
the ID of this Permission instance

getAdvisoryNames

public java.lang.String[] getAdvisoryNames()
returns a set of advisory user friendly descriptions for this permission Note that some permissions (identified by ID) will return only 1 name, but others may return several. The context is determined by the ISecurable

Returns:
a set of advisory user friendly descriptions for this permission

getName

public java.lang.String getName()
the advisory description of this permission

Returns:
the advisory description of this permission

toString

public java.lang.String toString()
returns a set of advisory user friendly descriptions for this permission

Overrides:
toString in class java.lang.Object
Returns:
a set of advisory user friendly descriptions for this permission

equals

public boolean equals(java.lang.Object o)
Compares object o with this permission instance

Overrides:
equals in class java.lang.Object
Parameters:
o - the Object to compare for equality
Returns:
true if the 2 instances are identical

hashCode

public int hashCode()
Returns the hashCode for this instance

Overrides:
hashCode in class java.lang.Object
Returns:
the hashCode for this instance
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

StarTeam SDK 14.0, Build 21
Copyright © 2003-2012 Borland Software Corporation. All rights reserved.