Package com.axemble.vdoc.sdk.modules

Interface IBaseDirectoryModule

All Superinterfaces:
IModule, Remote
All Known Subinterfaces:
IDirectoryModule
All Known Implementing Classes:
DirectoryModuleImpl
@Deprecated(since="2026.0.0", forRemoval=true) public interface IBaseDirectoryModule extends IModule
Deprecated, for removal: This API element is subject to removal in a future version.
use com.axemble.vdoc.sdk.modules.IDirectoryModule instead
The directory module interface.

Code sample : 

 // creation of a directory module object
 IBaseDirectoryModule directoryModule = Modules.getDirectoryModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        Modules.releaseModule(directoryModule);
 }

See Also:

  • Method Details

    • getOrganizations

      Collection<? extends IOrganization> getOrganizations(IContext context) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the organizations.
      Parameters:
      context - The execution context.
      Returns:
      A java.util.Collection of IOrganization objects.
      Throws:
      DirectoryModuleException - default module exception.

    • getOrganizations

      Collection<? extends IOrganization> getOrganizations(IContext context, IOrganization parent) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the organizations of a specified IOrganization object.
      Parameters:
      context - The execution context.
      parent - The parent IOrganization object.
      Returns:
      A java.util.Collection of IOrganization objects.
      Throws:
      DirectoryModuleException - default module exception.

    • createOrganization

      @Deprecated IOrganization createOrganization(IContext context, String label) throws DirectoryModuleException
      Deprecated.
      : use createOrganization( IContext context, String name, String label ) method instead.
      Allows to create an organization at the root level.
      Parameters:
      context - The execution context.
      label - The label of the organization. Be aware the system name of the organization will be generated.
      Returns:
      A IOrganization object.
      Throws:
      DirectoryModuleException - default module exception.

    • createOrganization

      IOrganization createOrganization(IContext context, String name, String label) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create an organization at the root level.
      Parameters:
      context - The execution context.
      name - The system name of the organization.
      label - The label of the organization. Be aware the system name of the organization will be generated.
      Returns:
      A IOrganization object.
      Throws:
      DirectoryModuleException - default module exception.

    • createOrganization

      @Deprecated IOrganization createOrganization(IContext context, IOrganization organization, String label) throws DirectoryModuleException
      Deprecated.
      : use createOrganization( IContext context, IOrganization organization, String name, String label ) method instead.
      Allows to create a child organization.
      Parameters:
      context - The execution context.
      organization - The parent IOrganization object.
      label - The label of the organization. Be aware the system name of the organization will be generated.
      Returns:
      A IOrganization object
      Throws:
      DirectoryModuleException - default module exception.

    • createOrganization

      IOrganization createOrganization(IContext context, IOrganization organization, String name, String label) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create a child organization.
      Parameters:
      context - The execution context.
      organization - The parent IOrganization object.
      name - The system name of the organization.
      label - The label of the organization. Be aware the system name of the organization will be generated.
      Returns:
      A IOrganization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getOrganization

      IOrganization getOrganization(IContext context, String name) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves an organization by its system name (the system name is unique on the server).
      Parameters:
      context - The execution context.
      name - The system name of the organization.
      Returns:
      A IOrganization object
      Throws:
      DirectoryModuleException - default module exception.

    • getOrganization

      @Deprecated IOrganization getOrganization(IContext context, IOrganization parent, String name) throws DirectoryModuleException
      Deprecated.
      : use getOrganization(IContext, String) method instead.
      Retrieves an organization by its name and a parent organization.
      Parameters:
      context - The execution context.
      parent - The parent IOrganization object.
      name - The system name of the organization.
      Returns:
      A IOrganization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getOrganizationByPathLabel

      IOrganization getOrganizationByPathLabel(IContext context, String path) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves an organization by its path.
      Parameters:
      context - The execution context.
      path - The path built from the labels.
      Returns:
      A IOrganization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getOrganization

      IOrganization getOrganization(IStorageKey key) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves an organization by its IStorageKey object.
      Parameters:
      key - The storage key object.
      Returns:
      A IOrganization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getLocalizations

      Collection<? extends ILocalization> getLocalizations(IContext context) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the localizations.
      Parameters:
      context - The execution context.
      Returns:
      A java.util.Collection of ILocalization objects.
      Throws:
      DirectoryModuleException - default module exception.

    • getLocalizations

      Collection<? extends ILocalization> getLocalizations(IContext context, ILocalization parent) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the localizations of a ILocalization object.
      Parameters:
      context - The execution context.
      parent - The parent ILocalization object.
      Returns:
      A java.util.Collection of ILocalization objects.
      Throws:
      DirectoryModuleException - default module exception.

    • createLocalization

      @Deprecated ILocalization createLocalization(IContext context, String label) throws DirectoryModuleException
      Deprecated.
      : use createLocalization( IContext context, ILocalization localization, String label ) method instead.
      Allows to create a localization at the root level.
      Parameters:
      context - The execution context.
      label - The label of the localization. Be aware the system name will be generated automatically.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • createLocalization

      ILocalization createLocalization(IContext context, String name, String label) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create a localization at the root level.
      Parameters:
      context - The execution context.
      name - The system name of the localization.
      label - The label of the localization.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • createLocalization

      @Deprecated ILocalization createLocalization(IContext context, ILocalization localization, String label) throws DirectoryModuleException
      Deprecated.
      : use createLocalization( IContext context, ILocalization localization, String name, String label ) method instead.
      Allows to create a child localization.
      Parameters:
      context - The execution context.
      localization - The parent ILocalization object.
      label - The label of the localization. Be aware the system name will be generated automatically.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • createLocalization

      ILocalization createLocalization(IContext context, ILocalization localization, String name, String label) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create a child localization.
      Parameters:
      context - The execution context.
      localization - The parent ILocalization object.
      name - The system name of the localization.
      label - The label of the localization.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getLocalization

      @Deprecated ILocalization getLocalization(IContext context, ILocalization parent, String name) throws DirectoryModuleException
      Deprecated.
      use getLocalization( IContext context, String name ) method instead.
      Retrieves a localization by its system name and a parent localization object.
      Parameters:
      context - The execution context.
      parent - The parent ILocalization object.
      name - The system name of the localization.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getLocalization

      ILocalization getLocalization(IContext context, String name) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a localization by its system name.
      Parameters:
      context - The execution context.
      name - The system name of the localization.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getLocalizationByPathLabel

      ILocalization getLocalizationByPathLabel(IContext context, String path) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a localization by its path.
      Parameters:
      context - The execution context.
      path - The path of the localization built from labels.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getLocalization

      ILocalization getLocalization(IStorageKey key) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a localization object by its IStorageKey object.
      Parameters:
      key - The IStorageKey object.
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • createGroup

      @Deprecated IGroup createGroup(IContext context, IOrganization organization, String label) throws DirectoryModuleException
      Deprecated.
      use createGroup( IContext context, IOrganization organization, String name, String label ) method instead.
      Allows to create a group.
      Parameters:
      context - The execution context.
      organization - The organization object.
      label - The label of the group. Be aware the system name will be automatically generated.
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • createGroup

      IGroup createGroup(IContext context, IOrganization organization, String name, String label) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create a group.
      Parameters:
      context - The execution context.
      organization - The organization object.
      name - The system name of the group.
      label - The label of the group.
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • createGroup

      IGroup createGroup(IContext context, IGroup group, String label) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create a child group.
      Parameters:
      context - The execution context.
      group - The parent group.
      label - The label of the group. Be aware the system name will be generated automatically.
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • createGroup

      IGroup createGroup(IContext context, IGroup group, String name, String label) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create a child group.
      Parameters:
      context - The execution context.
      group - The parent group.
      name - The system name of the group.
      label - The label of the group.
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • getGroup

      @Deprecated IGroup getGroup(IContext context, String name) throws DirectoryModuleException
      Deprecated.
      The system name is not unique on the server scope anymore. You should pass the parent IOrganization object. Use the getGroup( IContext context, IOrganization organization, String name ) method instead.
      Retrieves a group by its system name.
      Parameters:
      context - The execution context.
      name - The system name of the group.
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • getGroup

      IGroup getGroup(IContext context, IOrganization organization, String name) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a group by its system name on an organization scope.
      Parameters:
      context - The execution context.
      organization - The parent IOrganization object.
      name - The system name of the group.
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • getGroup

      IGroup getGroup(IStorageKey key) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a group object by its IStorageKey object.
      Parameters:
      key - The IStorageKey object.
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • createUser

      IUser createUser(IContext context, String login, String password, IOrganization organization) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create a user into an organization.
      Parameters:
      context - The execution context.
      login - The login of the user
      password - The password of the user
      organization - The parent IOrganization object.
      Returns:
      A IUser object.
      Throws:
      DirectoryModuleException - default module exception.

    • getUsers

      Collection<? extends IUser> getUsers(IContext context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the users.
      Parameters:
      context - The execution context.
      Returns:
      A java.util.Collection of IUser objects.

    • getUsers

      Collection<? extends IUser> getUsers(IContext context, IOrganization organization)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the users of a specified organization.
      Parameters:
      context - The execution context.
      organization - The IOrganization object.
      Returns:
      A java.util.Collection of IUser objects.

    • getUsers

      Collection<? extends IUser> getUsers(IContext context, ILocalization localization)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the users of a specified localization.
      Parameters:
      context - The execution context.
      localization - The ILocalization object.
      Returns:
      A java.util.Collection of IUser objects.

    • getUserByLogin

      IUser getUserByLogin(String login)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a user from its login.
      Parameters:
      login - The login of the user.
      Returns:
      A IUser object.

    • getUser

      IUser getUser(IStorageKey key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a user object by its IStorageKey object.
      Parameters:
      key - The IStorageKey object.
      Returns:
      A IUser object.
      Throws:
      DirectoryModuleException - default module exception.

    • createSystemProfile

      IProfile createSystemProfile(IContext context, String name) throws ModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a IProfile.
      Parameters:
      context - The execution context.
      name - The system name of the IProfile to be created.
      Returns:
      a IProfile object.
      Throws:
      ModuleException - default module exception.

    • getSystemProfile

      IProfile getSystemProfile(IContext context, String name) throws ModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a system IProfile object by its system name.
      Parameters:
      context - The execution context.
      name - The system name of the role.
      Returns:
      a IProfile object.
      Throws:
      ModuleException - default module exception.

    • getSystemProfiles

      Collection<? extends IProfile> getSystemProfiles(IContext context) throws ModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves a collection of system IProfile objects.
      Parameters:
      context - The execution context.
      Returns:
      a collection of system IProfile objects.
      Throws:
      ModuleException - default module exception.

    • createAttribute

      @Deprecated IAttribute createAttribute(String name, int type, Object value)
      Deprecated.
      use getExtendedAttributes method instead.
      Allows to create an attribute.
      Parameters:
      name - The name of the attribute.
      type - The type of the attribute. Check the IAttribute.IType interface.
      value - The associated value to the attribute.
      Returns:
      A IAttribute object.

    • getOrganization

      @Deprecated IOrganization getOrganization(Object object) throws DirectoryModuleException
      Deprecated.
      use getOrganization( IStorageKey ) instead
      Retrieves an organization from an object.
      Parameters:
      object - Any object of the following type:
      • A java.lang.Long
      • java.lang.String
      • or com.triactive.jdo.store.OID
      Returns:
      A IOrganization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getLocalization

      @Deprecated ILocalization getLocalization(Object object) throws DirectoryModuleException
      Deprecated.
      use getLocalization( IStorageKey ) instead
      Retrieves an localization from an object.
      Parameters:
      object - Any object of the following type:
      • A java.lang.Long
      • java.lang.String
      • or com.triactive.jdo.store.OID
      Returns:
      A ILocalization object.
      Throws:
      DirectoryModuleException - default module exception.

    • getGroup

      @Deprecated IGroup getGroup(Object object) throws DirectoryModuleException
      Deprecated.
      use getGroup( IStorageKey ) instead
      Retrieves a group from an object.
      Parameters:
      object - Any object of the following type:
      • A java.lang.Long
      • java.lang.String
      • or com.triactive.jdo.store.OID
      Returns:
      A IGroup object.
      Throws:
      DirectoryModuleException - default module exception.

    • getUser

      @Deprecated IUser getUser(Object object) throws DirectoryModuleException
      Deprecated.
      use getUser( IStorageKey ) instead
      Retrieves a user from an object.
      Parameters:
      object - Any object of the following type:
      • A java.lang.Long
      • java.lang.String
      • or com.triactive.jdo.store.OID
      Returns:
      A IUser object.
      Throws:
      DirectoryModuleException - default module exception.

    • getElement

      IElement getElement(Object object) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves an IElement object from an object.
      Parameters:
      object - Any object of the following type:
      • A java.lang.Long
      • java.lang.String
      • or com.triactive.jdo.store.OID
      Returns:
      A IElement object.
      Throws:
      DirectoryModuleException - default module exception.

    • addChild

      void addChild(IGroup child, IGroup group) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds a child group.
      Parameters:
      child - The child group.
      group - The parent group.
      Throws:
      DirectoryModuleException - default module exception.

    • removeChild

      void removeChild(IGroup child, IGroup group) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes a child group object.
      Parameters:
      child - The child group.
      group - The parent group.
      Throws:
      DirectoryModuleException - default module exception.

    • isChildOf

      boolean isChildOf(IGroup child, IGroup parent, boolean recursive)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if the group is child of another group.
      Parameters:
      child - The child group.
      parent - The parent group.
      recursive - if true checks recursively.
      Returns:
      true if the group is child of the parent group, false otherwise.

    • getParents

      Collection<? extends IGroup> getParents(IGroup group)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the direct parents of a specified group object.
      Parameters:
      group - The group to search for.
      Returns:
      A java.util.Collection of IGroup objects.

    • getAllParents

      Collection<? extends IGroup> getAllParents(IGroup group)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the parents of a specified group object.
      Parameters:
      group - The group to search for.
      Returns:
      A java.util.Collection of IGroup objects.

    • getChildren

      Collection<? extends IGroup> getChildren(IGroup group)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the children of a specified group object.
      Parameters:
      group - The group to search for.
      Returns:
      A java.util.Collection of IGroup objects.

    • getAllChildren

      Collection<? extends IGroup> getAllChildren(IGroup group)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the children of a specified group object.
      Parameters:
      group - The group to search for.
      Returns:
      A java.util.Collection of IGroup objects.

    • addMember

      void addMember(IUser user, IGroup group) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds a user to a group.
      Parameters:
      user - The user object to add.
      group - The parent group.
      Throws:
      DirectoryModuleException - default module exception.

    • removeMember

      void removeMember(IUser user, IGroup group) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes a user from a group.
      Parameters:
      user - The user object to add.
      group - The parent group.
      Throws:
      DirectoryModuleException - default module exception.

    • isMemberOf

      boolean isMemberOf(IUser user, IGroup group, boolean recursive)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if a user is member of a group.
      Parameters:
      user - The user
      group - The group
      recursive - if true checks recursively.
      Returns:
      true if the user is member of the group, false otherwise.

    • getParents

      Collection<? extends IGroup> getParents(IUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the parents of a specified user.
      Parameters:
      user - The user to search for.
      Returns:
      A java.util.Collection of IGroup objects.

    • getAllParents

      Collection<? extends IGroup> getAllParents(IUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the parents of a specified user.
      Parameters:
      user - The user to search for.
      Returns:
      A java.util.Collection of IGroup objects.

    • getMembers

      Collection<? extends IUser> getMembers(IGroup group)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the members of the group.
      Parameters:
      group - The group.
      Returns:
      A java.util.Collection of IUser objects.

    • getAllMembers

      Collection<? extends IUser> getAllMembers(IGroup group)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all the members of the group.
      Parameters:
      group - The group.
      Returns:
      A java.util.Collection of IUser objects.

    • getElementByProtocolURI

      IProtocolSupport getElementByProtocolURI(String protocolURI) throws ModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets an IElement object which implements IProtocolSupport interface.
      Parameters:
      protocolURI - The protocol URI as a java.lang.String.
      Returns:
      A IProtocolSupport object.
      Throws:
      ModuleException - default module exception.

    • getSearchController

      ISearchController getSearchController() throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      DirectoryModuleException

    • getSearchController

      @Deprecated ISearchController getSearchController(IJdbcReference reference) throws DirectoryModuleException
      Deprecated.
      use getSearchController( IConnectionDefinition connectionDefinition ) method instead.
      Gets a search controller object by specifying a JDBC external reference.
      Parameters:
      reference - The IJdbcReference object.
      Returns:
      The ISearchController object.
      Throws:
      DirectoryModuleException - default module exception.

    • getSearchController

      ISearchController getSearchController(IConnectionDefinition connectionDefinition) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets a search controller object by specifying a
      invalid reference 
      ConnectionDefinition
      object.
      Parameters:
      connectionDefinition - The IConnectionDefinition object.
      Returns:
      A ISearchController object.
      Throws:
      DirectoryModuleException - Default module exception.

    • getSearchController

      ISearchController getSearchController(IDataSourceReference reference) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets a search controller object by specifying a IDataSourceReference object.
      Parameters:
      reference - The IDataSourceReference object.
      Returns:
      A ISearchController object.
      Throws:
      DirectoryModuleException - Default module exception.

    • getSecurityController

      ISecurityController getSecurityController(ISecuritySupport securitySupport) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets a security controller to manipulate the rights on a specified object.
      Parameters:
      securitySupport - Any ISecuritySupport object.
      Returns:
      A ISecurityController object.
      Throws:
      DirectoryModuleException - Default module exception.

    • getTransformer

      ITransformer getTransformer() throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets a transformer.
      Returns:
      A ITransformer object.
      Throws:
      DirectoryModuleException - Default module exception.

    • getDirectoryTransformer

      IDirectoryTransformer getDirectoryTransformer() throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets a directory transformer.
      Returns:
      A IDirectoryTransformer object.
      Throws:
      DirectoryModuleException - Default module exception.

    • createAttachment

      IAttachment createAttachment(IContext context, String fileName, InputStream input)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create an IAttachment object from a file name and an input stream.
      Parameters:
      context - The execution context.
      fileName - A java.lang.String value.
      input - An InputStream object.
      Returns:
      A IAttachment object.

    • createAttachment

      IAttachment createAttachment(IContext context, File file)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create an IAttachment object from a java.io.File object.
      Parameters:
      context - The execution context.
      file - A java.io.File object.
      Returns:
      A IAttachment object.

    • createAttachment

      IAttachment createAttachment(IContext context, File file, boolean canBeRemoved)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows to create an IAttachment object from a java.io.File object.
      Parameters:
      context - The execution context.
      file - A java.io.File object.
      canBeRemoved - Specifies if the local file should be removed.
      Returns:
      A IAttachment object.

    • createAttachment

      IAttachment createAttachment(IContext context, String fileName, byte[] bytes)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Parameters:
      context - The execution context.
      fileName - A java.lang.String value.
      bytes - The content of the attachment as a byte array.
      Returns:
      A IAttachment object.

    • getResourceDefinition

      IResourceDefinition getResourceDefinition(IContext context, String name) throws DirectoryModuleException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets an extended attributes table
      Parameters:
      context -
      name - of the table
      Returns:
      A IResourceDefinition table
      Throws:
      DirectoryModuleException

    • addLocalizationScope

      void addLocalizationScope(ILocalizationScopeSupport localizationScopeSupport, ILocalization localization, boolean heritable)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add localizationScope to the localizationScopeSupport object
      Parameters:
      localizationScopeSupport -
      localization -
      heritable -

    • getLocalizationScopes

      Collection<? extends IDirectoryLocalizationScope> getLocalizationScopes(ILocalizationScopeSupport localizationScopeSupport)
      Deprecated, for removal: This API element is subject to removal in a future version.
      get the localizationScopes for the localizationScopeSupport object
      Parameters:
      localizationScopeSupport -
      Returns:
      a Collection object of IDirectoryLocalizationScope

    • removeLocalizationScope

      void removeLocalizationScope(ILocalizationScopeSupport localizationScopeSupport, IDirectoryLocalizationScope directoryLocalizationScope)
      Deprecated, for removal: This API element is subject to removal in a future version.
      remove the localizationScope to the localizationScopeSupport object
      Parameters:
      localizationScopeSupport -
      directoryLocalizationScope -

    • restoreLocalizationScopeInheritance

      void restoreLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)
      Deprecated, for removal: This API element is subject to removal in a future version.
      restore the localizationScope inheritance for the localizationScopeSupport object
      Parameters:
      localizationScopeSupport -

    • breakLocalizationScopeInheritance

      void breakLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)
      Deprecated, for removal: This API element is subject to removal in a future version.
      break the localizationScope inheritance for the localizationScopeSupport object
      Parameters:
      localizationScopeSupport -

    • isLocalizationScopeInherited

      boolean isLocalizationScopeInherited(ILocalizationScopeSupport localizationScopeSupport)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if the localization scope is inherited
      Parameters:
      localizationScopeSupport -
      Returns:
      true if the localization scope is inhe

    • addOrganizationScope

      void addOrganizationScope(IUser user, IOrganization organization, boolean heritable)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add OrganizationScope to the User object
      Parameters:
      user -
      organization -
      heritable -

    • getOrganizationScopes

      Collection<? extends IDirectoryOrganizationScope> getOrganizationScopes(IUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the OrganizationScope for the User object
      Parameters:
      user -
      Returns:
      a Collection object of IDirectoryOrganizationScope

    • removeOrganizationScope

      void removeOrganizationScope(IUser user, IDirectoryOrganizationScope directoryOrganizationScope)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes the directoryOrganizationScope to the user's OrganizationScope
      Parameters:
      user -
      directoryOrganizationScope -

    • restoreOrganizationScopeInheritance

      void restoreOrganizationScopeInheritance(IUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      restore the organizationScope inheritance for the user object
      Parameters:
      user -

    • breakOrganizationScopeInheritance

      void breakOrganizationScopeInheritance(IUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      break the organizationScope inheritance for the user object
      Parameters:
      user -

    • isOrganizationScopeInherited

      boolean isOrganizationScopeInherited(IUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      is organizationScope inheritance
      Parameters:
      user -
      Returns:
      isOrganizationScopeInherited

    • getLocalizationPathLabel

      String getLocalizationPathLabel(ILocalization localization)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Generate path label of the localization "/" in label will replaced by "\\/"
      Parameters:
      localization -
      Returns:
      localization path label

    • getOrganizationPathLabel

      String getOrganizationPathLabel(IOrganization organization)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Generate path label of the organization "/" in label will replaced by "\\/"
      Parameters:
      organization -
      Returns:
      organization path label

    • getCatalog

      ICatalog getCatalog()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the extended attributes catalog
      Returns:
      ICatalog the extended attributes catalog