com.axemble.vdoc.sdk.interfaces

Interface IOperatorRole

All Superinterfaces:

IElement, ILocalizationScope, IProtocolSupport, IRole, ISearchSupport, Serializable

public interface IOperatorRole
extends IRole, ILocalizationScope

This class allows to associate either groups or users to ITask objects.

Since:

1.0, 04/04/2011

Author:

omenuel

See Also:

IUser, IGroup

Method Summary

Modifier and Type	Method and Description
void	addGroup(IGroup group) Adds a group IGroup.
void	addGroups(Collection<? extends IGroup> groups) Adds groups as a collection of IGroup objects.
void	addMember(IUser user) Sets a user as member of a group.
void	addMembers(Collection<? extends IUser> members) Adds members as a collection of IUser objects.
Collection<? extends IUser>	getAllMembers() Gets all the members of the roles recursively.
ICatalog	getCatalog() The catalog of the role.
String	getDescription()
Collection<? extends IGroup>	getGroups() Gets the groups of the role.
String	getLabel() Gets the label of the operator role.
Collection<? extends IUser>	getMembers() Gets the members of the role.
String	getName() Gets the name of the role.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IRole

addChild, addChildren

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Method Detail

getName

String getName()

Gets the name of the role.

Specified by:

getName in interface IRole

Returns:

a String object.

getLabel

String getLabel()

Gets the label of the operator role.

Specified by:

getLabel in interface IRole

Returns:

a String object.

getDescription

String getDescription()

Specified by:

getDescription in interface IRole

Returns:

The description of the operator role

getCatalog

ICatalog getCatalog()

The catalog of the role.

Specified by:

getCatalog in interface IRole

getGroups

Collection<? extends IGroup> getGroups()

Gets the groups of the role.

Specified by:

getGroups in interface IRole

Returns:

A collection of IGroup objects.

getMembers

Collection<? extends IUser> getMembers()

Gets the members of the role.

Specified by:

getMembers in interface IRole

Returns:

A collection of IUser objects.

getAllMembers

Collection<? extends IUser> getAllMembers()

Gets all the members of the roles recursively.

Specified by:

getAllMembers in interface IRole

Returns:

A collection of IUser objects.

addMember

void addMember(IUser user)

Sets a user as member of a group.

Specified by:

addMember in interface IRole

Parameters:

user - The user to add to the group.

addGroup

void addGroup(IGroup group)

Adds a group IGroup.

Specified by:

addGroup in interface IRole

Parameters:

group - The child group to add.

addMembers

void addMembers(Collection<? extends IUser> members)

Adds members as a collection of IUser objects.

Specified by:

addMembers in interface IRole

Parameters:

members - The users to add.

addGroups

void addGroups(Collection<? extends IGroup> groups)

Adds groups as a collection of IGroup objects.

Specified by:

addGroups in interface IRole

Parameters:

groups - The groups to add.