Package com.openkm.sdk4j.definition

Interface BaseFilePlan

All Known Implementing Classes:

FilePlanImpl

public interface BaseFilePlan

BaseFilePlan

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
List<NodeClass>	findElectronicRecordClasses()	Find electronic record classes list.
List<NodeClass>	findElectronicRecordClassesFilteredBySecurity(int permissions)	Find electronic record classes filtered by security list.
List<NodeClass>	findFilteredByCodeOrNameFilteredBySecurity(String code, String name, int permissions)	Find filtered by code or name filtered by security list.
NodeClass	findNodeClassByPk(long id)	Find node class by pk node class.
List<NodeClassSectionDefinition>	findSectionFiltered(String code, String name, int permissions)	Find section filtered list.
List<NodeClass>	getAllNodeClasses()	Gets all node classes.
List<NodeClassSectionDefinition>	getAllSectionsOrdered()	Gets all sections ordered.
List<NodeClassSectionDefinition>	getBreadcrumb(long sectionId)	Gets node class breadcrumb.
List<NodeClass>	getChildrenClasses(long sectionId)	Gets children classes.
List<NodeClass>	getChildrenClassesFilteredBySecurity(long sectionId, int permissions)	Gets children classes filtered by security.
List<NodeClassSectionDefinition>	getChildrenSections(long parentId)	Gets children sections.
List<NodeClassSectionDefinition>	getChildrenSectionsFilteredBySecurity(long parentId, int permissions)	Gets children sections filtered by security.
List<Long>	getChildrenSectionsIdByTenantWithChildren(long parentId)	Gets children sections id by tenant with children.
List<NodeClassSectionDefinition>	getRootSections()	Gets root sections.
List<NodeClassSectionDefinition>	getRootSectionsFilteredBySecurity(int permissions)	Gets root sections filtered by security.
List<Long>	getRootSectionsIdWithChildren()	Gets root sections id with children.

Method Detail

getRootSections

List<NodeClassSectionDefinition> getRootSections()
                                          throws WebserviceException,
                                                 DatabaseException,
                                                 UnknownException

Gets root sections.

Returns:

the root sections

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getRootSectionsIdWithChildren

List<Long> getRootSectionsIdWithChildren()
                                  throws WebserviceException,
                                         DatabaseException,
                                         UnknownException

Gets root sections id with children.

Returns:

the root sections id with children

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getRootSectionsFilteredBySecurity

List<NodeClassSectionDefinition> getRootSectionsFilteredBySecurity(int permissions)
                                                            throws WebserviceException,
                                                                   DatabaseException,
                                                                   UnknownException

Gets root sections filtered by security.

Parameters:

permissions - the permissions

Returns:

the root sections filtered by security

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getAllSectionsOrdered

List<NodeClassSectionDefinition> getAllSectionsOrdered()
                                                throws WebserviceException,
                                                       DatabaseException,
                                                       UnknownException

Gets all sections ordered.

Returns:

the all sections ordered

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenSections

List<NodeClassSectionDefinition> getChildrenSections(long parentId)
                                              throws WebserviceException,
                                                     DatabaseException,
                                                     UnknownException

Gets children sections.

Parameters:

parentId - the parent id

Returns:

the children sections

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenSectionsFilteredBySecurity

List<NodeClassSectionDefinition> getChildrenSectionsFilteredBySecurity(long parentId,
                                                                       int permissions)
                                                                throws WebserviceException,
                                                                       DatabaseException,
                                                                       UnknownException

Gets children sections filtered by security.

Parameters:

parentId - the parent id

permissions - the permissions

Returns:

the children sections filtered by security

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenClasses

List<NodeClass> getChildrenClasses(long sectionId)
                            throws WebserviceException,
                                   DatabaseException,
                                   UnknownException

Gets children classes.

Parameters:

sectionId - the section id

Returns:

the children classes

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenSectionsIdByTenantWithChildren

List<Long> getChildrenSectionsIdByTenantWithChildren(long parentId)
                                              throws WebserviceException,
                                                     DatabaseException,
                                                     UnknownException

Gets children sections id by tenant with children.

Parameters:

parentId - the parent id

Returns:

the children sections id by tenant with children

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenClassesFilteredBySecurity

List<NodeClass> getChildrenClassesFilteredBySecurity(long sectionId,
                                                     int permissions)
                                              throws WebserviceException,
                                                     DatabaseException,
                                                     UnknownException

Gets children classes filtered by security.

Parameters:

sectionId - the section id

permissions - the permissions

Returns:

the children classes filtered by security

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findNodeClassByPk

NodeClass findNodeClassByPk(long id)
                     throws WebserviceException,
                            DatabaseException,
                            UnknownException

Find node class by pk node class.

Parameters:

id - the id

Returns:

the node class

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findElectronicRecordClasses

List<NodeClass> findElectronicRecordClasses()
                                     throws WebserviceException,
                                            DatabaseException,
                                            UnknownException

Find electronic record classes list.

Returns:

the list

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findElectronicRecordClassesFilteredBySecurity

List<NodeClass> findElectronicRecordClassesFilteredBySecurity(int permissions)
                                                       throws WebserviceException,
                                                              DatabaseException,
                                                              UnknownException

Find electronic record classes filtered by security list.

Parameters:

permissions - the permissions

Returns:

the list

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findFilteredByCodeOrNameFilteredBySecurity

List<NodeClass> findFilteredByCodeOrNameFilteredBySecurity(String code,
                                                           String name,
                                                           int permissions)
                                                    throws WebserviceException,
                                                           DatabaseException,
                                                           UnknownException

Find filtered by code or name filtered by security list.

Parameters:

code - the code

name - the name

permissions - the permissions

Returns:

the list

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getAllNodeClasses

List<NodeClass> getAllNodeClasses()
                           throws WebserviceException,
                                  DatabaseException,
                                  UnknownException

Gets all node classes.

Returns:

the all node classes

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findSectionFiltered

List<NodeClassSectionDefinition> findSectionFiltered(String code,
                                                     String name,
                                                     int permissions)
                                              throws WebserviceException,
                                                     DatabaseException,
                                                     UnknownException

Find section filtered list.

Parameters:

code - the code

name - the name

permissions - the permissions

Returns:

the list

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getBreadcrumb

List<NodeClassSectionDefinition> getBreadcrumb(long sectionId)
                                        throws WebserviceException,
                                               DatabaseException,
                                               UnknownException

Gets node class breadcrumb.

Parameters:

sectionId - the section id

Returns:

the node class breadcrumb

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception