wt.access
Class AccessPermission

java.lang.Object
  wt.fc.EnumeratedType
      wt.access.AccessPermission

All Implemented Interfaces:

Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

public class AccessPermission
extends EnumeratedType
implements Serializable

AccessPermission represents the access control permissions that may be granted or denied.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static AccessPermission	ADMINISTRATIVE Administrative permission
static AccessPermission	ALL Full control (All permissions)
static AccessPermission	CHANGE_CONTEXT Change Context permission
static AccessPermission	CHANGE_DOMAIN Change Domain permission
static AccessPermission	CHANGE_PERMISSIONS Change Permissions permission
static AccessPermission	CREATE Create permission
static AccessPermission	CREATE_BY_MOVE Create By Move permission
static AccessPermission	DELETE Delete permission
static AccessPermission	DOWNLOAD Download permission
static AccessPermission	MODIFY Modify permission
static AccessPermission	MODIFY_CONTENT Modify Content permission
static AccessPermission	MODIFY_IDENTITY Modify Identity permission
static AccessPermission	NEW_VIEW_VERSION New View Version permission
static AccessPermission	READ Read permission
static AccessPermission	REVISE Revise permission
static AccessPermission	SET_STATE Set State permission

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Method Summary

static AccessPermission	getAccessPermissionDefault() Returns the default value (instance) for the AccessPermission set.
static AccessPermission[]	getAccessPermissionSet() Returns a copy of the set of valid values (instances) for the AccessPermission class.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static AccessPermission	toAccessPermission(String internal_value) Returns the AccessPermission instance for the internal_value argument.

Methods inherited from class wt.fc.EnumeratedType

equals, getAbbreviatedDisplay, getDisplay, getDisplay, getFullDisplay, getLocalizedMessage, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getStringValue, getStringValue, hashCode, isDefaultValue, isDefaultValue, isSelectable, main, toEnumeratedType, toEnumeratedType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final AccessPermission ALL

Full control (All permissions)

A user, group, or organization granted the Full Control (All) permission is granted all permissions currently defined and any that might be defined in the future. Therefore, if new permission types are defined, you do not have to write rules that specifically grant them to users, groups, or organizations with full control access.

Supported API: true

READ

public static final AccessPermission READ

Read permission

The right to know the existence of an object and to view the object and its attributes. Additionally, if the object has content, you can view an object's content information such as the file path to a local file or the location of external storage. This permission does not allow you to view the actual contents of the file.

Supported API: true

DOWNLOAD

public static final AccessPermission DOWNLOAD

Download permission

The right to download local files that are the primary content or are attachments of an object. This right is applicable to objects with content, such as documents or drawings.

Supported API: true

See Also:

wt.content, ContentHolder, ContentRoleType

MODIFY

public static final AccessPermission MODIFY

Modify permission

The right to change the attributes of an object, as well as other characteristics that are part of the object definition but are not controlled by the Modify Content or Modify Identity permissions.

For versioned objects, a user must have the Modify permission on the latest iteration of each version of a target object to update the attributes common to all versions that are not part of the object's identity. Modify permission on a version of a target object is required to modify that version's attributes.

Supported API: true

MODIFY_CONTENT

public static final AccessPermission MODIFY_CONTENT

Modify Content permission

The right to modify any local file, URL, or external storage for the primary content and attachments of an object with content. This includes modifying content information and adding, replacing, or deleting content.

Supported API: true

See Also:

wt.content, ContentHolder, ContentRoleType

MODIFY_IDENTITY

public static final AccessPermission MODIFY_IDENTITY

Modify Identity permission

The right to modify a subset of the attributes that determine the identity of an object.

For example, for a part this subset includes the part number and the organization identifier (such as cage code) of the part, but not part name (which is often treated as a short description). For a folder, the attributes include the folder name.

For information on customizing the code to modify the set of attributes used in determining the identity of an object, see the Windchill Customizer's Guide.

Supported API: true

See Also:

IdentityAccessControlled

CREATE_BY_MOVE

public static final AccessPermission CREATE_BY_MOVE

Create By Move permission

The right to move an object into an administrative domain.

Supported API: true

See Also:

AdministrativeDomain, DomainAdministered

CREATE

public static final AccessPermission CREATE

Create permission

The right to create an object.

Supported API: true

SET_STATE

public static final AccessPermission SET_STATE

Set State permission

The right of a user to perform a set state operation where a state transition has been defined to allow the transition from the current life cycle state to the new state.

Note: To perform a set state operation, a user must have the Set State permission and there must be a valid state transition defined between the current state and the desired state. If there is no transition defined, the user must have the Administrative permission to perform the operation.

For information on set state transitions and operations, see online help from the Life Cycle Administrator and the Windchill Business Administrator's Guide

Supported API: true

See Also:

LifeCycleManaged, State, Transition.SET_STATE

REVISE

public static final AccessPermission REVISE

Revise permission

The right to revise an object. Revising creates a new version of the object at the same level as the original in the version tree. For example, you can create revision B from revision A.

Supported API: true

See Also:

Versionable

NEW_VIEW_VERSION

public static final AccessPermission NEW_VIEW_VERSION

New View Version permission

The right to create a version for a specific view.

Supported API: true

See Also:

ViewManageable

CHANGE_DOMAIN

public static final AccessPermission CHANGE_DOMAIN

Change Domain permission

The right to move an object out of an administrative domain.

Supported API: true

See Also:

AdministrativeDomain, DomainAdministered

CHANGE_CONTEXT

public static final AccessPermission CHANGE_CONTEXT

Change Context permission

The right to move an object out of a context.

Supported API: true

See Also:

WTContained, WTContainer

CHANGE_PERMISSIONS

public static final AccessPermission CHANGE_PERMISSIONS

Change Permissions permission

The right to change the ad hoc permissions that others have. Users, groups, or organizations granted the Change Permissions permission are allowed to change the ad hoc permissions of others to the permissions they themselves have or to a subset of the permissions they have.

Supported API: true

See Also:

AdHocControlled

DELETE

public static final AccessPermission DELETE

Delete permission

The right to delete an object.

Supported API: true

ADMINISTRATIVE

public static final AccessPermission ADMINISTRATIVE

Administrative permission

The right to perform certain administrative tasks. For example, an administrator would have the right to break a lock or change an object's owner.

Supported API: true

Method Detail

toAccessPermission

public static AccessPermission toAccessPermission(String internal_value)
                                           throws WTInvalidParameterException

Returns the AccessPermission instance for the internal_value argument.

Supported API: true

Parameters:

internal_value - The internal (persistent) value for a valid instance of AccessPermission.

Returns:

AccessPermission

Throws:

WTInvalidParameterException

getAccessPermissionDefault

public static AccessPermission getAccessPermissionDefault()

Returns the default value (instance) for the AccessPermission set.

Supported API: true

Returns:

AccessPermission

getAccessPermissionSet

public static AccessPermission[] getAccessPermissionSet()

Returns a copy of the set of valid values (instances) for the AccessPermission class.

Supported API: true

Returns:

AccessPermission[]

getValueSet

public EnumeratedType[] getValueSet()

Returns a copy of the set of valid values (instances) for this instance, for the current user locale.

Supported API: true

Specified by:

getValueSet in class EnumeratedType

Returns:

EnumeratedType[]