> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymath/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymath/api/lockuptransfermanager.md).

# LockUpTransferManager.sol

View Source: [contracts/modules/TransferManager/LTM/LockUpTransferManager.sol](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/contracts/modules/TransferManager/LTM/LockUpTransferManager.sol)

**↗ Extends:** [**LockUpTransferManagerStorage**](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/LockUpTransferManagerStorage.md)**,** [**TransferManager**](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/TransferManager.md)

**LockUpTransferManager**

**Events**

```javascript
event AddLockUpToUser(address indexed _userAddress, bytes32 indexed _lockupName);
event RemoveLockUpFromUser(address indexed _userAddress, bytes32 indexed _lockupName);
event ModifyLockUpType(uint256  _lockupAmount, uint256  _startTime, uint256  _lockUpPeriodSeconds, uint256  _releaseFrequencySeconds, bytes32 indexed _lockupName);
event AddNewLockUpType(bytes32 indexed _lockupName, uint256  _lockupAmount, uint256  _startTime, uint256  _lockUpPeriodSeconds, uint256  _releaseFrequencySeconds);
event RemoveLockUpType(bytes32 indexed _lockupName);
```

## Functions

* [(address \_securityToken, address \_polyAddress)](/polymath/api/lockuptransfermanager.md)
* [executeTransfer(address \_from, address , uint256 \_amount, bytes )](/polymath/api/lockuptransfermanager.md#executetransfer)
* [verifyTransfer(address \_from, address , uint256 \_amount, bytes )](/polymath/api/lockuptransfermanager.md#verifytransfer)
* [\_verifyTransfer(address \_from, uint256 \_amount)](/polymath/api/lockuptransfermanager.md#_verifytransfer)
* [addNewLockUpType(uint256 \_lockupAmount, uint256 \_startTime, uint256 \_lockUpPeriodSeconds, uint256 \_releaseFrequencySeconds, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#addnewlockuptype)
* [addNewLockUpTypeMulti(uint256\[\] \_lockupAmounts, uint256\[\] \_startTimes, uint256\[\] \_lockUpPeriodsSeconds, uint256\[\] \_releaseFrequenciesSeconds, bytes32\[\] \_lockupNames)](/polymath/api/lockuptransfermanager.md#addnewlockuptypemulti)
* [addLockUpByName(address \_userAddress, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#addlockupbyname)
* [addLockUpByNameMulti(address\[\] \_userAddresses, bytes32\[\] \_lockupNames)](/polymath/api/lockuptransfermanager.md#addlockupbynamemulti)
* [addNewLockUpToUser(address \_userAddress, uint256 \_lockupAmount, uint256 \_startTime, uint256 \_lockUpPeriodSeconds, uint256 \_releaseFrequencySeconds, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#addnewlockuptouser)
* [addNewLockUpToUserMulti(address\[\] \_userAddresses, uint256\[\] \_lockupAmounts, uint256\[\] \_startTimes, uint256\[\] \_lockUpPeriodsSeconds, uint256\[\] \_releaseFrequenciesSeconds, bytes32\[\] \_lockupNames)](/polymath/api/lockuptransfermanager.md#addnewlockuptousermulti)
* [removeLockUpFromUser(address \_userAddress, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#removelockupfromuser)
* [removeLockupType(bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#removelockuptype)
* [removeLockupTypeMulti(bytes32\[\] \_lockupNames)](/polymath/api/lockuptransfermanager.md#removelockuptypemulti)
* [removeLockUpFromUserMulti(address\[\] \_userAddresses, bytes32\[\] \_lockupNames)](/polymath/api/lockuptransfermanager.md#removelockupfromusermulti)
* [modifyLockUpType(uint256 \_lockupAmount, uint256 \_startTime, uint256 \_lockUpPeriodSeconds, uint256 \_releaseFrequencySeconds, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#modifylockuptype)
* [modifyLockUpTypeMulti(uint256\[\] \_lockupAmounts, uint256\[\] \_startTimes, uint256\[\] \_lockUpPeriodsSeconds, uint256\[\] \_releaseFrequenciesSeconds, bytes32\[\] \_lockupNames)](/polymath/api/lockuptransfermanager.md#modifylockuptypemulti)
* [getLockUp(bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#getlockup)
* [getAllLockupData()](/polymath/api/lockuptransfermanager.md#getalllockupdata)
* [getListOfAddresses(bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#getlistofaddresses)
* [getAllLockups()](/polymath/api/lockuptransfermanager.md#getalllockups)
* [getLockupsNamesToUser(address \_user)](/polymath/api/lockuptransfermanager.md#getlockupsnamestouser)
* [getLockedTokenToUser(address \_userAddress)](/polymath/api/lockuptransfermanager.md#getlockedtokentouser)
* [\_checkIfValidTransfer(address \_userAddress, uint256 \_amount)](/polymath/api/lockuptransfermanager.md#_checkifvalidtransfer)
* [\_getUnlockedAmountForLockup(bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_getunlockedamountforlockup)
* [\_removeLockupType(bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_removelockuptype)
* [\_modifyLockUpType(uint256 \_lockupAmount, uint256 \_startTime, uint256 \_lockUpPeriodSeconds, uint256 \_releaseFrequencySeconds, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_modifylockuptype)
* [\_removeLockUpFromUser(address \_userAddress, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_removelockupfromuser)
* [\_addNewLockUpToUser(address \_userAddress, uint256 \_lockupAmount, uint256 \_startTime, uint256 \_lockUpPeriodSeconds, uint256 \_releaseFrequencySeconds, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_addnewlockuptouser)
* [\_addLockUpByName(address \_userAddress, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_addlockupbyname)
* [\_addNewLockUpType(uint256 \_lockupAmount, uint256 \_startTime, uint256 \_lockUpPeriodSeconds, uint256 \_releaseFrequencySeconds, bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_addnewlockuptype)
* [\_checkLockUpParams(uint256 \_lockupAmount, uint256 \_lockUpPeriodSeconds, uint256 \_releaseFrequencySeconds)](/polymath/api/lockuptransfermanager.md#_checklockupparams)
* [\_checkValidStartTime(uint256 \_startTime)](/polymath/api/lockuptransfermanager.md#_checkvalidstarttime)
* [\_checkZeroAddress(address \_userAddress)](/polymath/api/lockuptransfermanager.md#_checkzeroaddress)
* [\_validLockUpCheck(bytes32 \_lockupName)](/polymath/api/lockuptransfermanager.md#_validlockupcheck)
* [\_checkValidName(bytes32 \_name)](/polymath/api/lockuptransfermanager.md#_checkvalidname)
* [\_checkLengthOfArray(uint256 \_length1, uint256 \_length2)](/polymath/api/lockuptransfermanager.md#_checklengthofarray)
* [getTokensByPartition(bytes32 \_partition, address \_tokenHolder, uint256 \_additionalBalance)](/polymath/api/lockuptransfermanager.md#gettokensbypartition)
* [getInitFunction()](/polymath/api/lockuptransfermanager.md#getinitfunction)
* [getPermissions()](/polymath/api/lockuptransfermanager.md#getpermissions)

Constructor

```javascript
function (address _securityToken, address _polyAddress) public nonpayable Module
```

**Arguments**

| Name            | Type    | Description                   |
| --------------- | ------- | ----------------------------- |
| \_securityToken | address | Address of the security token |
| \_polyAddress   | address | Address of the polytoken      |

### executeTransfer

⤾ overrides [ITransferManager.executeTransfer](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ITransferManager.md#executetransfer)

Used to verify the transfer transaction and prevent locked up tokens from being transferred

```javascript
function executeTransfer(address _from, address , uint256 _amount, bytes ) external nonpayable
returns(enum ITransferManager.Result)
```

**Arguments**

| Name     | Type    | Description                      |
| -------- | ------- | -------------------------------- |
| \_from   | address | Address of the sender            |
|          | address | \_from Address of the sender     |
| \_amount | uint256 | The amount of tokens to transfer |
|          | bytes   | \_from Address of the sender     |

### verifyTransfer

⤾ overrides [ITransferManager.verifyTransfer](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ITransferManager.md#verifytransfer)

Used to verify the transfer transaction and prevent locked up tokens from being transferred

```javascript
function verifyTransfer(address _from, address , uint256 _amount, bytes ) public view
returns(enum ITransferManager.Result, bytes32)
```

**Arguments**

| Name     | Type    | Description                      |
| -------- | ------- | -------------------------------- |
| \_from   | address | Address of the sender            |
|          | address | \_from Address of the sender     |
| \_amount | uint256 | The amount of tokens to transfer |
|          | bytes   | \_from Address of the sender     |

### \_verifyTransfer

Used to verify the transfer transaction and prevent locked up tokens from being transferred

```javascript
function _verifyTransfer(address _from, uint256 _amount) internal view
returns(enum ITransferManager.Result, bytes32)
```

**Arguments**

| Name     | Type    | Description                      |
| -------- | ------- | -------------------------------- |
| \_from   | address | Address of the sender            |
| \_amount | uint256 | The amount of tokens to transfer |

### addNewLockUpType

Use to add the new lockup type

```javascript
function addNewLockUpType(uint256 _lockupAmount, uint256 _startTime, uint256 _lockUpPeriodSeconds, uint256 _releaseFrequencySeconds, bytes32 _lockupName) external nonpayable withPerm
```

**Arguments**

| Name                      | Type    | Description                                        |
| ------------------------- | ------- | -------------------------------------------------- |
| \_lockupAmount            | uint256 | Amount of tokens that need to lock.                |
| \_startTime               | uint256 | When this lockup starts (seconds)                  |
| \_lockUpPeriodSeconds     | uint256 | Total period of lockup (seconds)                   |
| \_releaseFrequencySeconds | uint256 | How often to release a tranche of tokens (seconds) |
| \_lockupName              | bytes32 | Name of the lockup                                 |

### addNewLockUpTypeMulti

Use to add the new lockup type

```javascript
function addNewLockUpTypeMulti(uint256[] _lockupAmounts, uint256[] _startTimes, uint256[] _lockUpPeriodsSeconds, uint256[] _releaseFrequenciesSeconds, bytes32[] _lockupNames) public nonpayable withPerm
```

**Arguments**

| Name                        | Type       | Description                                                 |
| --------------------------- | ---------- | ----------------------------------------------------------- |
| \_lockupAmounts             | uint256\[] | Array of amount of tokens that need to lock.                |
| \_startTimes                | uint256\[] | Array of startTimes when this lockup starts (seconds)       |
| \_lockUpPeriodsSeconds      | uint256\[] | Array of total period of lockup (seconds)                   |
| \_releaseFrequenciesSeconds | uint256\[] | Array of how often to release a tranche of tokens (seconds) |
| \_lockupNames               | bytes32\[] | Array of names of the lockup                                |

### addLockUpByName

Add the lockup to a user

```javascript
function addLockUpByName(address _userAddress, bytes32 _lockupName) external nonpayable withPerm
```

**Arguments**

| Name          | Type    | Description         |
| ------------- | ------- | ------------------- |
| \_userAddress | address | Address of the user |
| \_lockupName  | bytes32 | Name of the lockup  |

### addLockUpByNameMulti

Add lockups to users

```javascript
function addLockUpByNameMulti(address[] _userAddresses, bytes32[] _lockupNames) public nonpayable withPerm
```

**Arguments**

| Name            | Type       | Description                     |
| --------------- | ---------- | ------------------------------- |
| \_userAddresses | address\[] | Array of addresses of the users |
| \_lockupNames   | bytes32\[] | Array of names of the lockups   |

### addNewLockUpToUser

Lets the admin create a volume restriction lockup for a given address.

```javascript
function addNewLockUpToUser(address _userAddress, uint256 _lockupAmount, uint256 _startTime, uint256 _lockUpPeriodSeconds, uint256 _releaseFrequencySeconds, bytes32 _lockupName) external nonpayable withPerm
```

**Arguments**

| Name                      | Type    | Description                                          |
| ------------------------- | ------- | ---------------------------------------------------- |
| \_userAddress             | address | Address of the user whose tokens should be locked up |
| \_lockupAmount            | uint256 | Amount of tokens that need to lock.                  |
| \_startTime               | uint256 | When this lockup starts (seconds)                    |
| \_lockUpPeriodSeconds     | uint256 | Total period of lockup (seconds)                     |
| \_releaseFrequencySeconds | uint256 | How often to release a tranche of tokens (seconds)   |
| \_lockupName              | bytes32 | Name of the lockup                                   |

### addNewLockUpToUserMulti

Lets the admin create multiple volume restriction lockups for multiple given addresses.

```javascript
function addNewLockUpToUserMulti(address[] _userAddresses, uint256[] _lockupAmounts, uint256[] _startTimes, uint256[] _lockUpPeriodsSeconds, uint256[] _releaseFrequenciesSeconds, bytes32[] _lockupNames) public nonpayable withPerm
```

**Arguments**

| Name                        | Type       | Description                                                              |
| --------------------------- | ---------- | ------------------------------------------------------------------------ |
| \_userAddresses             | address\[] | Array of address of the user whose tokens should be locked up            |
| \_lockupAmounts             | uint256\[] | Array of the amounts that need to be locked for the different addresses. |
| \_startTimes                | uint256\[] | Array of When this lockup starts (seconds)                               |
| \_lockUpPeriodsSeconds      | uint256\[] | Array of total periods of lockup (seconds)                               |
| \_releaseFrequenciesSeconds | uint256\[] | Array of how often to release a tranche of tokens (seconds)              |
| \_lockupNames               | bytes32\[] | Array of names of the lockup                                             |

### removeLockUpFromUser

Lets the admin remove a user's lock up

```javascript
function removeLockUpFromUser(address _userAddress, bytes32 _lockupName) external nonpayable withPerm
```

**Arguments**

| Name          | Type    | Description                                    |
| ------------- | ------- | ---------------------------------------------- |
| \_userAddress | address | Address of the user whose tokens are locked up |
| \_lockupName  | bytes32 | Name of the lockup need to be removed.         |

### removeLockupType

Used to remove the lockup type

```javascript
function removeLockupType(bytes32 _lockupName) external nonpayable withPerm
```

**Arguments**

| Name         | Type    | Description        |
| ------------ | ------- | ------------------ |
| \_lockupName | bytes32 | Name of the lockup |

### removeLockupTypeMulti

Used to remove the multiple lockup type

```javascript
function removeLockupTypeMulti(bytes32[] _lockupNames) public nonpayable withPerm
```

**Arguments**

| Name          | Type       | Description                |
| ------------- | ---------- | -------------------------- |
| \_lockupNames | bytes32\[] | Array of the lockup names. |

### removeLockUpFromUserMulti

Use to remove the lockup for multiple users

```javascript
function removeLockUpFromUserMulti(address[] _userAddresses, bytes32[] _lockupNames) public nonpayable withPerm
```

**Arguments**

| Name            | Type       | Description                                                |
| --------------- | ---------- | ---------------------------------------------------------- |
| \_userAddresses | address\[] | Array of addresses of the user whose tokens are locked up  |
| \_lockupNames   | bytes32\[] | Array of the names of the lockup that needs to be removed. |

### modifyLockUpType

Lets the admin modify a lockup.

```javascript
function modifyLockUpType(uint256 _lockupAmount, uint256 _startTime, uint256 _lockUpPeriodSeconds, uint256 _releaseFrequencySeconds, bytes32 _lockupName) external nonpayable withPerm
```

**Arguments**

| Name                      | Type    | Description                                        |
| ------------------------- | ------- | -------------------------------------------------- |
| \_lockupAmount            | uint256 | Amount of tokens that needs to be locked           |
| \_startTime               | uint256 | When this lockup starts (seconds)                  |
| \_lockUpPeriodSeconds     | uint256 | Total period of lockup (seconds)                   |
| \_releaseFrequencySeconds | uint256 | How often to release a tranche of tokens (seconds) |
| \_lockupName              | bytes32 | name of the lockup that needs to be modified.      |

### modifyLockUpTypeMulti

Lets the admin modify a volume restriction lockup for a multiple address.

```javascript
function modifyLockUpTypeMulti(uint256[] _lockupAmounts, uint256[] _startTimes, uint256[] _lockUpPeriodsSeconds, uint256[] _releaseFrequenciesSeconds, bytes32[] _lockupNames) public nonpayable withPerm
```

**Arguments**

| Name                        | Type       | Description                                                                         |
| --------------------------- | ---------- | ----------------------------------------------------------------------------------- |
| \_lockupAmounts             | uint256\[] | Array of the amount of tokens that needs to be locked for the respective addresses. |
| \_startTimes                | uint256\[] | Array of the start time of the lockups (seconds)                                    |
| \_lockUpPeriodsSeconds      | uint256\[] | Array of unix timestamp for the list of lockups (seconds).                          |
| \_releaseFrequenciesSeconds | uint256\[] | How often to release a tranche of tokens (seconds)                                  |
| \_lockupNames               | bytes32\[] | Array of the lockup names that needs to be modified                                 |

### getLockUp

Get a specific element in a user's lockups array given the user's address and the element index

```javascript
function getLockUp(bytes32 _lockupName) public view
returns(lockupAmount uint256, startTime uint256, lockUpPeriodSeconds uint256, releaseFrequencySeconds uint256, unlockedAmount uint256)
```

**Arguments**

| Name         | Type    | Description            |
| ------------ | ------- | ---------------------- |
| \_lockupName | bytes32 | The name of the lockup |

### getAllLockupData

Return the data of the lockups

```javascript
function getAllLockupData() external view
returns(lockupNames bytes32[], lockupAmounts uint256[], startTimes uint256[], lockUpPeriodSeconds uint256[], releaseFrequencySeconds uint256[], unlockedAmounts uint256[])
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### getListOfAddresses

get the list of the users of a lockup type

```javascript
function getListOfAddresses(bytes32 _lockupName) external view
returns(address[])
```

**Returns**

address List of users associated with the given lockup name

**Arguments**

| Name         | Type    | Description             |
| ------------ | ------- | ----------------------- |
| \_lockupName | bytes32 | Name of the lockup type |

### getAllLockups

get the list of lockups names

```javascript
function getAllLockups() external view
returns(bytes32[])
```

**Returns**

bytes32 Array of lockups names

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### getLockupsNamesToUser

get the list of the lockups for a given user

```javascript
function getLockupsNamesToUser(address _user) external view
returns(bytes32[])
```

**Returns**

bytes32 List of lockups names associated with the given address

**Arguments**

| Name   | Type    | Description         |
| ------ | ------- | ------------------- |
| \_user | address | Address of the user |

### getLockedTokenToUser

Use to get the total locked tokens for a given user

```javascript
function getLockedTokenToUser(address _userAddress) public view
returns(uint256)
```

**Returns**

uint256 Total locked tokens amount

**Arguments**

| Name          | Type    | Description         |
| ------------- | ------- | ------------------- |
| \_userAddress | address | Address of the user |

### \_checkIfValidTransfer

Checks whether the transfer is allowed

```javascript
function _checkIfValidTransfer(address _userAddress, uint256 _amount) internal view
returns(enum ITransferManager.Result, bytes32)
```

**Arguments**

| Name          | Type    | Description                                          |
| ------------- | ------- | ---------------------------------------------------- |
| \_userAddress | address | Address of the user whose lock ups should be checked |
| \_amount      | uint256 | Amount of tokens that need to transact               |

### \_getUnlockedAmountForLockup

Provide the unlock amount for the given lockup for a particular user

```javascript
function _getUnlockedAmountForLockup(bytes32 _lockupName) internal view
returns(uint256)
```

**Arguments**

| Name         | Type    | Description |
| ------------ | ------- | ----------- |
| \_lockupName | bytes32 |             |

### \_removeLockupType

```javascript
function _removeLockupType(bytes32 _lockupName) internal nonpayable
```

**Arguments**

| Name         | Type    | Description |
| ------------ | ------- | ----------- |
| \_lockupName | bytes32 |             |

### \_modifyLockUpType

```javascript
function _modifyLockUpType(uint256 _lockupAmount, uint256 _startTime, uint256 _lockUpPeriodSeconds, uint256 _releaseFrequencySeconds, bytes32 _lockupName) internal nonpayable
```

**Arguments**

| Name                      | Type    | Description |
| ------------------------- | ------- | ----------- |
| \_lockupAmount            | uint256 |             |
| \_startTime               | uint256 |             |
| \_lockUpPeriodSeconds     | uint256 |             |
| \_releaseFrequencySeconds | uint256 |             |
| \_lockupName              | bytes32 |             |

### \_removeLockUpFromUser

```javascript
function _removeLockUpFromUser(address _userAddress, bytes32 _lockupName) internal nonpayable
```

**Arguments**

| Name          | Type    | Description |
| ------------- | ------- | ----------- |
| \_userAddress | address |             |
| \_lockupName  | bytes32 |             |

### \_addNewLockUpToUser

```javascript
function _addNewLockUpToUser(address _userAddress, uint256 _lockupAmount, uint256 _startTime, uint256 _lockUpPeriodSeconds, uint256 _releaseFrequencySeconds, bytes32 _lockupName) internal nonpayable
```

**Arguments**

| Name                      | Type    | Description |
| ------------------------- | ------- | ----------- |
| \_userAddress             | address |             |
| \_lockupAmount            | uint256 |             |
| \_startTime               | uint256 |             |
| \_lockUpPeriodSeconds     | uint256 |             |
| \_releaseFrequencySeconds | uint256 |             |
| \_lockupName              | bytes32 |             |

### \_addLockUpByName

```javascript
function _addLockUpByName(address _userAddress, bytes32 _lockupName) internal nonpayable
```

**Arguments**

| Name          | Type    | Description |
| ------------- | ------- | ----------- |
| \_userAddress | address |             |
| \_lockupName  | bytes32 |             |

### \_addNewLockUpType

```javascript
function _addNewLockUpType(uint256 _lockupAmount, uint256 _startTime, uint256 _lockUpPeriodSeconds, uint256 _releaseFrequencySeconds, bytes32 _lockupName) internal nonpayable
```

**Arguments**

| Name                      | Type    | Description |
| ------------------------- | ------- | ----------- |
| \_lockupAmount            | uint256 |             |
| \_startTime               | uint256 |             |
| \_lockUpPeriodSeconds     | uint256 |             |
| \_releaseFrequencySeconds | uint256 |             |
| \_lockupName              | bytes32 |             |

### \_checkLockUpParams

Parameter checking function for creating or editing a lockup. This function will cause an exception if any of the parameters are bad.

```javascript
function _checkLockUpParams(uint256 _lockupAmount, uint256 _lockUpPeriodSeconds, uint256 _releaseFrequencySeconds) internal pure
```

**Arguments**

| Name                      | Type    | Description                                        |
| ------------------------- | ------- | -------------------------------------------------- |
| \_lockupAmount            | uint256 | Amount that needs to be locked                     |
| \_lockUpPeriodSeconds     | uint256 | Total period of lockup (seconds)                   |
| \_releaseFrequencySeconds | uint256 | How often to release a tranche of tokens (seconds) |

### \_checkValidStartTime

```javascript
function _checkValidStartTime(uint256 _startTime) internal view
```

**Arguments**

| Name        | Type    | Description |
| ----------- | ------- | ----------- |
| \_startTime | uint256 |             |

### \_checkZeroAddress

```javascript
function _checkZeroAddress(address _userAddress) internal pure
```

**Arguments**

| Name          | Type    | Description |
| ------------- | ------- | ----------- |
| \_userAddress | address |             |

### \_validLockUpCheck

```javascript
function _validLockUpCheck(bytes32 _lockupName) internal view
```

**Arguments**

| Name         | Type    | Description |
| ------------ | ------- | ----------- |
| \_lockupName | bytes32 |             |

### \_checkValidName

```javascript
function _checkValidName(bytes32 _name) internal pure
```

**Arguments**

| Name   | Type    | Description |
| ------ | ------- | ----------- |
| \_name | bytes32 |             |

### \_checkLengthOfArray

```javascript
function _checkLengthOfArray(uint256 _length1, uint256 _length2) internal pure
```

**Arguments**

| Name      | Type    | Description |
| --------- | ------- | ----------- |
| \_length1 | uint256 |             |
| \_length2 | uint256 |             |

### getTokensByPartition

⤾ overrides [TransferManager.getTokensByPartition](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/TransferManager.md#gettokensbypartition)

return the amount of tokens for a given user as per the partition

```javascript
function getTokensByPartition(bytes32 _partition, address _tokenHolder, uint256 _additionalBalance) external view
returns(uint256)
```

**Arguments**

| Name                | Type    | Description                                                                 |
| ------------------- | ------- | --------------------------------------------------------------------------- |
| \_partition         | bytes32 | Identifier                                                                  |
| \_tokenHolder       | address | Whom token amount need to query                                             |
| \_additionalBalance | uint256 | It is the `_value` that transfer during transfer/transferFrom function call |

### getInitFunction

⤾ overrides [IModule.getInitFunction](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/IModule.md#getinitfunction)

This function returns the signature of configure function

```javascript
function getInitFunction() public pure
returns(bytes4)
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### getPermissions

⤾ overrides [IModule.getPermissions](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/IModule.md#getpermissions)

Returns the permissions flag that are associated with Percentage transfer Manager

```javascript
function getPermissions() public view
returns(bytes32[])
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |