Package com.openkm.sdk4j.impl

Class FilePlanImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.FilePlanImpl

All Implemented Interfaces:

BaseFilePlan, Serializable

public class FilePlanImpl
extends ClientImpl
implements BaseFilePlan, Serializable

FilePlanImpl

Author:

sochoa

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FilePlanImpl(String host)	AutomationImpl

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 ncId)	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.
protected void	setAuthorizationToken(String authorizationToken)	setAuthenticationToken

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FilePlanImpl

public FilePlanImpl(String host)

AutomationImpl

Method Details

setAuthorizationToken

protected void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

getRootSections

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

Description copied from interface: BaseFilePlan

Gets root sections.

Specified by:

getRootSections in interface BaseFilePlan

Returns:

the root sections

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getRootSectionsIdWithChildren

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

Description copied from interface: BaseFilePlan

Gets root sections id with children.

Specified by:

getRootSectionsIdWithChildren in interface BaseFilePlan

Returns:

the root sections id with children

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getRootSectionsFilteredBySecurity

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

Description copied from interface: BaseFilePlan

Gets root sections filtered by security.

Specified by:

getRootSectionsFilteredBySecurity in interface BaseFilePlan

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

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

Description copied from interface: BaseFilePlan

Gets all sections ordered.

Specified by:

getAllSectionsOrdered in interface BaseFilePlan

Returns:

the all sections ordered

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenSections

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

Description copied from interface: BaseFilePlan

Gets children sections.

Specified by:

getChildrenSections in interface BaseFilePlan

Parameters:

parentId - the parent id

Returns:

the children sections

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenSectionsIdByTenantWithChildren

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

Description copied from interface: BaseFilePlan

Gets children sections id by tenant with children.

Specified by:

getChildrenSectionsIdByTenantWithChildren in interface BaseFilePlan

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

getChildrenSectionsFilteredBySecurity

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

Description copied from interface: BaseFilePlan

Gets children sections filtered by security.

Specified by:

getChildrenSectionsFilteredBySecurity in interface BaseFilePlan

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

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

Description copied from interface: BaseFilePlan

Gets children classes.

Specified by:

getChildrenClasses in interface BaseFilePlan

Parameters:

sectionId - the section id

Returns:

the children classes

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

getChildrenClassesFilteredBySecurity

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

Description copied from interface: BaseFilePlan

Gets children classes filtered by security.

Specified by:

getChildrenClassesFilteredBySecurity in interface BaseFilePlan

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

public NodeClass findNodeClassByPk(long ncId)
                            throws WebserviceException,
DatabaseException,
UnknownException

Description copied from interface: BaseFilePlan

Find node class by pk node class.

Specified by:

findNodeClassByPk in interface BaseFilePlan

Parameters:

ncId - the id

Returns:

the node class

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findElectronicRecordClasses

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

Description copied from interface: BaseFilePlan

Find electronic record classes list.

Specified by:

findElectronicRecordClasses in interface BaseFilePlan

Returns:

the list

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findElectronicRecordClassesFilteredBySecurity

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

Description copied from interface: BaseFilePlan

Find electronic record classes filtered by security list.

Specified by:

findElectronicRecordClassesFilteredBySecurity in interface BaseFilePlan

Parameters:

permissions - the permissions

Returns:

the list

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findFilteredByCodeOrNameFilteredBySecurity

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

Description copied from interface: BaseFilePlan

Find filtered by code or name filtered by security list.

Specified by:

findFilteredByCodeOrNameFilteredBySecurity in interface BaseFilePlan

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

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

Description copied from interface: BaseFilePlan

Gets all node classes.

Specified by:

getAllNodeClasses in interface BaseFilePlan

Returns:

the all node classes

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception

findSectionFiltered

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

Description copied from interface: BaseFilePlan

Find section filtered list.

Specified by:

findSectionFiltered in interface BaseFilePlan

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

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

Description copied from interface: BaseFilePlan

Gets node class breadcrumb.

Specified by:

getBreadcrumb in interface BaseFilePlan

Parameters:

sectionId - the section id

Returns:

the node class breadcrumb

Throws:

WebserviceException - the webservice exception

DatabaseException - the database exception

UnknownException - the unknown exception