Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.portal

Class PortalPrivilege

java.lang.Object

com.esri.arcgisruntime.portal.PortalPrivilege

public final class PortalPrivilege
extends Object

Represents a particular privilege possessed by a portal user. A privilege permits the user to perform specific operations on the portal.

Since:

100.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PortalPrivilege.Realm	Signifies the realm a privilege belongs to.
static enum	PortalPrivilege.Role	Signifies the user role a privilege belongs to.
static enum	PortalPrivilege.Subtype	An enumeration of the fine-grained operation subtypes a portal privilege can permit.
static enum	PortalPrivilege.Type	Signifies the particular type of operation a privilege permits.

Method Summary

Modifier and Type	Method	Description
PortalPrivilege.Realm	getRealm()	Gets the realm this privilege belongs to.
PortalPrivilege.Role	getRole()	Gets the role this privilege belongs to.
PortalPrivilege.Subtype	getSubtype()	Gets the fine-grained operation subtype this privilege permits.
String	getSubtypeName()	Gets the subtype name for this privilege.
PortalPrivilege.Type	getType()	Gets the particular type of operation this privilege permits.
String	getTypeName()	Gets the type name for this privilege.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getRealm

public PortalPrivilege.Realm getRealm()

Gets the realm this privilege belongs to.

Returns:

the realm

Since:

100.0.0

getRole

public PortalPrivilege.Role getRole()

Gets the role this privilege belongs to.

Returns:

the role

Since:

100.0.0

getType

public PortalPrivilege.Type getType()

Gets the particular type of operation this privilege permits.

Returns:

the type of operation

Since:

100.0.0

getTypeName

public String getTypeName()

Gets the type name for this privilege.

Generally, the type name is the string representation of the getType(). However, if the type is PortalPrivilege.Type.UNKNOWN, the type name is set with the type string found in the portal privilege JSON. This allows this API to handle a new portal privilege type added at the server that is not yet defined as a PortalPrivilege.Type.

Returns:

the type name for this privilege

Since:

100.0.0

getSubtype

public PortalPrivilege.Subtype getSubtype()

Gets the fine-grained operation subtype this privilege permits.

Subtypes control access to a few fine-grained operations. The value is PortalPrivilege.Subtype.NONE unless this privilege relates to a fine-grained operation.

Returns:

the fine-grained operation subtype this privilege permits

Since:

100.12.0

getSubtypeName

public String getSubtypeName()

Gets the subtype name for this privilege.

Generally, the subtype name is the string representation of the getSubtype(). However, if the subtype is PortalPrivilege.Subtype.UNKNOWN, the subtype name is set with the subtype string found in the portal privilege JSON. This allows this API to handle a new portal privilege subtype added at the server that is not yet defined as a PortalPrivilege.Subtype.

Returns:

the subtype name for this privilege

Since:

100.12.0