com.openkm.sdk4j.definition

Interface BaseRelation

All Known Implementing Classes:

OKMWebservices, RelationImpl

public interface BaseRelation

BaseRelation

Author:

jllort

Method Summary

Modifier and Type	Method and Description
void	addNodeToGroup(String uuid, long groupId) Add node to group.
void	addRelation(String nodeAId, String nodeBId, long relTypeId) Add relation.
void	addRelationGroup(String uuid, String groupName, long type) Add relation group.
void	deleteRelation(long relationId) Delete relation.
void	deleteRelationGroup(long groupId) Delete relation group.
void	deleteRelationGroupItem(String uuid, long groupId) Delete relation group item.
RelationGroup	findRelationGroup(long groupId) Find relation group relation group.
List<RelationGroup>	getAllRelationGroups() Gets all relation groups.
List<RelationGroup>	getRelationGroups(String uuid) Gets relation groups.
List<Relation>	getRelations(String uuid) Gets relations.
List<RelationType>	getRelationTypes(String type) Gets relation types.
void	setRelationGroupName(long groupId, String groupName) Sets relation group name.

Method Detail

getRelationTypes

List<RelationType> getRelationTypes(String type)
                             throws AccessDeniedException,
                                    DatabaseException,
                                    UnknownException,
                                    WebserviceException

Gets relation types.

Parameters:

type - the type

Returns:

the relation types

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addRelation

void addRelation(String nodeAId,
                 String nodeBId,
                 long relTypeId)
          throws LockException,
                 PathNotFoundException,
                 AccessDeniedException,
                 RepositoryException,
                 DatabaseException,
                 UnknownException,
                 WebserviceException

Add relation.

Parameters:

nodeAId - the node a id

nodeBId - the node b id

relTypeId - the rel type id

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteRelation

void deleteRelation(long relationId)
             throws LockException,
                    PathNotFoundException,
                    AccessDeniedException,
                    RepositoryException,
                    DatabaseException,
                    UnknownException,
                    WebserviceException

Delete relation.

Parameters:

relationId - the relation id

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getRelations

List<Relation> getRelations(String uuid)
                     throws AccessDeniedException,
                            PathNotFoundException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException

Gets relations.

Parameters:

uuid - the uuid

Returns:

the relations

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getRelationGroups

List<RelationGroup> getRelationGroups(String uuid)
                               throws AccessDeniedException,
                                      DatabaseException,
                                      PathNotFoundException,
                                      UnknownException,
                                      WebserviceException

Gets relation groups.

Parameters:

uuid - the uuid

Returns:

the relation groups

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getAllRelationGroups

List<RelationGroup> getAllRelationGroups()
                                  throws AccessDeniedException,
                                         DatabaseException,
                                         PathNotFoundException,
                                         UnknownException,
                                         WebserviceException

Gets all relation groups.

Returns:

the all relation groups

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addRelationGroup

void addRelationGroup(String uuid,
                      String groupName,
                      long type)
               throws AccessDeniedException,
                      PathNotFoundException,
                      DatabaseException,
                      UnknownException,
                      WebserviceException

Add relation group.

Parameters:

uuid - the uuid

groupName - the group name

type - the type

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addNodeToGroup

void addNodeToGroup(String uuid,
                    long groupId)
             throws AccessDeniedException,
                    PathNotFoundException,
                    DatabaseException,
                    RepositoryException,
                    UnknownException,
                    WebserviceException

Add node to group.

Parameters:

uuid - the uuid

groupId - the group id

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

RepositoryException - the repository exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteRelationGroupItem

void deleteRelationGroupItem(String uuid,
                             long groupId)
                      throws AccessDeniedException,
                             DatabaseException,
                             PathNotFoundException,
                             RepositoryException,
                             UnknownException,
                             WebserviceException

Delete relation group item.

Parameters:

uuid - the uuid

groupId - the group id

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteRelationGroup

void deleteRelationGroup(long groupId)
                  throws AccessDeniedException,
                         DatabaseException,
                         PathNotFoundException,
                         RepositoryException,
                         UnknownException,
                         WebserviceException

Delete relation group.

Parameters:

groupId - the group id

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findRelationGroup

RelationGroup findRelationGroup(long groupId)
                         throws AccessDeniedException,
                                PathNotFoundException,
                                DatabaseException,
                                RepositoryException,
                                UnknownException,
                                WebserviceException

Find relation group relation group.

Parameters:

groupId - the group id

Returns:

the relation group

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

RepositoryException - the repository exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setRelationGroupName

void setRelationGroupName(long groupId,
                          String groupName)
                   throws AccessDeniedException,
                          DatabaseException,
                          UnknownException,
                          WebserviceException

Sets relation group name.

Parameters:

groupId - the group id

groupName - the group name

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception