PrincipalType (Cyclos 4.16.20 Scripting API Documentation)

java.lang.Object
- org.cyclos.entities.SimpleEntity
- - org.cyclos.entities.NetworkedEntity
  - - org.cyclos.entities.BaseEntity
    - - org.cyclos.entities.NamedEntity
      - org.cyclos.entities.ConfigurationEntity
        
        org.cyclos.entities.ConfigurationOrderableEntity
        
        org.cyclos.entities.access.PrincipalType

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, HasOrder, ProcessableForProxying, DefinesNetwork, IEntity, IInternalNamedEntity, INamedEntity

Direct Known Subclasses:

ActivatablePrincipalType, BuiltInPrincipalType, CustomFieldPrincipalType
```
@Entity
public abstract class PrincipalType
extends ConfigurationOrderableEntity
implements DefinesNetwork
```
Represents a principal type, like the username, e-mail, mobile phone, profile field or token

Nested Class Summary
- Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity
  SimpleEntity.EntityLoadNotifier

Constructor Summary

Constructors
Constructor Description

PrincipalType()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(NamedEntity o)`
`DataTranslationType`	`getDataTranslationType()`	If this entity allows data translation, should return the translation type
`abstract PrincipalTypeNature`	`getNature()`
`Network`	`getNetwork()`	Returns the network this entity belongs to
`abstract boolean`	`isUsedExternalPayment()`
`void`	`setNetwork(Network network)`

Methods inherited from class org.cyclos.entities.ConfigurationOrderableEntity
getOrder, setOrder, toString

Methods inherited from class org.cyclos.entities.ConfigurationEntity
getDescription, getInternalName, setDescription, setInternalName, toShortString

Methods inherited from class org.cyclos.entities.NamedEntity
getName, getNames, setName

Methods inherited from class org.cyclos.entities.BaseEntity
getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity
isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity
equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

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

Methods inherited from interface org.cyclos.model.IEntity
getId, matches

Methods inherited from interface org.cyclos.model.IInternalNamedEntity
matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying
getProxyClass

- Constructor Detail
  - PrincipalType
```
public PrincipalType()
```
- Method Detail
  - compareTo
```
public int compareTo(NamedEntity o)
```
    Specified by:
    
    compareTo in interface Comparable<NamedEntity>
    
    Overrides:
    
    compareTo in class ConfigurationOrderableEntity
  - getDataTranslationType
```
public DataTranslationType getDataTranslationType()
```
    Description copied from class: BaseEntity
    
    If this entity allows data translation, should return the translation type
    
    Overrides:
    
    getDataTranslationType in class BaseEntity
  - getNature
```
public abstract PrincipalTypeNature getNature()
```
  - getNetwork
```
public Network getNetwork()
```
    Description copied from interface: HasNetwork
    
    Returns the network this entity belongs to
    
    Specified by:
    
    getNetwork in interface HasNetwork
  - isUsedExternalPayment
```
public abstract boolean isUsedExternalPayment()
```
  - setNetwork
```
public void setNetwork(Network network)
```
    Specified by:
    
    setNetwork in interface DefinesNetwork