com.openkm.module

Interface ScriptingModule

public interface ScriptingModule

Method Summary

Modifier and Type	Method and Description
String	getScript(String token, String nodePath) Get node script (document or folder).
void	removeScript(String token, String nodePath) Remove script from node.
void	setScript(String token, String nodePath, String code) Add script to node.

Method Detail

setScript

void setScript(String token,
               String nodePath,
               String code)
        throws PathNotFoundException,
               AccessDeniedException,
               RepositoryException,
               DatabaseException

Add script to node.

Parameters:

nodePath - The complete path to the node.

code - Script BeanShell code.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

removeScript

void removeScript(String token,
                  String nodePath)
           throws PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException

Remove script from node.

Parameters:

nodePath - The complete path to the node.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

getScript

String getScript(String token,
                 String nodePath)
          throws PathNotFoundException,
                 AccessDeniedException,
                 RepositoryException,
                 DatabaseException

Get node script (document or folder).

Parameters:

nodePath - The complete path to the node.

Returns:

A hashmap with pairs of user / permissions.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException