com.axemble.vdoc.sdk.interfaces

Interface ILocalization

All Superinterfaces:

IAttributeSupport, IDeletionSupport, IDirectory, IElement, IExternalSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, Serializable

public interface ILocalization
extends IElement, ISecuritySupport, IDeletionSupport, IAttributeSupport, IExternalSupport, ISearchSupport, IProtocolSupport, IDirectory

The ILocalization interface is part of the VDoc directory.

Since:

1.0

Version:

1.0, 28/10/2007

Author:

Vassyly Lygeros

See Also:

IUser, IGroup, IOrganization

Method Summary

Modifier and Type	Method and Description
void	addLocalizations(Collection<? extends ILocalization> localizations) Add a collection of child localizations
void	addMember(IUser user) Add a IUser as a member of the localization.
void	addMembers(Collection<? extends IUser> members) Add a collection of members (IUser objects)
Collection<? extends IUser>	getAllMembers() Gets all localization members recursively.
IUser	getCreatedBy() Gets the creator of the localization.
Date	getCreatedDate() Gets the created date.
String	getCustomType() Returns the type of the localization (company, subsidiary, etc...)
String	getDescription() Returns the description of the localization
String	getLabel() Returns the label of the localization
Collection<? extends ILocalization>	getLocalizations() Returns the list of underneath localizations
Collection<? extends IUser>	getMembers() Returns the list of users
IUser	getModifiedBy() Gets the editor of the localization.
Date	getModifiedDate() Gets the created date.
String	getName() Returns the name of the localization
ILocalization	getParent() Returns the parent localization
void	removeMember(IUser user) Removes a member from the localization.
void	removeMembers(Collection<? extends IUser> members) Removes a collection of members from the localization.
void	setCustomType(String type) Set the type of the localization
void	setDescription(String description) Set the description of the localization
void	setLabel(String label) Sets the label of the localization
void	setName(String name) Set the name of the localization
void	setParent(ILocalization parent) Set the parent of the localization

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

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

addAttribute, addAttributes, getAttribute, getAttributes, getExtendedAttributes

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

getExternalClassName, getExternalNativeId

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

getExternalId, isExternal

Method Detail

getName

String getName()

Returns the name of the localization

Returns:

a String object

getLabel

String getLabel()

Returns the label of the localization

Returns:

a String object

getDescription

String getDescription()

Returns the description of the localization

Returns:

the description of the localization

getCustomType

String getCustomType()

Returns the type of the localization (company, subsidiary, etc...)

Returns:

a String object

getCreatedDate

Date getCreatedDate()

Gets the created date.

Returns:

a Date object.

getCreatedBy

IUser getCreatedBy()

Gets the creator of the localization.

Returns:

a IUser object.

getModifiedDate

Date getModifiedDate()

Gets the created date.

Returns:

a Date object.

getModifiedBy

IUser getModifiedBy()

Gets the editor of the localization.

Returns:

a IUser object.

getLocalizations

Collection<? extends ILocalization> getLocalizations()

Returns the list of underneath localizations

Returns:

a Collection object of ILocalization

getMembers

Collection<? extends IUser> getMembers()

Returns the list of users

Returns:

a Collection object

getAllMembers

Collection<? extends IUser> getAllMembers()

Gets all localization members recursively.

Returns:

A collection of IUser objects.

getParent

ILocalization getParent()

Returns the parent localization

Returns:

a ILocalization object

setName

void setName(String name)

Set the name of the localization

Parameters:

name -

setLabel

void setLabel(String label)

Sets the label of the localization

Parameters:

label -

setDescription

void setDescription(String description)

Set the description of the localization

Parameters:

description -

setCustomType

void setCustomType(String type)

Set the type of the localization

Parameters:

type -

addLocalizations

void addLocalizations(Collection<? extends ILocalization> localizations)

Add a collection of child localizations

Parameters:

localizations -

addMember

void addMember(IUser user)

Add a IUser as a member of the localization.

Parameters:

user - The IUser object to add

addMembers

void addMembers(Collection<? extends IUser> members)

Add a collection of members (IUser objects)

Parameters:

members -

removeMember

void removeMember(IUser user)

Removes a member from the localization.

Parameters:

user - The IUser object to remove.

removeMembers

void removeMembers(Collection<? extends IUser> members)

Removes a collection of members from the localization.

Parameters:

members - The collection of IUser objects to remove.

setParent

void setParent(ILocalization parent)

Set the parent of the localization

Parameters:

parent -