com.axemble.vdoc.sdk.interfaces

Interface IOrganization

All Superinterfaces:

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

public interface IOrganization
extends IElement, ISecuritySupport, IDeletionSupport, IAttributeSupport, IExternalSupport, ISearchSupport, IProtocolSupport, ILocalizationScopeSupport

The IOrganization interface is part of the VDoc directory.

Since:

1.0

Version:

1.0, 28/10/2007

Author:

Vassyly Lygeros

See Also:

IUser, IGroup, ILocalization

Method Summary

Modifier and Type	Method and Description
void	addGroups(Collection<? extends IGroup> groups) Add a collection of groups
void	addMembers(Collection<? extends IUser> members) Add a collection of members (IUser objects)
void	addOrganizations(Collection<? extends IOrganization> organizations) Add a collection of child organizations
void	disable() Disable the organization
void	enable() Enable the organization
IUser	getCreatedBy() Gets the creator of the organization.
Date	getCreatedDate() Gets the created date.
String	getCustomType() Returns the type of the organization (company, subsidiary, etc...)
String	getDescription() Returns the description of the organization
Collection<? extends IGroup>	getGroups() Returns the list of groups
String	getLabel() Returns the label of the organization
Collection<? extends IUser>	getMembers() Returns the list of users
IUser	getModifiedBy() Gets the editor of the organization.
Date	getModifiedDate() Gets the modified date.
String	getName() Returns the name of the organization
Collection<? extends IOrganization>	getOrganizations() Returns the list of underneath organizations
IOrganization	getParent() Returns the parent organization
String	getSkin() Returns the skin of the organization
boolean	isEnable() Returns true if the organization is enabled, false otherwise
void	setCustomType(String type) Set the type of the organization (company, subsidiary, etc...)
void	setDescription(String description) Set the description of the organization
void	setLabel(String label) Sets the label of the organization
void	setName(String name) Set the name of the organization
void	setParent(IOrganization parent) Set the parent of the organization
void	setSkin(String skin) Set the name of the skin to be used by default for the organization

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

Method Detail

getName

String getName()

Returns the name of the organization

Returns:

a String object

getLabel

String getLabel()

Returns the label of the organization

Returns:

a String object

getDescription

String getDescription()

Returns the description of the organization

Returns:

the description of the organization

getSkin

String getSkin()

Returns the skin of the organization

Returns:

a String object

getCustomType

String getCustomType()

Returns the type of the organization (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 organization.

Returns:

a IUser object.

getModifiedDate

Date getModifiedDate()

Gets the modified date.

Returns:

a Date object.

getModifiedBy

IUser getModifiedBy()

Gets the editor of the organization.

Returns:

a IUser object.

getOrganizations

Collection<? extends IOrganization> getOrganizations()

Returns the list of underneath organizations

Returns:

a Collection object of IOrganization

getGroups

Collection<? extends IGroup> getGroups()

Returns the list of groups

Returns:

a Collection object of IGroup

getMembers

Collection<? extends IUser> getMembers()

Returns the list of users

Returns:

a Collection object

getParent

IOrganization getParent()

Returns the parent organization

Returns:

a IOrganization object

setName

void setName(String name)

Set the name of the organization

Parameters:

name -

setLabel

void setLabel(String label)

Sets the label of the organization

Parameters:

label -

setDescription

void setDescription(String description)

Set the description of the organization

Parameters:

description -

setSkin

void setSkin(String skin)

Set the name of the skin to be used by default for the organization

Parameters:

skin -

setCustomType

void setCustomType(String type)

Set the type of the organization (company, subsidiary, etc...)

Parameters:

type -

addOrganizations

void addOrganizations(Collection<? extends IOrganization> organizations)

Add a collection of child organizations

Parameters:

organizations -

addGroups

void addGroups(Collection<? extends IGroup> groups)

Add a collection of groups

Parameters:

groups -

addMembers

void addMembers(Collection<? extends IUser> members)

Add a collection of members (IUser objects)

Parameters:

members -

setParent

void setParent(IOrganization parent)

Set the parent of the organization

Parameters:

parent -

isEnable

boolean isEnable()

Returns true if the organization is enabled, false otherwise

Returns:

true if the organization is enabled, false otherwise

enable

void enable()

Enable the organization

disable

void disable()

Disable the organization