org.eclipse.emf.emfstore.internal.client.model

Interface AdminBroker

All Known Implementing Classes:

AdminBrokerImpl

public interface AdminBroker

Interface for administrative services of the EMFStore. The Adminbroker delegates the method calls to the server ( AdminEmfStore) via AdminConnectionManager .

Author:

Hodaie, Wesendonk

Method Summary

Modifier and Type	Method and Description
void	addInitialParticipant(ProjectId projectId, ACOrgUnitId participantId, org.eclipse.emf.ecore.EClass role) Delegates call to method in AdminEmfStore.
void	addMember(ACOrgUnitId group, ACOrgUnitId member) Delegates call to method in AdminEmfStore.
void	addParticipant(ProjectId projectId, ACOrgUnitId participantId, org.eclipse.emf.ecore.EClass role) Delegates call to method in AdminEmfStore.
void	assignRole(ACOrgUnitId orgUnitId, org.eclipse.emf.ecore.EClass role) Delegates call to method in AdminEmfStore.
void	changeOrgUnit(ACOrgUnitId orgUnitId, String name, String description) Delegates call to method in AdminEmfStore.
void	changeRole(ProjectId projectId, ACOrgUnitId orgUnit, org.eclipse.emf.ecore.EClass role) Delegates call to method in AdminEmfStore.
void	changeUser(ACOrgUnitId userId, String name, String password) Delegates call to method in AdminEmfStore.
ACOrgUnitId	createGroup(String name) Delegates call to method in AdminEmfStore.
ACOrgUnitId	createUser(String name) Delegates call to method in AdminEmfStore.
void	deleteGroup(ACOrgUnitId group) Delegates call to method in AdminEmfStore.
void	deleteUser(ACOrgUnitId user) Delegates call to method in AdminEmfStore.
List<ACGroup>	getGroups() Delegates call to method in AdminEmfStore.
List<ACGroup>	getGroups(ACOrgUnitId user) Delegates call to method in AdminEmfStore.
List<ACOrgUnit>	getMembers(ACOrgUnitId groupId) Delegates call to method in AdminEmfStore.
ACOrgUnit	getOrgUnit(ACOrgUnitId orgUnitId) Delegates call to method in AdminEmfStore.
List<ACOrgUnit>	getOrgUnits() Delegates call to method in AdminEmfStore.
List<ACOrgUnit>	getParticipants(ProjectId projectId) Delegates call to method in AdminEmfStore.
List<ProjectInfo>	getProjectInfos() Delegates call to method in AdminEmfStore.
Role	getRole(ProjectId projectId, ACOrgUnitId orgUnit) Delegates call to method in AdminEmfStore.
List<ACUser>	getUsers() Delegates call to method in AdminEmfStore.
void	removeGroup(ACOrgUnitId user, ACOrgUnitId group) Delegates call to method in AdminEmfStore.
void	removeMember(ACOrgUnitId group, ACOrgUnitId member) Delegates call to method in AdminEmfStore.
void	removeParticipant(ProjectId projectId, ACOrgUnitId participant) Delegates call to method in AdminEmfStore.

Method Detail

getProjectInfos

List<ProjectInfo> getProjectInfos()
                           throws ESException

Delegates call to method in AdminEmfStore.

Returns:

list of project infos

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getProjectInfos(org.eclipse.emf.emfstore.internal.server.model.SessionId)

getGroups

List<ACGroup> getGroups()
                 throws ESException

Delegates call to method in AdminEmfStore.

Returns:

list of groups

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getGroups(org.eclipse.emf.emfstore.internal.server.model.SessionId)

getUsers

List<ACUser> getUsers()
               throws ESException

Delegates call to method in AdminEmfStore.

Returns:

list of users

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getUsers(org.eclipse.emf.emfstore.internal.server.model.SessionId)

getOrgUnits

List<ACOrgUnit> getOrgUnits()
                     throws ESException

Delegates call to method in AdminEmfStore. AdminEmfStore.getOrgUnits(org.eclipse.emf.emfstore.internal.server.model.SessionId)

Returns:

list of orgUnits

Throws:

ESException - if an exceptions occurs on the server or on transport

createGroup

ACOrgUnitId createGroup(String name)
                 throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

name - new name

Returns:

ACOrgUnitId

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.createGroup(org.eclipse.emf.emfstore.internal.server.model.SessionId, String)

deleteGroup

void deleteGroup(ACOrgUnitId group)
          throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

group - orgUnit id

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.deleteGroup(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId)

getGroups

List<ACGroup> getGroups(ACOrgUnitId user)
                 throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

user - orgUnit id

Returns:

list of groups

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getGroups(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId)

removeGroup

void removeGroup(ACOrgUnitId user,
                 ACOrgUnitId group)
          throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

user - orgUnit id

group - group id

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.removeGroup(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId, ACOrgUnitId)

createUser

ACOrgUnitId createUser(String name)
                throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

name - user's name

Returns:

ACOrgUnitId

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.createUser(org.eclipse.emf.emfstore.internal.server.model.SessionId, String)

deleteUser

void deleteUser(ACOrgUnitId user)
         throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

user - user id

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.deleteUser(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId)

getMembers

List<ACOrgUnit> getMembers(ACOrgUnitId groupId)
                    throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

groupId - group id

Returns:

list of members

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getMembers(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId)

getOrgUnit

ACOrgUnit getOrgUnit(ACOrgUnitId orgUnitId)
              throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

orgUnitId - orgUnit id

Returns:

orgUnit

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getOrgUnit(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId)

addMember

void addMember(ACOrgUnitId group,
               ACOrgUnitId member)
        throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

group - group id

member - member id

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.addMember(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId, ACOrgUnitId)

removeMember

void removeMember(ACOrgUnitId group,
                  ACOrgUnitId member)
           throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

group - group id

member - member id

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.removeMember(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId, ACOrgUnitId)

changeOrgUnit

void changeOrgUnit(ACOrgUnitId orgUnitId,
                   String name,
                   String description)
            throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

orgUnitId - orgUnit id

name - new name

description - new description

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.changeOrgUnit(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId, String, String)

changeUser

void changeUser(ACOrgUnitId userId,
                String name,
                String password)
         throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

userId - the ID of the user

name - the new name of the user

password - the new password of the user

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.changeOrgUnit(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId, String, String)

getParticipants

List<ACOrgUnit> getParticipants(ProjectId projectId)
                         throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

projectId - project id

Returns:

list of participating orgUnits

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getParticipants(org.eclipse.emf.emfstore.internal.server.model.SessionId, ProjectId)

addParticipant

void addParticipant(ProjectId projectId,
                    ACOrgUnitId participantId,
                    org.eclipse.emf.ecore.EClass role)
             throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

projectId - the ProjectId

participantId - the ACOrgUnitId of the participant to be added

role - the EClass of the role that should be assigned to the participant

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.addParticipant(org.eclipse.emf.emfstore.internal.server.model.SessionId, ProjectId, ACOrgUnitId, EClass)

addInitialParticipant

void addInitialParticipant(ProjectId projectId,
                           ACOrgUnitId participantId,
                           org.eclipse.emf.ecore.EClass role)
                    throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

projectId - the ProjectId

participantId - the ACOrgUnitId of the participant to be added

role - the EClass of the role that should be assigned to the participant

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.addParticipant(org.eclipse.emf.emfstore.internal.server.model.SessionId, ProjectId, ACOrgUnitId, EClass)

removeParticipant

void removeParticipant(ProjectId projectId,
                       ACOrgUnitId participant)
                throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

projectId - project id

participant - orgUnit id

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.removeParticipant(org.eclipse.emf.emfstore.internal.server.model.SessionId, ProjectId, ACOrgUnitId)

getRole

Role getRole(ProjectId projectId,
             ACOrgUnitId orgUnit)
      throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

projectId - project id

orgUnit - orgUnit id

Returns:

the role

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.getRole(org.eclipse.emf.emfstore.internal.server.model.SessionId, ProjectId, ACOrgUnitId)

changeRole

void changeRole(ProjectId projectId,
                ACOrgUnitId orgUnit,
                org.eclipse.emf.ecore.EClass role)
         throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

projectId - the project id

orgUnit - the orgUnit id

role - new role

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.changeRole(org.eclipse.emf.emfstore.internal.server.model.SessionId, ProjectId, ACOrgUnitId, EClass)

assignRole

void assignRole(ACOrgUnitId orgUnitId,
                org.eclipse.emf.ecore.EClass role)
         throws ESException

Delegates call to method in AdminEmfStore.

Parameters:

orgUnitId - the ID of an organizational unit

role - the role to be assigned

Throws:

ESException - if an exceptions occurs on the server or on transport

See Also:

AdminEmfStore.assignRole(org.eclipse.emf.emfstore.internal.server.model.SessionId, ACOrgUnitId, EClass)