Channel (Cyclos 4.14.14 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.access.Channel

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, ProcessableForDataTranslation, DefinesNetwork, IEntity, IInternalNamedEntity, INamedEntity
```
@Entity
public class Channel
extends ConfigurationEntity
implements DefinesNetwork
```
A channel is a user interface to access Cyclos functionality. There are some built-in channels (the main web, for example), which cannot be removed. Other channels may be created, in order to interact with Cyclos through web services.

Constructor Summary

Constructors
Constructor Description

Channel()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DataTranslationType`	`getDataTranslationType()`	If this entity allows data translation, should return the translation type
`Network`	`getNetwork()`	Returns the network this entity belongs to
`boolean`	`isAllowOperations()`
`boolean`	`isCustom()`
`boolean`	`isEasyInvoice()`
`boolean`	`isMain()`
`boolean`	`isMobile()`
`boolean`	`isOidc()`
`boolean`	`isPos()`
`boolean`	`isService()`
`boolean`	`isSms()`
`boolean`	`isStateful()`
`boolean`	`isStateless()`
`boolean`	`isTicket()`
`boolean`	`isWebServices()`
`void`	`setNetwork(Network network)`

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

Methods inherited from class org.cyclos.entities.NamedEntity
compareTo, 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
clone, equals, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, isPersistent, isTransient

Methods inherited from class java.lang.Object
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

- Constructor Detail
  - Channel
```
public Channel()
```
- Method Detail
  - 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
    
    Returns:
  - getNetwork
```
public Network getNetwork()
```
    Description copied from class: NetworkedEntity
    
    Returns the network this entity belongs to
    
    Specified by:
    
    getNetwork in class NetworkedEntity
  - isAllowOperations
```
public boolean isAllowOperations()
```
  - isCustom
```
public boolean isCustom()
```
  - isEasyInvoice
```
public boolean isEasyInvoice()
```
  - isMain
```
public boolean isMain()
```
  - isMobile
```
public boolean isMobile()
```
  - isOidc
```
public boolean isOidc()
```
  - isPos
```
public boolean isPos()
```
  - isService
```
public boolean isService()
```
  - isSms
```
public boolean isSms()
```
  - isStateful
```
public boolean isStateful()
```
  - isStateless
```
public boolean isStateless()
```
  - isTicket
```
public boolean isTicket()
```
  - isWebServices
```
public boolean isWebServices()
```
  - setNetwork
```
public void setNetwork(Network network)
```
    Specified by:
    
    setNetwork in interface DefinesNetwork