Agreement (Cyclos 4.16.19 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.Agreement

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, ProcessableForProxying, DefinesNetwork, IEntity, IInternalNamedEntity, INamedEntity
```
@Entity
public class Agreement
extends ConfigurationEntity
implements DefinesNetwork
```
An agreement represents a legal texts that can either be required for users to operate in the system, or can be required.

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

Constructor Summary

Constructors
Constructor Description

Agreement()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(NamedEntity o)`
`String`	`getContent()`
`Network`	`getNetwork()`	Returns the network this entity belongs to
`boolean`	`isRequired()`
`void`	`setContent(String content)`
`void`	`setNetwork(Network network)`
`void`	`setRequired(boolean required)`

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

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

Methods inherited from class org.cyclos.entities.BaseEntity
getDataTranslationType, 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
  - Agreement
```
public Agreement()
```
- Method Detail
  - compareTo
```
public int compareTo(NamedEntity o)
```
    Specified by:
    
    compareTo in interface Comparable<NamedEntity>
    
    Overrides:
    
    compareTo in class NamedEntity
  - getContent
```
public String getContent()
```
  - getNetwork
```
public Network getNetwork()
```
    Description copied from interface: HasNetwork
    
    Returns the network this entity belongs to
    
    Specified by:
    
    getNetwork in interface HasNetwork
  - isRequired
```
public boolean isRequired()
```
  - setContent
```
public void setContent(String content)
```
  - setNetwork
```
public void setNetwork(Network network)
```
    Specified by:
    
    setNetwork in interface DefinesNetwork
  - setRequired
```
public void setRequired(boolean required)
```