com.axemble.vdoc.sdk.interfaces

Interface IProfile

All Superinterfaces:

IDeletionSupport, IElement, ILocalizationScope, IProtocolSupport, IRole, ISearchSupport, Serializable

public interface IProfile
extends IRole, ILocalizationScope, IDeletionSupport

This class allows to manipulate security profile objects.

Since:

1.0, 01/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.
void	addProfile(IProfile profile) Adds a sub-profile in the profile.
void	addProfiles(Collection<? extends IProfile> profiles) Adds sub-profiles as a collection of IProfile objects.
Collection<? extends IUser>	getAllMembers() Gets all the members of the profile recursively.
ICatalog	getCatalog() The catalog of the role.
String	getDescription() Gets the description of the profile.
Collection<? extends IGroup>	getGroups() Gets the groups of the profile.
String	getLabel() Gets the label of the profile.
IProtocolSupport	getLink() Get the link of the profile
Collection<? extends IUser>	getMembers() Gets the members of the profile.
String	getName() Gets the name of the profile.
Collection<? extends IProfile>	getParentProfiles() Gets the parent profiles of the profile.
Collection<? extends IProfile>	getProfiles() Gets the sub-profiles of the profile.
boolean	isSystem() Checks if the profile is system and is not associated with a link.
void	setDescription(String description) Sets the description of the profile.
void	setLabel(String label) Sets the label of the profile.

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

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

delete

Method Detail

getName

String getName()

Gets the name of the profile.

Specified by:

getName in interface IRole

Returns:

a String object.

getLabel

String getLabel()

Gets the label of the profile.

Specified by:

getLabel in interface IRole

Returns:

a String object.

setLabel

void setLabel(String label)

Sets the label of the profile.

Parameters:

label - The new label to use.

getDescription

String getDescription()

Gets the description of the profile.

Specified by:

getDescription in interface IRole

Returns:

The description of the profile

setDescription

void setDescription(String description)

Sets the description of the profile.

Parameters:

description - The new description to use.

getCatalog

ICatalog getCatalog()

Description copied from interface: IRole

The catalog of the role.

Specified by:

getCatalog in interface IRole

getGroups

Collection<? extends IGroup> getGroups()

Gets the groups of the profile.

Specified by:

getGroups in interface IRole

Returns:

A collection of IGroup objects.

getMembers

Collection<? extends IUser> getMembers()

Gets the members of the profile.

Specified by:

getMembers in interface IRole

Returns:

A collection of IUser objects.

getAllMembers

Collection<? extends IUser> getAllMembers()

Gets all the members of the profile 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.

getProfiles

Collection<? extends IProfile> getProfiles()

Gets the sub-profiles of the profile.

Returns:

A collection of IProfile objects.

getParentProfiles

Collection<? extends IProfile> getParentProfiles()

Gets the parent profiles of the profile.

Returns:

A collection of IProfile objects.

addProfile

void addProfile(IProfile profile)

Adds a sub-profile in the profile.

Parameters:

profile - The sub-profile to add to the profile.

addProfiles

void addProfiles(Collection<? extends IProfile> profiles)

Adds sub-profiles as a collection of IProfile objects.

Parameters:

profiles - The sub-profiles to add.

isSystem

boolean isSystem()

Checks if the profile is system and is not associated with a link.

Returns:

true if the profile is system, false otherwise.

getLink

IProtocolSupport getLink()

Get the link of the profile

Returns:

IProtocolSupport