Constructor
new FilePlan(opts)
Creates a FilePlan
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | The configuration options. |
Methods
findNodeClassByPk(ncId) → {Promise.<*>}
Find NodeClass by id
Parameters:
| Name | Type | Description |
|---|---|---|
ncId |
The nodeClass id |
Returns:
Return a nodeClass
- Type
- Promise.<*>
findNodeClassByPk(ncId) → {Promise.<*>}
Find NodeClass by id
Parameters:
| Name | Type | Description |
|---|---|---|
ncId |
The nodeClass id |
Returns:
Return a nodeClass
- Type
- Promise.<*>
findNodeClassFiltered(code, name, permissions) → {Promise.<*>}
Find NodeClass elements filtered by code or name and permissions
Parameters:
| Name | Type | Description |
|---|---|---|
code |
The code |
|
name |
The name |
|
permissions |
The permissions |
Returns:
Return a list of nodeClass filtered by code or name and permissions
- Type
- Promise.<*>
findNodeClassFiltered(code, name, permissions) → {Promise.<*>}
Find NodeClass elements filtered by code or name and permissions
Parameters:
| Name | Type | Description |
|---|---|---|
code |
The code |
|
name |
The name |
|
permissions |
The permissions |
Returns:
Return a list of nodeClass filtered by code or name and permissions
- Type
- Promise.<*>
getAllNodeClasses() → {Promise.<*>}
Get all nodeClass
Returns:
Return a list of nodeClass objects
- Type
- Promise.<*>
getAllNodeClasses() → {Promise.<*>}
Get all nodeClass
Returns:
Return a list of nodeClass objects
- Type
- Promise.<*>
getChildrenClassesFilteredBySecurity(sectionId, name, permissions) → {Promise.<*>}
Get children NodeClass elements of a section section filtered by permissions
Parameters:
| Name | Type | Description |
|---|---|---|
sectionId |
The section id |
|
name |
The name |
|
permissions |
The permissions |
Returns:
Return a list of nodeClass if a section filtered by permissions
- Type
- Promise.<*>
getChildrenClassesFilteredBySecurity(sectionId, name, permissions) → {Promise.<*>}
Get children NodeClass elements of a section section filtered by permissions
Parameters:
| Name | Type | Description |
|---|---|---|
sectionId |
The section id |
|
name |
The name |
|
permissions |
The permissions |
Returns:
Return a list of nodeClass if a section filtered by permissions
- Type
- Promise.<*>
getChildrenSectionsFilteredBySecurity(parentId, permissions) → {Promise.<*>}
Get all children sections by parent filtered by security
Parameters:
| Name | Type | Description |
|---|---|---|
parentId |
The id of the parent section |
|
permissions |
The permissions |
Returns:
Return a list of child sections with parent with id value equals to parentId filtered by permissions
- Type
- Promise.<*>
getChildrenSectionsFilteredBySecurity(parentId, permissions) → {Promise.<*>}
Get all children sections by parent filtered by security
Parameters:
| Name | Type | Description |
|---|---|---|
parentId |
The id of the parent section |
|
permissions |
The permissions |
Returns:
Return a list of child sections with parent with id value equals to parentId filtered by permissions
- Type
- Promise.<*>
getChildrenSectionsIdByTenantWithChilds(parentId) → {Promise.<*>}
Get all children sections id by parent what have childs
Parameters:
| Name | Type | Description |
|---|---|---|
parentId |
The id of the parent section |
Returns:
Return a list of child sections id with parent with id value equals to parentId what have childs
- Type
- Promise.<*>
getChildrenSectionsIdByTenantWithChilds(parentId) → {Promise.<*>}
Get all children sections id by parent what have childs
Parameters:
| Name | Type | Description |
|---|---|---|
parentId |
The id of the parent section |
Returns:
Return a list of child sections id with parent with id value equals to parentId what have childs
- Type
- Promise.<*>
getRootSectionsFilteredBySecurity(permissions) → {Promise.<*>}
Get all root sections filtered by security
Parameters:
| Name | Type | Description |
|---|---|---|
permissions |
The permissions |
Returns:
Return a list of root sections filtered by permissions
- Type
- Promise.<*>
getRootSectionsFilteredBySecurity(permissions) → {Promise.<*>}
Get all root sections filtered by security
Parameters:
| Name | Type | Description |
|---|---|---|
permissions |
The permissions |
Returns:
Return a list of root sections filtered by permissions
- Type
- Promise.<*>
getRootSectionsIdWithChilds() → {Promise.<*>}
Get all root sections id what have childs
Returns:
Return a list of root sections id what have childs
- Type
- Promise.<*>
getRootSectionsIdWithChilds() → {Promise.<*>}
Get all root sections id what have childs
Returns:
Return a list of root sections id what have childs
- Type
- Promise.<*>
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setToken(token)
Set the token in Document variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
setToken(token)
Set the token in Document variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |