Package com.axemble.vdoc.sdk.modules

Interface IModule

All Superinterfaces:
Remote
All Known Subinterfaces:
IBaseDirectoryModule, IBaseDocumentModule, IBaseIndexationModule, IBaseLibraryModule, IBasePortalModule, IBaseSiteModule, IBaseWorkflowModule, IDirectoryModule, IDocumentModule, IIndexationModule, ILibraryModule, IPortalModule, IProjectModule, ISiteModule, IWorkflowModule
All Known Implementing Classes:
CoreModule, DirectoryModuleImpl, EzsSiteModule, IndexationModuleImpl, PortalLibraryModule, PortalModule, PortalModuleImpl, PortalModuleImpl.JDOPortalModule, com.axemble.vdoc.sdk.impl.ProcessWorkflowModule, ProjectModuleImpl, ReportProcessWorkflowModule, WorkflowModuleImpl
public interface IModule extends Remote
Author:
vlygeros

  • Method Details

    • initialize

      @Deprecated void initialize(Properties properties)
      Deprecated.
      Use com.axemble.vdoc.sdk.Modules.getXXXModule( Properties properties ) instead.
      Initializes the module.
      Parameters:
      properties - The custom properties.

    • unInitialize

      @Deprecated void unInitialize()
      Deprecated.
      Use com.axemble.vdoc.sdk.Modules.releaseModule( IModule module ) instead.
      Releases the module.

    • findNativeClass

      Class<?> findNativeClass(Class<?> interfaceClass)
      Allows to retrieve the inner native class.
      Parameters:
      interfaceClass - A class type.
      Returns:
      The inner native class.

    • getContext

      IContext getContext(String externalID)
      Gets a context from the external identifier.
      Parameters:
      externalID - The external identifier.
      Returns:
      A IContext object.

    • getContext

      IContext getContext(IUser user)
      Gets a context form a IUser object.
      Parameters:
      user - a IUser object.
      Returns:
      A IContext object.

    • getContextByLogin

      IContext getContextByLogin(String login)
      Gets a context from the user's login.
      Parameters:
      login - The user's login.
      Returns:
      A IContext object.

    • getSysadminContext

      IContext getSysadminContext()
      Gets the context of sysadmin.
      Returns:
      A IContext object.

    • getAnonymousContext

      IContext getAnonymousContext()
      Gets the context of anonymous.
      Returns:
      A IContext object.

    • getSysadmin

      IUser getSysadmin()
      Gets the sysadmin user.
      Returns:
      A IUser object.

    • getAnonymous

      IUser getAnonymous()
      Gets the anonymous user.
      Returns:
      A IUser object.

    • getLoggedOnUserContext

      IContext getLoggedOnUserContext()
      Retrieves the context of the logged on user
      Returns:
      a IContext object.

    • getLoggedOnUserLanguage

      String getLoggedOnUserLanguage()
      Retrieves the logged on user language or default to server default
      Returns:
      user friendly language.

    • getLoggedOnUser

      IUser getLoggedOnUser()
      Retrieves the current logged on user.
      Returns:
      a IUser object.

    • convertId

      IStorageKey convertId(Object object)
      Allows to convert any object to its IStorageKey object.
      Parameters:
      object - Any form of the object.
      Returns:
      a IStorageKey object.

    • beginTransaction

      @Deprecated IReport beginTransaction(Object object)
      Deprecated.
      use beginTransaction() method without parameter instead.
      Starts a new transaction if required.
      Parameters:
      object - The synchronized object. Not used anymore.
      Returns:
      The report object.

    • commitTransaction

      @Deprecated void commitTransaction(Object object)
      Deprecated.
      use commitTransaction() method without parameter instead.
      Commits the current transaction.
      Parameters:
      object - The synchronized object. Not used anymore.

    • rollbackTransaction

      @Deprecated void rollbackTransaction(Object object)
      Deprecated.
      use rollbackTransaction() method without parameter instead.
      Roll back the current transaction.
      Parameters:
      object - The synchronized object. Not used anymore.

    • beginTransaction

      IReport beginTransaction()
      Starts a new transaction or use the current one.
      Returns:
      The report object.

    • commitTransaction

      void commitTransaction()
      Commits the current transaction.

    • rollbackTransaction

      void rollbackTransaction()
      Roll back the current transaction.

    • isTransactionActive

      boolean isTransactionActive()
      Checks if there is a current transaction.
      Returns:
      true if a transaction has been started, false otherwise.

    • setTransactionTimeout

      void setTransactionTimeout(int transactionTimeout) throws ModuleException
      Allows the set the transaction timeout.
      Parameters:
      transactionTimeout - The transaction timeout in milliseconds.
      Throws:
      ModuleException - The default exception.

    • getTranslationForLanguage

      String getTranslationForLanguage(String language, String key, String... args)
      Retrieves a java.lang.String for the specified language from the key using static strings and dynamic localizations.
      Parameters:
      key -
      Returns:
      the translated string.

    • getTranslation

      String getTranslation(String key, String... args)
      Retrieves a java.lang.String from the key using static strings and dynamic localizations. Based on the retrieved locale from context.
      Parameters:
      key -
      Returns:
      the translated string.

    • getTranslationKey

      String getTranslationKey(IProtocolSupport domainLocalizable, String localizationKey, String localizationSubName, String localizationSubKey)
      Generates a java.lang.String symbolyzing the key to use for translating this localizable with the specified localizationKey, localizationSubName and localizationSubKey.
      Parameters:
      domainLocalizable -
      localizationKey -
      localizationSubName -
      localizationSubKey -
      Returns:
      the translation key

    • getStaticString

      String getStaticString(IDynamicLocalizationsWrapper localizationsWrapper)
      Retrieves a java.lang.String form the localizationsWrapper.
      Parameters:
      localizationsWrapper - IDynamicLocalizationsWrapper object
      Returns:
      The translated string.

    • getStaticString

      String getStaticString(String entryID)
      Retrieves a java.lang.String form the string resources XML files.
      Parameters:
      entryID - The key.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, String arg1)
      Retrieves a java.lang.String from the string resources XML files using one argument.
      Parameters:
      entryID - The key.
      arg1 - The argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, String arg1, String arg2)
      Retrieves a java.lang.String from the string resources XML files using two arguments.
      Parameters:
      entryID - The key.
      arg1 - The first argument (%1) contained in the resource string.
      arg2 - The second argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, String arg1, String arg2, String arg3)
      Retrieves a java.lang.String from the string resources XML files using three arguments.
      Parameters:
      entryID - The key.
      arg1 - The first argument (%1) contained in the resource string.
      arg2 - The second argument (%1) contained in the resource string.
      arg3 - The third argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, String arg1, String arg2, String arg3, String arg4)
      Retrieves a java.lang.String from the string resources XML files using four arguments.
      Parameters:
      entryID - The key.
      arg1 - The first argument (%1) contained in the resource string.
      arg2 - The second argument (%1) contained in the resource string.
      arg3 - The third argument (%1) contained in the resource string.
      arg4 - The fourth argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, Locale locale, String arg1)
      Retrieves a java.lang.String from the string resources XML files using one argument and specifying the local.
      Parameters:
      entryID - The key.
      locale - The Locale to use.
      arg1 - The argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, Locale locale, String arg1, String arg2)
      Retrieves a java.lang.String from the string resources XML files using two arguments and specifying the local.
      Parameters:
      entryID - The key.
      locale - The Locale to use.
      arg1 - The first argument (%1) contained in the resource string.
      arg2 - The second argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, Locale locale, String arg1, String arg2, String arg3)
      Retrieves a java.lang.String from the string resources XML files using three arguments and specifying the local.
      Parameters:
      entryID - The key.
      locale - The Locale to use.
      arg1 - The first argument (%1) contained in the resource string.
      arg2 - The second argument (%1) contained in the resource string.
      arg3 - The third argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, Locale locale, String arg1, String arg2, String arg3, String arg4)
      Retrieves a java.lang.String from the string resources XML files using fourth arguments and specifying the local.
      Parameters:
      entryID - The key.
      locale - The Locale to use.
      arg1 - The first argument (%1) contained in the resource string.
      arg2 - The second argument (%1) contained in the resource string.
      arg3 - The third argument (%1) contained in the resource string.
      arg4 - The third argument (%1) contained in the resource string.
      Returns:
      The resource string.

    • getStaticString

      String getStaticString(String entryID, Locale locale)
      Retrieves a java.lang.String from the string resources XML files and specifying the local.
      Parameters:
      entryID - The key.
      locale - The Locale to use.
      Returns:
      The resource string.

    • getProtocolURI

      String getProtocolURI(Object object) throws ModuleException
      Retrieves the protocol URI of an object.
      Parameters:
      object - The object to retrieve the protocol URI from.
      Returns:
      A java.lang.String value.
      Throws:
      ModuleException - The default exception.

    • getProtocolURI

      String getProtocolURI(Object object, boolean useNames) throws ModuleException
      Retrieves the protocol URI of an object by using names or not.
      Parameters:
      object - The object to retrieve the protocol URI from.
      useNames - Uses names or not.
      Returns:
      A java.lang.String value.
      Throws:
      ModuleException - The default exception.

    • getProtocolPath

      String getProtocolPath(Object object) throws ModuleException
      Retrieves the protocol path of an object.
      Parameters:
      object - The object to retrieve the protocol path from.
      Returns:
      A java.lang.String value.
      Throws:
      ModuleException - The default exception.

    • getProtocolPath

      String getProtocolPath(Object object, String language) throws ModuleException
      Retrieves the protocol path of an object by specifying the language.
      Parameters:
      object - The object to retrieve the protocol path from.
      language - The requested language.
      Returns:
      A java.lang.String value.
      Throws:
      ModuleException - The default exception.

    • getExternalElement

      ExternalElement getExternalElement(Object object) throws ModuleException
      Retrieves the externalElement of an object
      Parameters:
      object - The object to retrieve the external element from
      Returns:
      A com.axemble.vdoc.sdk.structs.ExternalElement value.
      Throws:
      ModuleException - The default exception.

    • getExternalElement

      ExternalElement getExternalElement(Object object, String language) throws ModuleException
      Retrieves the externalElement of an object by specifying the language.
      Parameters:
      object - The object to retrieve the external element from
      language - The requested language.
      Returns:
      A com.axemble.vdoc.sdk.structs.ExternalElement value.
      Throws:
      ModuleException - The default exception.

    • getElementFromExternalElement

      Object getElementFromExternalElement(ExternalElement externalElement) throws ModuleException
      Retrieves the object of externalElement
      Parameters:
      externalElement - The externalElement to retrieve the object from
      Returns:
      A java.lang.Object value.
      Throws:
      ModuleException - The default exception.

    • generateSystemName

      String generateSystemName(String label)
      Generate a valid system name for this module and this label.
      Parameters:
      label - label to normalize
      Returns:
      normalized value