PrincipalTypeContext (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<PrincipalTypeContext>
- - org.cyclos.impl.access.PrincipalTypeContext

All Implemented Interfaces:

Serializable, Comparable<PrincipalTypeContext>
```
public enum PrincipalTypeContext
extends Enum<PrincipalTypeContext>
```
Possible situations where principal types are used on a channel configuration

Enum Constant Summary

Enum Constants
Enum Constant Description

ACCESS
To access the channel

PAYMENT
To find other users to perform a direct payment

POS
To find other users receive a payment

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static PrincipalTypeContext`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static PrincipalTypeContext[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ACCESS
```
public static final PrincipalTypeContext ACCESS
```
    To access the channel
  - PAYMENT
```
public static final PrincipalTypeContext PAYMENT
```
    To find other users to perform a direct payment
  - POS
```
public static final PrincipalTypeContext POS
```
    To find other users receive a payment
- Method Detail
  - values
```
public static PrincipalTypeContext[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (PrincipalTypeContext c : PrincipalTypeContext.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PrincipalTypeContext valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null