Interface Project

All Superinterfaces:
Comparable<Project>, Lockable

public interface Project extends Comparable<Project>, Lockable
FirstSpirit project.
Since:
2.3
  • Field Details

    • FONTS

      static final String FONTS
      Property name for font definitions.
      Since:
      4.0.17
      See Also:
    • DEFAULT_ADMIN_GROUP_NAME

      static final String DEFAULT_ADMIN_GROUP_NAME
      Default name for the administrators group.
      Since:
      4.0.17
      See Also:
    • DEFAULT_EVERYONE_GROUP_NAME

      static final String DEFAULT_EVERYONE_GROUP_NAME
      Default name for the everyone group.
      Since:
      4.0.17
      See Also:
    • EXTERNAL_SYNCHRONISATION_GROUP_NAME

      static final String EXTERNAL_SYNCHRONISATION_GROUP_NAME
      External Synchronisation group name. Members in this group are allowed to use the external synchronisation function.
      Since:
      5.1.206
      See Also:
    • LAST_DEPLOYMENT_OK

      static final int LAST_DEPLOYMENT_OK
      Code for indicating a successful deployment.
      Since:
      4.0.17
      See Also:
    • LAST_DEPLOYMENT_NOT_OK

      static final int LAST_DEPLOYMENT_NOT_OK
      Code for indicating an unsuccessful deployment.
      Since:
      4.0.17
      See Also:
    • STRATEGY_IGNORE_NOT_TRANSLATED

      static final int STRATEGY_IGNORE_NOT_TRANSLATED
      Translation strategy
      Since:
      2.3
      See Also:
    • STRATEGY_REPLACE_NOT_TRANSLATED_WITH_MASTER_LANGUAGE

      static final int STRATEGY_REPLACE_NOT_TRANSLATED_WITH_MASTER_LANGUAGE
      Translation strategy
      Since:
      2.3
      See Also:
    • STRATEGY_REPLACE_NOT_TRANSLATED_WITH_SPECIAL_PAGE

      static final int STRATEGY_REPLACE_NOT_TRANSLATED_WITH_SPECIAL_PAGE
      Translation strategy
      Since:
      2.3
      See Also:
    • DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS_WARNING_COUNT_NOT_EXCEEDED

      static final int DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS_WARNING_COUNT_NOT_EXCEEDED
      Deployment error condition
      Since:
      2.3
      See Also:
    • DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS

      static final int DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS
      Deployment error condition
      Since:
      2.3
      See Also:
    • DEPLOY_IF_ZERO_FATALS

      static final int DEPLOY_IF_ZERO_FATALS
      Deployment error condition
      Since:
      2.3
      See Also:
    • CUSTOM_PROPERTY_IMPORT_IDMAP

      static final String CUSTOM_PROPERTY_IMPORT_IDMAP
      Property to get ImportId map (Map<String, String>) via getCustomProperties(IMPORT_IDMAP)
      Since:
      4.1.10
      See Also:
    • CUSTOM_PROPERTY_IMPORT_LAYERMAP

      static final String CUSTOM_PROPERTY_IMPORT_LAYERMAP
      Property to get import layer mapping (Map<String, String>) via getCustomProperties(IMPORT_IDMAP)
      Since:
      4.1.16
      See Also:
    • CUSTOM_PROPERTY_IMPORT_SOURCE_INFOS

      static final String CUSTOM_PROPERTY_IMPORT_SOURCE_INFOS
      Property to get source server and project infos of an imported project (Map<String, String>) via getCustomProperties(IMPORT_IDMAP)
      Since:
      4.1.16
      See Also:
  • Method Details

    • getName

      @NotNull String getName()
      Get the unique project name
      Returns:
      The name
      Since:
      2.3
    • setName

      void setName(@NotNull String name)
      Sets the name of the project
      Parameters:
      name - the new name
      Since:
      2.3
    • getDescription

      @Nullable String getDescription()
      Gets the description of the project
      Returns:
      the description
      Since:
      2.3
    • setDescription

      void setDescription(@Nullable String description)
      Sets the description of the project
      Parameters:
      description - the new description. If null, the description is set to an empty string.
      Since:
      2.3
    • getLanguages

      List<Language> getLanguages()
      Returns a list of all project Languages. These languages are used to edit the language-dependent content of the project. Project and editorial languages don't have to be asubset of each other, they even can be completely disjunctive.
      Returns:
      list of (content) Languages.
      Since:
      4.0.17
      See Also:
    • setLanguages

      void setLanguages(List<Language> languages)
      Sets all projects languages. These languages are used to edit the language-dependent content of the project. Project and editorial languagesdon't have to be a subset of each other, they even can be completely disjunctive.
      Parameters:
      languages - list of (content) Languages, master language must be first.
      Since:
      4.0.17
    • getLanguage

      @Nullable Language getLanguage(String abbreviation)
      Get the content language with the specified abbreviation.
      Parameters:
      abbreviation - see Language.getAbbreviation()
      Returns:
      the language with the provided abbreviation or null if there is no matching language
      Since:
      4.0.63
    • addLanguage

      void addLanguage(Language language)
      Adds a project language to the project
      Parameters:
      language - the language
      Since:
      2.3
    • removeLanguage

      void removeLanguage(Language language)
      Removes a project language from the project
      Parameters:
      language - the language
      Since:
      2.3
    • getMasterLanguage

      Language getMasterLanguage()
      Gets the master language.
      Returns:
      the master language
      Since:
      4.0.17
    • getEditorialLanguages

      List<Language> getEditorialLanguages()
      Returns the list of editorial language for this project. These languages are used to edit language dependent display names. Editorial and project languages don't have to be a subset of eachother, they even can be completely disjunctive.
      Returns:
      the editorial languages for this project
      Since:
      4.0.29
      See Also:
    • addEditorialLanguage

      void addEditorialLanguage(Language language)
      Adds the given language to the list of editorial languages of this project.
      Parameters:
      language - the language to add to editorial languages
      Since:
      4.0.29
    • removeEditorialLanguage

      void removeEditorialLanguage(Language language)
      Removes the given language from the list of editorial languages of this project.
      Parameters:
      language - the language to remove
      Since:
      4.0.29
    • showReferenceNames

      boolean showReferenceNames()
      Indicates whether reference names should be shown (e.g. in create dialogs) for this project or not.
      Returns:
      true if reference names should be shown, false otherwise
      Since:
      4.0.29
    • setShowReferenceNames

      void setShowReferenceNames(boolean showRefNames)
      Sets the show reference name parameter for this project which indicates wether reference names should be shown or not (e.g. in create dialogs).
      Parameters:
      showRefNames - true to show reference names, false to hide reference names
      Since:
      4.0.29
      See Also:
    • getOriginalResolution

      Resolution getOriginalResolution()
      Provides the resolution definition for requesting images in their original dimensions.
      Returns:
      The original resolution.
      Since:
      2.3.15
    • setMasterLanguage

      void setMasterLanguage(Language language)
      Set master language of the project
      Parameters:
      language - the new master language
      Since:
      2.3
    • getResolutions

      List<Resolution> getResolutions()
      Get all resolutions of this project.
      Returns:
      resolutions of this project
      Since:
      4.0.17
    • setResolutions

      void setResolutions(Resolution[] resolutions)
      Set the Resolutions of this project
      Parameters:
      resolutions - A vector containing resolutions
      Since:
      4.0.17
      See Also:
    • getResolutionByName

      @Nullable Resolution getResolutionByName(String name)
      Returns the resolution with the given name or null if no resolution exists in this project with the specified name.
      Parameters:
      name - name to specifiy the resolution
      Returns:
      resolution with the given name or null
      Since:
      4.0.17
    • createResolution

      Resolution createResolution(String name, String description)
      Create a new resolution
      Returns:
      the new resolution
      Since:
      2.3
    • removeResolution

      void removeResolution(Resolution resolution)
      Remove resolution
      Parameters:
      resolution - the resolution to remove
      Since:
      2.3
    • isActive

      boolean isActive()
      Is this project active
      Returns:
      Is active
      Since:
      2.3
    • getGroups

      @NotNull List<Group> getGroups()
      Returns a list of all groups of this project.
      Returns:
      list of groups
      Since:
      4.0.17
    • getGroups

      @NotNull List<Group> getGroups(User user)
      Returns a list of groups of this project where the given user belongs to (at least EVERYONE),or null if the given user isn't allowed to access this project.
      Returns:
      list of Groups
      Since:
      4.0.17
    • getGroupsArray

      Group[] getGroupsArray(User user)
      Returns groups of this project where the user belongs to (at least EVERYONE).
      Parameters:
      user - User.
      Returns:
      project groups where the user belongs to.
      Since:
      4.0.17
    • removeGroup

      void removeGroup(Group group)
      Remove a group
      Parameters:
      group - the group
      Since:
      2.3
    • createGroup

      Group createGroup(String name)
      Adds an empty internal group to this project.
      Parameters:
      name - unique name of the group
      Returns:
      the new group
      Throws:
      IllegalArgumentException - if a group with this name already exists.
      Since:
      2.3
    • createExternalGroup

      Group createExternalGroup(String name, String externalName)
      Adds an external group to this project.
      Parameters:
      name - unique name of the group.
      externalName - external name (or identifier) of the group.
      Returns:
      the new group.
      Throws:
      IllegalArgumentException - if a group with this name already exists.
      Since:
      4.0.17
    • isAdmin

      boolean isAdmin(User user)
      Returns true if the given user is server admin or member of aproject's admin-group.
      Parameters:
      user - to test for project admin.
      Returns:
      true if the given user is admin or member of a project admin-group.
      Since:
      4.0.17
    • isMember

      boolean isMember(User user)
      Indicates whether the given user is member of this project. Returns true if
      Parameters:
      user - user to test.
      Returns:
      true if the given user is member of this project.
      Since:
      4.0.17
    • getUsers

      List<User> getUsers()
      Returns a list of all users
      Returns:
      list of all users
      Since:
      4.0.17
    • addUser

      void addUser(User user)
      Add an user to the project and giving him the access right for this project. This changes needs to be propagated to the server by calling Lockable.save()
      Parameters:
      user - the user to add
      Since:
      2.3
      See Also:
    • removeUser

      void removeUser(User user)
      Remove user from project
      Parameters:
      user - the user to remove
      Since:
      2.3
    • accessAllowed

      boolean accessAllowed(User user)
      Is a user allowed to acces the project
      Parameters:
      user - the user
      Returns:
      access allowed
      Since:
      2.3
      See Also:
    • getTemplateSets

      @NotNull List<TemplateSet> getTemplateSets()
      Get all TemplateSets of this project.
      Returns:
      an unmodifiable list containing TemplateSets
      Since:
      4.0.17
      See Also:
    • addTemplateSet

      void addTemplateSet(TemplateSet templateSet)
      Adds a TemplateSet.
      Parameters:
      templateSet - the TemplateSet to add
      Since:
      4.0.17
      See Also:
    • removeTemplateSet

      void removeTemplateSet(TemplateSet templateSet)
      Remove TemplateSet.
      Parameters:
      templateSet - the TemplateSet to remove
      Since:
      2.3
      See Also:
    • createTemplateSet

      TemplateSet createTemplateSet()
      Create a new TemplateSet
      Returns:
      the TemplateSet
      Since:
      2.3
    • setProjectLogo

      void setProjectLogo(InputStream data) throws IOException
      Set the project logo
      Parameters:
      data - the stream containing the logo. supported image formats: GIF or JPEG.
      Throws:
      IOException - connection or save problem
      Since:
      2.3
    • getProjectLogo

      InputStream getProjectLogo() throws IOException
      Return the project logo
      Returns:
      the project logo
      Throws:
      IOException - connection problem
      Since:
      4.0.17
    • hasProjectLogo

      boolean hasProjectLogo()
      Checks if a logo exists for this project.
      Returns:
      true if a logo exists, false otherwise
      Since:
      5.0.20
    • removeProjectLogo

      void removeProjectLogo()
      Remove the project logo
      Since:
      2.3
    • getSecureMediaFolder

      @Nullable String getSecureMediaFolder()
      Get the uid of the secure media folder. All elements in this folder are considered as to be secured. A null value means no secure folder is defined.
      Returns:
      uid of the secure media folder or null if no secure media folder is defined
      Since:
      4.0.24
    • getPermissionVariable

      String getPermissionVariable()
      Get Metadata variable permissions
      Returns:
      Metadata variable permissions
      Since:
      3.1.158
    • setSecureMediaFolder

      void setSecureMediaFolder(String folderUid)
      Set fodler used for secure media
      Parameters:
      folderUid - Metadata folderUid used for secure media
      Since:
      4.0.24
    • setPermissionVariable

      void setPermissionVariable(String variable)
      Set Metadata variable used for permissions
      Parameters:
      variable - Metadata variable used for permissions
      Since:
      3.1.158
    • getSecureAccessURL

      String getSecureAccessURL()
      Get URL for secure media access
      Returns:
      URL for secure media access
      Since:
      2.3.13
    • setSecureAccessURL

      void setSecureAccessURL(String secureAccessURL)
      Set URL for secure media access
      Parameters:
      secureAccessURL - URL for secure media access
      Since:
      2.3.13
    • getSecureDefaultAllow

      boolean getSecureDefaultAllow()
      Default allow if no permissions are configured
      Returns:
      allow access if no permission are configured
      Since:
      4.0.25
    • setSecureDefaultAllow

      void setSecureDefaultAllow(boolean allow)
      Set default allow access if no permissions are configured.
      Parameters:
      allow - default allow access
      Since:
      4.0.25
    • useWebEdit

      boolean useWebEdit()
      Should Webedit be used
      Returns:
      Should Webedit be used
      Since:
      3.0.67
    • getWebEditTemplateSet

      @Nullable TemplateSet getWebEditTemplateSet()
      the templateset for webedit
      Returns:
      the webeditTemplateSet
      Since:
      3.0.67
    • getWebEditTemplateSetIndex

      int getWebEditTemplateSetIndex()
      the index of the webedit templateset
      Returns:
      the index
      Since:
      3.0.69
    • setWebEditTemplateSet

      void setWebEditTemplateSet(TemplateSet webEditTemplateSet)
      sets the templateSet for webedit
      Parameters:
      webEditTemplateSet - the templateSet for webedit
      Since:
      3.0.67
    • setUseWebEdit

      void setUseWebEdit(boolean useWebEdit)
      Set Webedit use
      Parameters:
      useWebEdit - webedit use
      Since:
      3.0.67
    • useWebeditApplet

      @Deprecated boolean useWebeditApplet()
      Deprecated.
      since 5.0 - no replacement
      Use applet for editor rendering. NOP - Does nothing, always returns false.
      Returns:
      Use applet for editor rendering.
      Since:
      4.0.17
    • setUseWebeditApplet

      @Deprecated void setUseWebeditApplet(boolean useApplet)
      Deprecated.
      since 5.0 - no replacement
      NOP - Does nothing.
      Since:
      4.0.17
    • getAppletEditors

      @Deprecated List<String> getAppletEditors()
      Deprecated.
      since 5.0 - no replacement
      Get editor types rendered as applets. NOP - Does nothing, always returns empty list.
      Since:
      4.0.17
    • setAppletEditors

      @Deprecated void setAppletEditors(List<String> editors)
      Deprecated.
      since 5.0 - no replacement
      Get editor types rendered as applets. NOP - Does nothing.
      Since:
      4.0.17
    • setAllowEveryone

      void setAllowEveryone(boolean allowEveryone)
      Defines to allow everyone to access this project.
      Parameters:
      allowEveryone - true, to allow everyone.
      Since:
      2.3.14
    • getAllowEveryone

      boolean getAllowEveryone()
      Indicates whether everyone is allowed to access this project.
      Returns:
      true, if everyone has access.
      Since:
      2.3.14
      See Also:
    • setBarAdmin

      void setBarAdmin(boolean bar)
      Set to bar the server admin from using/editing the project.
      Parameters:
      bar - If true, the server admin may not usethe project.
      Since:
      3.1.352
    • barAdmin

      boolean barAdmin()
      Indicates, whether the server admin is barred fromusing/editing the project.
      Returns:
      true, if server admin is barred,false otherwise
      Since:
      3.1.352
    • checkPermissions

      boolean checkPermissions()
      Indicates whether the the permission check is activated for this project or not.
      Returns:
      true if the permission check is activated for this project, false otherwise.
      Since:
      2.3.18
      See Also:
    • setPermissionCheck

      void setPermissionCheck(boolean check)
      Activates / Deactivates the permission check for this project
      Parameters:
      check - true to activate permission check, false to deactivate
      Since:
      2.3.18
      See Also:
    • getId

      long getId()
      Returns the ID of this project.
      Returns:
      id of this project
      Since:
      4.0.55
    • useRelease

      boolean useRelease()
      Returns true if this project uses the release state, false if it is an auto release project.
      Returns:
      false if it is an auto release project, true otherwise
      Since:
      3.0.4
    • setUseRelease

      void setUseRelease(boolean useRelease)
      Activates/deactives use of the release mechanism.
      Since:
      4.0.17
    • getLayers

      List<String> getLayers()
      Returns the layer names defined for this project. Modifications of the returned list will have no effect until you set the list.
      Returns:
      layer names of this project
      Since:
      3.0.8
    • setLayers

      void setLayers(List<String> layers)
      Defines the layer names for this project.
      Parameters:
      layers - The layer names.
      Since:
      4.0.17
    • getReadOnlyLayers

      List<String> getReadOnlyLayers()
      Provides the names of read only layers. Modifications of the returned will have no effect until you set the list.
      Returns:
      A list of layer names.
      Since:
      3.0.8
    • setReadOnlyLayers

      void setReadOnlyLayers(List<String> layers)
      Defines the names of read only layers.
      Parameters:
      layers - A list of layer names.
      Since:
      4.0.17
    • getMetadataTemplate

      long getMetadataTemplate()
      Get Metadata template id. -1 means no template set.
      Since:
      3.0.64
    • setMetadataTemplate

      void setMetadataTemplate(long templateID)
      Set Metadata template id. Set -1 for no template.
      Since:
      3.0.64
    • setMetadataTemplate

      void setMetadataTemplate(Template metadataTemplate)
      Defines the metadata template for this project.
      Parameters:
      metadataTemplate - The metadata template.
      Since:
      4.0.17
    • getWebeditDefaultTemplate

      @Nullable PageTemplate getWebeditDefaultTemplate()
      Returns the default page template that should be used in webedit, or null if not specified.
      Returns:
      default page template
      Since:
      5.0.100
    • setWebeditDefaultTemplate

      void setWebeditDefaultTemplate(@Nullable PageTemplate template)
      Sets the default page template that should be used in webedit, or nullfor no default page template.
      Parameters:
      template - the default page template
      Since:
      5.0.100
    • getWebeditDefaultWorkflow

      @Nullable Workflow getWebeditDefaultWorkflow()
      Returns the default workflow that should be used in webedit, or null if not specified.
      Returns:
      default workflow
      Since:
      5.2.13
    • setWebeditDefaultWorkflow

      void setWebeditDefaultWorkflow(@Nullable Workflow workflow)
      Sets the default workflow that should be used in webedit, or nullfor no default workflow.
      Parameters:
      workflow - the default workflow
      Since:
      5.2.13
    • getWebeditSystemFolder

      @NotNull PageFolder getWebeditSystemFolder()
      Returns the pagefolder that should be used as webedit system folder.
      Returns:
      webedit system folder
      Since:
      5.0.3
    • setWebeditSystemFolder

      void setWebeditSystemFolder(PageFolder folder)
      Sets the pagefolder which should be used as webedit system folder.
      Parameters:
      folder - webedit system folder
      Since:
      5.0.3
    • getRedirectTemplate

      @Nullable PageTemplate getRedirectTemplate()
      Returns the template used to generate external orrelated project linksof page reference nodes.
      If the redirect template is null a default redirect html is used:
      <head><meta http-equiv="refresh" content="0; URL=...."/></head> 
      Returns:
      the template or null if no such template is configured (default).
      Since:
      4.1.44
      See Also:
    • setRedirectTemplate

      void setRedirectTemplate(@Nullable PageTemplate template)
      Sets the template which should be used to generate external orrelated project linksof page reference nodes.
      If the redirect template is set to null a default redirect html is used:
      <head><meta http-equiv="refresh" content="0; URL=...."/></head> 
      Parameters:
      template - a template or null to clear
      Since:
      4.1.44
      See Also:
    • getNoSchemaSyncLayers

      List<String> getNoSchemaSyncLayers()
      Get the layers for which no schema sync's should be performed. Modifications of the returned list will have no effect until you set the list.
      Returns:
      a list containing layer names (java.lang.String)
      Since:
      3.0.78
    • setNoSchemaSyncLayers

      void setNoSchemaSyncLayers(List<String> layers)
      Defines the layers for which no schema sync should be performed.
      Parameters:
      layers - A list of layer names.
      Since:
      4.0.17
    • getBrokenReferences

      @Deprecated ReferenceEntry[] getBrokenReferences()
      Returns current broken references of this project (shortcut for getBrokenReferences(false)).
      Returns:
      current broken references of this project.
      Since:
      4.0.17
    • getBrokenReferences

      @Deprecated ReferenceEntry[] getBrokenReferences(boolean release)
      Returns current or release broken references of this project.
      Parameters:
      release - current (false) or release (true) broken references.
      Returns:
      current or release broken references of this project.
      Since:
      4.0.120
    • getExternalReferences

      @Deprecated ReferenceEntry[] getExternalReferences()
      Returns current external references of this project (shortcut for getExternalReferences(false)).
      Returns:
      current external references of this project.
      Since:
      4.0.120
    • getExternalReferences

      @Deprecated ReferenceEntry[] getExternalReferences(boolean release)
      Returns current or release external references of this project.
      Parameters:
      release - current (false) or release (true) external references.
      Returns:
      current or release external references of this project.
      Since:
      4.0.120
    • getExternalReferences

      @Deprecated ReferenceEntry[] getExternalReferences(String category, boolean release)
      Returns project's current or release external references of the given type.
      Parameters:
      release - current (false) or release (true) external references.
      category - external reference category.
      Returns:
      current or release external references of the given type.
      Since:
      4.0.120
    • getRemoteProjectConfiguration

      @Nullable RemoteProjectConfiguration getRemoteProjectConfiguration(@NotNull String symbolicName)
      Gets the remote project configuration for the specified symbolic name or null if not configuration with this name exists for this project.
      Parameters:
      symbolicName - name of the remote project configuaration
      Returns:
      the remote project configuration specified by the given name or null
      Since:
      3.1.174
    • getRemoteProjectConfigurations

      @NotNull List<RemoteProjectConfiguration> getRemoteProjectConfigurations()
      Return the list of existing remote project configurations for this project. The list is modifiable. For changing the list of remote configurations one has to write back a modifiedlist and save the change.
      Returns:
      list of existing remote project configurations
      Since:
      3.1.174
      See Also:
    • getRemoteProjectConfigurations

      Returns the list of remote project configurations for this project that pass the given filter.
      Parameters:
      filter - A filter to be passed by remote projects.
      Returns:
      A list of configurations.
      Since:
      4.0.26
    • setRemoteProjectConfigurations

      void setRemoteProjectConfigurations(List<RemoteProjectConfiguration> remoteProjectConfigurations)
      Sets the list of remote project configuratiosn for this project
      Parameters:
      remoteProjectConfigurations -
      Since:
      4.0.17
    • getMajorVersion

      String getMajorVersion()
      Provides the major server version information.
      Returns:
      major server version info (creation/importing time).
      Since:
      4.0.17
    • getMinorVersion

      String getMinorVersion()
      Provides the minor server version information.
      Returns:
      minor server version info (creation/importing time).
      Since:
      4.0.17
    • getServerBuild

      long getServerBuild()
      Provides the build number of the server.
      Returns:
      server build number (creation/importing time).
      Since:
      4.0.17
    • getEMail

      String getEMail()
      Provides the e-mail address to be notified when the project generation is done.
      Returns:
      An e-mail address.
      Since:
      4.0.17
    • setEMail

      void setEMail(String email)
      Sets the email address that will be notified when the project generation is ready!
      Since:
      4.0.17
    • getShouldGenerateComment

      boolean getShouldGenerateComment()
      Indicates whether comments should be generated.
      Returns:
      true, if comments shall be generated.
      Since:
      4.0.17
    • setShouldGenerateComment

      void setShouldGenerateComment(boolean gc)
      Defines whether comments should be generated.
      Parameters:
      gc - true, for generating comments.
      Since:
      4.0.17
    • generateAbsoluteLinks

      boolean generateAbsoluteLinks()
      Indicates whether absolute links should be generated.
      Returns:
      true, if absolute links shall be generated.
      Since:
      4.0.17
    • setGenerateAbsoluteLinks

      void setGenerateAbsoluteLinks(boolean absolute)
      Defines whether absolute links shall be generated.
      Parameters:
      absolute - true, to enable generating absolute links.
      Since:
      4.0.17
    • getRenderExternalLinks

      boolean getRenderExternalLinks()
      Indicates whether pages withexternal linksshould generate redirect html (see getRedirectTemplate()).
      If false (default) a redirect meta html will be rendered forpages which point to an external target.If true a page will be generated likenormal content pages.
      Returns:
      true if a page with anexternal targetshould be generated like normal content page, false to generate a redirect meta html
      Since:
      4.0.17
      See Also:
    • setRenderExternalLinks

      void setRenderExternalLinks(boolean renderExternalLinks)
      Sets the render external links flag.
      When true a page with an external link willgenerate like a normal content page.
      With false (default) a redirect meta html will be rendered as result page forpages which point to an external target.
      Parameters:
      renderExternalLinks - provide false to generate a redirect html forpages which point to an external target.
      Since:
      4.0.17
      See Also:
    • getBrokenLinkPage

      String getBrokenLinkPage()
      Provides a UID of a page reference to be shown when displaying a broken link.
      Returns:
      A page reference UID.
      Since:
      4.0.17
    • setBrokenLinkPage

      void setBrokenLinkPage(String pageRef)
      Defines the UID of a page reference to be used when displaying a broken link.
      Parameters:
      pageRef - The UID of a page reference.
      Since:
      4.0.17
    • getBrokenLinkMedia

      String getBrokenLinkMedia()
      Provides the UID of a media element to be shown when displaying a broken link.
      Returns:
      A media UID.
      Since:
      4.0.17
    • setBrokenLinkMedia

      void setBrokenLinkMedia(String mediaRef)
      Defines the UID of a media element to be shown when displaying a broken link.
      Parameters:
      mediaRef - A media UID.
      Since:
      4.0.17
    • getNotTranslatedAlternativePage

      String getNotTranslatedAlternativePage()
      Provides the UID of a page reference for a page to be shown if no translation was given.
      Returns:
      A page reference UID.
      Since:
      4.0.17
    • setNotTranslatedAlternativePage

      void setNotTranslatedAlternativePage(String pageRef)
      Defines the UID of a page reference for a page to be shown if no translation is given.
      Parameters:
      pageRef - The UID of a page reference.
      Since:
      4.0.17
    • getNotTranslatedPageStrategy

      int getNotTranslatedPageStrategy()
      Since:
      3.1
    • setNotTranslatedPageStrategy

      void setNotTranslatedPageStrategy(int strategy)
      Defines the strategy to be applied for not translated pages.
      Parameters:
      strategy - The strategy code.
      Since:
      4.0.17
      See Also:
    • getNotTranslatedMediaStrategy

      Project.MediaNotTranslatedStrategy getNotTranslatedMediaStrategy()
      Returns the strategy to use when generating media that is not translated
      Since:
      5.2.220208
    • setNotTranslatedMediaStrategy

      void setNotTranslatedMediaStrategy(Project.MediaNotTranslatedStrategy strategy)
      Defines the strategy to be applied for not translated media.
      Parameters:
      strategy - The strategy
      Since:
      5.2.220208
      See Also:
    • setDeploymentErrorHandling

      void setDeploymentErrorHandling(int value)
      Defines the code for how to handling deployment errors.
      Parameters:
      value - The handling code.
      Since:
      4.0.17
      See Also:
    • getDeploymentErrorHandling

      int getDeploymentErrorHandling()
      Provides the code for how to handling deployment errors.
      Returns:
      The code
      Since:
      4.0.17
      See Also:
    • setMaximumWarningCount

      void setMaximumWarningCount(int value)
      Defines the maximum number of acceptable warnings.
      Parameters:
      value - The maximum.
      Since:
      4.0.17
    • getMaximumWarningCount

      int getMaximumWarningCount()
      Provides the maximum number for acceptable warnings.
      Returns:
      The maximum.
      Since:
      4.0.17
    • setQuotaHDD

      void setQuotaHDD(long quota)
      Defines the harddisk quota for this project.
      Parameters:
      quota - The quota in Megabytes.
      Since:
      4.0.17
    • getQuotaHDD

      long getQuotaHDD()
      Provides the harddisk quota for this project.
      Returns:
      The quota in MB.
      Since:
      4.0.17
    • setQuotaPages

      void setQuotaPages(long quota)
      Defines the quota for pages allowed in this project.
      Parameters:
      quota - The page quota.
      Since:
      4.0.17
    • getQuotaPages

      long getQuotaPages()
      Provides the quota for pages allowed in this project.
      Returns:
      The page quota.
      Since:
      4.0.17
    • setQuotaMail

      void setQuotaMail(String mail)
      Defines the e-mail address to inform about quota issues.
      Parameters:
      mail - An e-mail address.
      Since:
      4.0.17
    • getQuotaMail

      String getQuotaMail()
      Provides the e-mail address to inform about quota issues.
      Returns:
      An e-mail address.
      Since:
      4.0.17
    • addDefaultLayer

      String addDefaultLayer()
      Creates a default layer and adds it to project layers.

      The layer will be saved serversided. The project has to be saved to apply changes. If project won't be saved the layer should be deleted manually.

      Returns:
      String The layer name
      Since:
      4.0.
    • getCacheWeight

      double getCacheWeight()
      Get cache weight. Cache Weight ist used for distributing server cache memory to projects.
      Since:
      4.0
    • setCacheWeight

      void setCacheWeight(double weight)
      Set cache weight. Cache Weight ist used for distributing server cache memory to projects.
      Since:
      4.0
    • getUserService

      @NotNull UserService getUserService()
      Creates an UserService for this project, or returns a cached instance.
      Returns:
      UserService instance
      Since:
      4.0
    • getUserService

      @NotNull UserService getUserService(@NotNull Date time)
      Returns a readonly userservice with frozen store data at the specified point in time.
      Set the revision to the nearest fitting revision (the highest revision with a time less or equal to the time specified).
      Parameters:
      time - a valid date
      Throws:
      IllegalArgumentException - if there is no fitting revision
      Since:
      4.0.46
      See Also:
    • getUserService

      @NotNull UserService getUserService(@NotNull Revision revision)
      Returns a readonly userservice with frozen store data at the specified revision.
      If the revision is before getFirstCompleteRevision() the returned user service may behaveunexpectedly.
      Parameters:
      revision - a valid revision.
      Since:
      4.0.46
      See Also:
    • getUserService

      @NotNull UserService getUserService(long revisionId)
      Returns a read-only historic view, the provided revision id determines the point in time. If the revision is before getFirstCompleteRevision() the returned user service may behaveunexpectedly.
      Parameters:
      revisionId - a valid revision id
      Returns:
      A read only user service.
      Since:
      4.0.46
      See Also:
    • getRevision

      @NotNull Revision getRevision(long revisionId)
      Returns the revision with the specified revision id.
      Parameters:
      revisionId - the id of the revision
      Returns:
      the revision specified by the given revisionId
      Throws:
      IllegalArgumentException - if no revision was found with the specified id
      Since:
      4.0.122
    • getRevision

      @NotNull Revision getRevision(Date revisionDate)
      Returns the latest revision with a creation timeless or equal to the time of the given revisionDate
      Parameters:
      revisionDate - Use HistoryProvider.EVER_SINCE to get the first revision, HistoryProvider.UNTIL_NOW (and NOT "new Date()") to get the latest revision of this project.
      Returns:
      the latest revision with a creation time less or equal the specified revisionDate
      Since:
      4.0.122
    • getRevisions

      List<Revision> getRevisions(@NotNull Revision from, @NotNull Revision to, int maxCount, @Nullable Filter<Revision> filter)
      Returns a list of revisions in descending order.
           from                                               to   ---I-------------------------------------------------I---> revision                         I<---------------------------->I                   result list containing "maxCount" entries 

      The given filter must be reachable on server. Therefor it must be at least exists in a library module with scope server. See RevisionFilter for common revision filter implementations.

      Parameters:
      from - Marks lower revision bound, so that revisions must be of this revision or younger (higher id) to pass.
      to - Marks upper revision bound, so that revisions must be of this revision or older (lower id) to pass. UsegetRevision(new Date()) to retrieve revisions up to date.
      maxCount - The maximum count of returned revisions. Use HistoryProvider.ALL_REVISIONS to get allrevisions in specified range.
      filter - Filter to be passed. If null, accepts all elements. The given filter must be reachable in fs server, at least as library module with scope server.
      Returns:
      A list of revisions that passed the given criteria in descending order.
      Since:
      4.0.122
      See Also:
    • getCustomProperties

      Map<String,String> getCustomProperties(@NotNull String name)
      Returns map of user defined properties.
      Parameters:
      name - Scope of the properties
      Returns:
      Map with properties or null
      Since:
      4.0
    • setCustomProperties

      void setCustomProperties(@NotNull String name, Map<String,String> properties)
      Set user defined project properties.
      Parameters:
      name - Scope of the properties
      Since:
      4.0
    • deleteCustomProperties

      void deleteCustomProperties(@NotNull String name)
      Delete user defined project properties.
      Parameters:
      name - Scope of the properties
      Since:
      4.0
    • getProperty

      @Nullable Object getProperty(@NotNull String name)
      Returns project property with the given name or null if not found.
      Parameters:
      name - property name.
      Returns:
      project property or null.
      Since:
      4.0.47
    • removeProperty

      void removeProperty(@NotNull String name)
      Removes the project property with the given name.
      Parameters:
      name - property name.
      Since:
      4.0.47
    • setProperty

      void setProperty(@NotNull String name, @NotNull Object value)
      Sets the project property name to the given value.
      Parameters:
      name - property name.
      value - property value.
      Since:
      4.0.47
    • setActiveWebServer

      void setActiveWebServer(String webScope, String associatedWebServer)
      Sets the specified webserver id on the specified webscope. Values for web scope WebEnvironment.WebScope.LIVE are ignored
      Parameters:
      webScope - webscope the webserver is used for
      associatedWebServer - the id of specified webserver
      Since:
      4.0.19
    • getActiveWebServer

      @Nullable String getActiveWebServer(String webScope)
      Gets the webserver id for the specified webscope
      Parameters:
      webScope - webscope the webserver is used for
      Returns:
      the id of specified webserver or null for web scope WebEnvironment.WebScope.LIVE
      Since:
      4.0.19
    • setSelectedWebServer

      @Deprecated void setSelectedWebServer(String webScope, String associatedWebServer)
      Deprecated.
      since 5.2.180906 - no replacement
      Sets the specified webserver id on the specified webscope. Values for web scope WebEnvironment.WebScope.LIVE are ignored
      Parameters:
      webScope - webscope the webserver is used for
      associatedWebServer - the id of specified webserver
      Since:
      4.0.19
    • getSelectedWebServer

      @Deprecated @Nullable String getSelectedWebServer(String webScope)
      Deprecated.
      since 5.2.180906 - no replacement
      Gets the webserver id for the specified webscope
      Parameters:
      webScope - webscope the webserver is used for
      Returns:
      the id of specified webserver or null for web scope WebEnvironment.WebScope.LIVE
      Since:
      4.0.19
    • setWebAppsConfigChanged

      void setWebAppsConfigChanged(String webScope, boolean changed)
      Sets the specified change state on the specified webscope
      Parameters:
      webScope - webscope the webserver is used for
      changed - configuration has changed
      Since:
      4.0.19
    • hasWebAppsConfigChanged

      boolean hasWebAppsConfigChanged(String webScope)
      Gets the change state for the specified webscope, true if configuration has changed since last deploy
      Parameters:
      webScope - webscope the webserver is used for
      Returns:
      true if configuration has changed since last deploy
      Since:
      4.0.19
    • getRevisionCommentMode

      Project.CommentMode getRevisionCommentMode(Store.Type type)
      Should revision comments be ented for a specific store.
      Since:
      4.0.23
    • setRevisionCommentMode

      void setRevisionCommentMode(Store.Type type, Project.CommentMode mode)
      Set revison comment mode for a specific store.
      Since:
      4.0.23
    • isReindexingSearch

      boolean isReindexingSearch()
      Returns if reindexing is in progress
      Returns:
      true if reindexing is in progress, false otherwise
      Since:
      4.0.23
    • isCalculatingReferences

      boolean isCalculatingReferences()
      Returns true if recalculating is in progress. Shortcut forProjectReferencesAgent.isRebuildingReferences().
      Returns:
      true if recalculating of references is in progress, false otherwise.
      Since:
      4.0.23
      See Also:
    • getDeleteWorkflow

      Workflow getDeleteWorkflow()
      Get delete Workflow. Returns null if no delete Workflow is set.
      Since:
      4.0.120
    • setDeleteWorkflow

      void setDeleteWorkflow(Workflow workflow)
      Set delete Workflow. Set to null if no delete Workflow should be used.
      Since:
      4.0.120
    • getStagingUrl

      String getStagingUrl()
      Return the url for the staging application.
      Since:
      4.1
    • setMediaSizeLimitEnabled

      void setMediaSizeLimitEnabled(boolean enable)
      Activate the project level based file size limitations for files (non-image files) and images.
      Parameters:
      enable - true activate the media file size limitations
      Since:
      4.1
      See Also:
    • isMediaSizeLimitEnabled

      boolean isMediaSizeLimitEnabled()
      Get the activation status of the project based media size limitations.
      Returns:
      true if enabled otherwise false
      Since:
      4.1
    • setMediaExtensionCheckEnabled

      void setMediaExtensionCheckEnabled(boolean enable)
      Activate the project level based media filename extension restrictions.
      Parameters:
      enable - true to enable otherwise false
      Since:
      4.1
    • isMediaExtensionCheckEnabled

      boolean isMediaExtensionCheckEnabled()
      Get the activation status of the project based media filename extension restrictions.
      Returns:
      true if enabled otherwise false
      Since:
      4.1
    • getMediaConstraints

      @NotNull MediaConstraints getMediaConstraints()
      Get the media constraints settings of thisproject.
      To change the settings one have to perform the three steps: 1.) getting the media constraints, 2.) changing the constraints, 3.) setting the changed constraints
      Returns:
      a clone of the actual MediaConstraints
      Since:
      4.1
      See Also:
    • setMediaConstraints

      void setMediaConstraints(@NotNull MediaConstraints value)
      Set the media constraints settings of this project. The provided instance is clonedso changing the instance after setting has no effect for this project. You have to set the instance again to persist the changes.
      To change the settings one have to perform the three steps: 1.) getting the media constraints, 2.) changing the constraints, 3.) setting the changed constraints
      Parameters:
      value - the project level based media constraints settings
      Since:
      4.1
      See Also:
    • getMaximumApplicationWidth

      int getMaximumApplicationWidth()
      Returns the maximum allowed width of the inline preview frame or -1 if there is no restriction.
      Since:
      4.2.20
    • setMaximumApplicationWidth

      void setMaximumApplicationWidth(int width)
      Provide the maximum allowed width of the inline preview frame or -1 if there should be no restriction.
      Since:
      4.2.20
    • getInlinePreviewConstraints

      @NotNull InlinePreviewConstraints getInlinePreviewConstraints()
      Get the media constraints settings of this project.
      To change the settings one have to perform the three steps: 1.) get the inline preview constraints, 2.) change the constraints, 3.) set the changed constraints
      Since:
      4.2.20
      See Also:
    • setInlinePreviewConstraints

      void setInlinePreviewConstraints(@NotNull InlinePreviewConstraints value)
      Set the inline preview settings of this project. The provided instance is clonedso changing the instance after setting has no effect for this project. You have to set the instance again to persist the changes.
      To change the settings one have to perform the three steps: 1.) get the inline preview constraints, 2.) change the constraints, 3.) set the changed constraints
      Since:
      4.2.20
      See Also:
    • createTag

      @NotNull Tag createTag(@NotNull String tag, @Nullable String comment, @Nullable Map<String,String> properties)
      Create a tagged revision.
      If the tag name end with the suffix 'Task', archiving may remove the tag if the revision is archived.
      Parameters:
      tag - Name for the tag, must not be null and not empty after trimmed.
      comment - Comment for the tag, may be null.
      properties - map containing custom user properties, may be null.
      Returns:
      The created tag.
      Since:
      4.2.400
    • createTag

      @NotNull Tag createTag(@NotNull Revision revision, @NotNull String tag, @Nullable String comment, @Nullable Map<String,String> properties)
      Create a tag for a existing revision.
      If the tag name end with the suffix 'Task', archiving may remove the tag if the revision is archived.
      Parameters:
      revision - The revision to tag, must not be null
      tag - Name for the tag, must not be null and not empty after trimmed.
      comment - Comment for the tag, may be null.
      properties - map containing custom user properties, may be null.
      Returns:
      The created tag.
      Since:
      4.2.400
    • getTags

      @NotNull List<Tag> getTags(@Nullable Revision revision, int maxRevisionCount)
      Returns list of tags descending in revision order. Tags with the same revision will be returned in descending tag creation time order.
      Parameters:
      revision - The revision to start, use null for latest created revision.
      maxRevisionCount - The maximum count of revisions to search for tags. Use 0 for unlimited count.
      Returns:
      The list of tags
      Since:
      4.2.400
    • getTags

      @NotNull List<Tag> getTags(@Nullable Tag tag, int maxTagCount)
      Return list of tags descending in tag creation time (or tag id) order.
      Parameters:
      tag - The tag to start, use null for latest tag.
      maxTagCount - The maximum count of tags to return. Use 0 for unlimited count.
      Returns:
      The list of tags
      Since:
      4.2.400
    • getAllowUidChanges

      boolean getAllowUidChanges()
      Returns true if project users are allowed to change UIDs.Admins may always change UIDs.If the UID of an element may be changed is also determined by the change permission of the corresponding element.
      Returns:
      true if users are allowed to changes the UID of an element if the corresponding permission isgranted, false if only admins may change UIDs.
      Since:
      4.2.400
    • setAllowUidChanges

      void setAllowUidChanges(boolean value)
      Set allow UID changes project flag. Admins are always allowed to change UIDs even if this flag is set tofalse. If a user can change the UID of an element is also determined by the change permission of the corresponding element.
      Parameters:
      value - If true, project users which are not admins may changethe UID of an element if the corresponding permission is granted.
      Since:
      4.2.400
    • getAllowLanguageHiding

      boolean getAllowLanguageHiding()
      Returns true if project users are allowed to switch the display of language tabs in this project. Ifallowed, the project user can select the languages he wants to display in in the client gui.
      Returns:
      returns true if hiding of languages is allowed in this project
      Since:
      4.2.451
    • setAllowLanguageHiding

      void setAllowLanguageHiding(boolean allowLanguageHiding)
      Set if project users are allowed to switch the display of language tabs in this project. If allowed, the project user can select the languages he wants to display in in the client gui.
      Parameters:
      allowLanguageHiding - set to true if the user is allowed to switch the display of languages in this project
      Since:
      4.2.451
    • getUseServerLockForDataset

      boolean getUseServerLockForDataset()
      If true dataset editing access is synced on server - i.e. not two clients can edit the samedataset concurrently. If false editing is synchronization is optimistic.
      Returns:
      true if dataset editing access is synced on server, else false.
      Since:
      5.0.5
      See Also:
    • setUseServerLockForDataset

      void setUseServerLockForDataset(boolean value)
      Set how dataset editing access is synced on server. If true datasetediting access is synced on server - i.e. not two clients can edit the same dataset concurrently. If false editing is synchronization is optimistic.
      Parameters:
      value - true if dataset editing access is synced on server, else false.
      Since:
      5.0.5
      See Also:
    • getFirstCompleteRevision

      @NotNull Revision getFirstCompleteRevision()
      Returns the first revision up to that the history is complete (i.e. has not been archived).
      Returns:
      the first complete revision.
      Since:
      5.0.111
    • getForbidPolyglotDataHierarchy

      boolean getForbidPolyglotDataHierarchy()
      Indicates, whether it is forbidden to use language dependent forms on arbitrary levels in a data hierarchy.
      Returns:
      true, if polyglot data is forbidden.
      Since:
      5.2.510
    • setForbidPolyglotDataHierarchy

      void setForbidPolyglotDataHierarchy(boolean forbid)
      Defines, whether to forbid to use language dependent forms on arbitrary levels in data hierarchy.
      Parameters:
      forbid - true, to forbid polyglot data.
      Since:
      5.2.510
    • useMappingBasedSchemaMerge

      boolean useMappingBasedSchemaMerge()
      Indicates, whether the mapping based schema import is used during the import with ExternalSync/ContentTransport or not.
      Returns:
      true, if polyglot data is forbidden.
      Since:
      5.2.210906
    • setUseMappingBasedSchemaMerge

      void setUseMappingBasedSchemaMerge(boolean useMappingBasedSchemaMerge)
      Defines, whether to use the mapping based schema import during the import with ExternalSync/ContentTransport.
      Parameters:
      useMappingBasedSchemaMerge - true, use the mapping based schema merge.
      Since:
      5.2.210906
    • setWebeditPreviewUrl

      void setWebeditPreviewUrl(@Nullable String url)
      Sets the preview url for webedit.
      Parameters:
      url - to alternative preview
      Since:
      5.2.1608
    • getWebeditPreviewUrl

      @Nullable String getWebeditPreviewUrl()
      Returns the custom preview url of webedit or null, if default url is used.
      Returns:
      the custom preview url or null, if the default is used
      Since:
      5.2.1608