Package com.openkm.sdk4j.definition

Interface BaseRelation

All Known Implementing Classes:

RelationImpl

public interface BaseRelation

BaseRelation

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
void	add(String nodeAId, String nodeBId, long relTypeId)	Add relation.
void	addGroup(String uuid, String groupName, long type)	Add relation group.
void	addNodeToGroup(String uuid, long groupId)	Add node to group.
void	delete(long relationId)	Delete relation.
void	deleteGroup(long groupId)	Delete group.
void	deleteItemFromGroup(String uuid, long groupId)	Delete item from group.
RelationGroupResultSet	getAllRelationGroups(long relationTypeId, String filter, int offset, int limit)	Gets all relation groups.
RelationGroup	getGroup(long groupId)	Get group.
List<RelationGroup>	getRelationGroups(String uuid)	Gets relation groups.
List<Relation>	getRelations(String uuid)	Gets relations.
List<RelationType>	getRelationTypes(String type)	Gets relation types.
void	setGroupName(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

add

void add(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

delete

void delete(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

RelationGroupResultSet getAllRelationGroups(long relationTypeId,
                                            String filter,
                                            int offset,
                                            int limit)
                                     throws AccessDeniedException,
                                            DatabaseException,
                                            PathNotFoundException,
                                            UnknownException,
                                            WebserviceException

Gets all relation groups.

Parameters:

relationTypeId - the relation type id

filter - the filter

offset - the offset

limit - the limit

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

addGroup

void addGroup(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

deleteItemFromGroup

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

Delete item from group.

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

deleteGroup

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

Delete 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

getGroup

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

Get 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

setGroupName

void setGroupName(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