public interface Project extends Comparable<Project>, Lockable
Modifier and Type | Interface and Description |
---|---|
static class |
Project.CommentMode
Comment mode options.
|
Modifier and Type | Field and Description |
---|---|
static String |
CUSTOM_PROPERTY_IMPORT_IDMAP
Property to get ImportId map (Map
getCustomProperties(IMPORT_IDMAP) |
static String |
CUSTOM_PROPERTY_IMPORT_LAYERMAP
Property to get import layer mapping (Map
getCustomProperties(IMPORT_IDMAP) |
static String |
CUSTOM_PROPERTY_IMPORT_SOURCE_INFOS
Property to get source server and project infos of an imported project (Map
getCustomProperties(IMPORT_IDMAP) |
static String |
DEFAULT_ADMIN_GROUP_NAME
Default name for the administrators group.
|
static String |
DEFAULT_EVERYONE_GROUP_NAME
Default name for the everyone group.
|
static int |
DEPLOY_IF_ZERO_FATALS
Deployment error condition
|
static int |
DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS
Deployment error condition
|
static int |
DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS_WARNING_COUNT_NOT_EXCEEDED
Deployment error condition
|
static String |
EXTERNAL_SYNCHRONISATION_GROUP_NAME
External Synchronisation group name.
|
static String |
FONTS
Property name for font definitions.
|
static int |
LAST_DEPLOYMENT_NOT_OK
Code for indicating an unsuccessful deployment.
|
static int |
LAST_DEPLOYMENT_OK
Code for indicating a successful deployment.
|
static int |
STRATEGY_IGNORE_NOT_TRANSLATED
Translation strategy
|
static int |
STRATEGY_REPLACE_NOT_TRANSLATED_WITH_BROKEN_LINK_PAGE
Translation strategy
|
static int |
STRATEGY_REPLACE_NOT_TRANSLATED_WITH_MASTER_LANGUAGE
Translation strategy
|
static int |
STRATEGY_REPLACE_NOT_TRANSLATED_WITH_SPECIAL_PAGE
Translation strategy
|
Modifier and Type | Method and Description |
---|---|
boolean |
accessAllowed(User user)
Is a user allowed to acces the project
|
String |
addDefaultLayer()
Creates a default layer and adds it to project layers.
|
void |
addEditorialLanguage(Language language)
Adds the given language to the list of editorial languages of this project.
|
void |
addLanguage(Language language)
Adds a project language to the project
|
void |
addTemplateSet(TemplateSet templateSet)
Adds a
TemplateSet . |
void |
addUser(User user)
Add an user to the project and giving him the access right for this project.
|
boolean |
barAdmin()
Indicates, whether the
server admin is barred fromusing/editing the project. |
boolean |
checkPermissions()
Indicates whether the the permission check is activated for this project or not.
|
Group |
createExternalGroup(String name,
String externalName)
Adds an external group to this project.
|
Group |
createGroup(String name)
Adds an empty internal group to this project.
|
Resolution |
createResolution(String name,
String description)
Create a new resolution
|
Tag |
createTag(Revision revision,
String tag,
String comment,
Map<String,String> properties)
Create a tag for a existing revision.
|
Tag |
createTag(String tag,
String comment,
Map<String,String> properties)
Create a tagged revision.
|
TemplateSet |
createTemplateSet()
Create a new TemplateSet
|
void |
deleteCustomProperties(String name)
Delete user defined project properties.
|
boolean |
generateAbsoluteLinks()
Indicates whether absolute links should be generated.
|
String |
getActiveWebServer(String webScope)
Gets the webserver id for the specified webscope
|
boolean |
getAllowEveryone()
Indicates whether everyone is allowed to access this project.
|
boolean |
getAllowLanguageHiding()
Returns
true if project users are allowed to switch the display of language tabs in this project. |
boolean |
getAllowUidChanges()
Returns
true if project users are allowed to change UIDs. |
List<String> |
getAppletEditors()
Deprecated.
since 5.0 - no replacement
|
String |
getBrokenLinkMedia()
Provides the UID of a media element to be shown when displaying a broken link.
|
String |
getBrokenLinkPage()
Provides a UID of a page reference to be shown when displaying a broken link.
|
ReferenceEntry[] |
getBrokenReferences()
Deprecated.
since 5.2.301, use
ProjectReferencesAgent.getBrokenReferences(boolean) . |
ReferenceEntry[] |
getBrokenReferences(boolean release)
Deprecated.
since 5.2.301, use
ProjectReferencesAgent.getBrokenReferences(boolean) . |
double |
getCacheWeight()
Get cache weight.
|
Map<String,String> |
getCustomProperties(String name)
Returns map of user defined properties.
|
Workflow |
getDeleteWorkflow()
Get delete Workflow.
|
int |
getDeploymentErrorHandling()
Provides the code for how to handling deployment errors.
|
String |
getDescription()
Gets the description of the project
|
List<Language> |
getEditorialLanguages()
Returns the list of editorial language for this project.
|
String |
getEMail()
Provides the e-mail address to be notified when the project generation is done.
|
ReferenceEntry[] |
getExternalReferences()
Deprecated.
since 5.2.301, use
ProjectReferencesAgent.getExternalReferences(String,boolean) . |
ReferenceEntry[] |
getExternalReferences(boolean release)
Deprecated.
since 5.2.301, use
ProjectReferencesAgent.getExternalReferences(String,boolean) . |
ReferenceEntry[] |
getExternalReferences(String category,
boolean release)
Deprecated.
since 5.2.301, use
ProjectReferencesAgent.getExternalReferences(String,boolean) . |
Revision |
getFirstCompleteRevision()
Returns the first revision up to that the history is complete (i.e. has not been archived).
|
boolean |
getForbidPolyglotDataHierarchy()
Indicates, whether it is forbidden to use language dependent forms on arbitrary levels in a data hierarchy.
|
List<Group> |
getGroups()
Returns a list of all
groups of this project. |
List<Group> |
getGroups(User user)
|
Group[] |
getGroupsArray(User user)
Returns groups of this project where the user belongs to (at least EVERYONE).
|
long |
getId()
Returns the ID of this project.
|
InlinePreviewConstraints |
getInlinePreviewConstraints()
Get the
media constraints settings of this project. |
Language |
getLanguage(String abbreviation)
Get the content language with the specified abbreviation.
|
List<Language> |
getLanguages()
Returns a list of all project
Languages . |
List<String> |
getLayers()
Returns the layer names defined for this project.
|
String |
getMajorVersion()
Provides the major server version information.
|
Language |
getMasterLanguage()
Gets the master language.
|
int |
getMaximumApplicationWidth()
Returns the maximum allowed width of the inline preview frame or
-1 if there is no restriction. |
int |
getMaximumWarningCount()
Provides the maximum number for acceptable warnings.
|
MediaConstraints |
getMediaConstraints()
Get the
media constraints settings of thisproject. |
long |
getMetadataTemplate()
Get Metadata template id. -1 means no template set.
|
String |
getMinorVersion()
Provides the minor server version information.
|
String |
getName()
Get the unique project name
|
List<String> |
getNoSchemaSyncLayers()
Get the layers for which no schema sync's should be performed.
|
String |
getNotTranslatedAlternativePage()
Provides the UID of a page reference for a page to be shown if no translation was given.
|
int |
getNotTranslatedPageStrategy()
|
Resolution |
getOriginalResolution()
Provides the resolution definition for requesting images in their original dimensions.
|
String |
getPermissionVariable()
Get Metadata variable permissions
|
InputStream |
getProjectLogo()
Return the project logo
|
Object |
getProperty(String name)
Returns project property with the given
name or null if not found. |
long |
getQuotaHDD()
Provides the harddisk quota for this project.
|
String |
getQuotaMail()
Provides the e-mail address to inform about quota issues.
|
long |
getQuotaPages()
Provides the quota for pages allowed in this project.
|
List<String> |
getReadOnlyLayers()
Provides the names of read only layers.
|
PageTemplate |
getRedirectTemplate()
|
RemoteProjectConfiguration |
getRemoteProjectConfiguration(String symbolicName)
Gets the remote project configuration for the specified symbolic name or
null if not configuration with this name exists for this project. |
List<RemoteProjectConfiguration> |
getRemoteProjectConfigurations()
Return the list of existing remote project configurations for this project.
|
List<RemoteProjectConfiguration> |
getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration> filter)
Returns the list of remote project configurations for this project that pass the given filter.
|
boolean |
getRenderExternalLinks()
Indicates whether
pages withexternal links should generate redirect html (see getRedirectTemplate() ). |
Resolution |
getResolutionByName(String name)
Returns the resolution with the given name or
null if no resolution exists in this project with the specified name. |
List<Resolution> |
getResolutions()
Get all
resolutions of this project. |
Revision |
getRevision(Date revisionDate)
Returns the latest revision with a
creation time less or equal to the time of the given revisionDate |
Revision |
getRevision(long revisionId)
Returns the revision with the specified revision id.
|
Project.CommentMode |
getRevisionCommentMode(Store.Type type)
Should revision comments be ented for a specific store.
|
List<Revision> |
getRevisions(Revision from,
Revision to,
int maxCount,
Filter<Revision> filter)
Returns a list of revisions in descending order.
|
String |
getSecureAccessURL()
Get URL for secure media access
|
boolean |
getSecureDefaultAllow()
Default allow if no permissions are configured
|
String |
getSecureMediaFolder()
Get the uid of the secure media folder.
|
String |
getSelectedWebServer(String webScope)
Deprecated.
since 5.2.180906 - no replacement
|
long |
getServerBuild()
Provides the build number of the server.
|
boolean |
getShouldGenerateComment()
Indicates whether comments should be generated.
|
String |
getStagingUrl()
Return the url for the staging application.
|
List<Tag> |
getTags(Revision revision,
int maxRevisionCount)
Returns list of tags descending in revision order.
|
List<Tag> |
getTags(Tag tag,
int maxTagCount)
Return list of tags descending in tag creation time (or tag id) order.
|
List<TemplateSet> |
getTemplateSets()
Get all
TemplateSet s of this project. |
List<User> |
getUsers()
Returns a list of all
users |
UserService |
getUserService()
Creates an
UserService for this project, or returns a cached instance. |
UserService |
getUserService(Date time)
Returns a readonly userservice with frozen store data at the specified point in time.
|
UserService |
getUserService(long revisionId)
Returns a read-only historic view, the provided revision id determines the point in time.
|
UserService |
getUserService(Revision revision)
Returns a readonly userservice with frozen store data at the specified revision.
|
boolean |
getUseServerLockForDataset()
If
true dataset editing access is synced on server - i.e. not two clients can edit the samedataset concurrently. |
PageTemplate |
getWebeditDefaultTemplate()
Returns the default page template that should be used in webedit, or
null if not specified. |
Workflow |
getWebeditDefaultWorkflow()
Returns the default workflow that should be used in webedit, or
null if not specified. |
String |
getWebeditPreviewUrl()
Returns the custom preview url of webedit or
null , if default url is used. |
PageFolder |
getWebeditSystemFolder()
Returns the pagefolder that should be used as webedit system folder.
|
TemplateSet |
getWebEditTemplateSet()
the templateset for webedit
|
int |
getWebEditTemplateSetIndex()
the index of the webedit templateset
|
boolean |
hasProjectLogo()
Checks if a logo exists for this project.
|
boolean |
hasWebAppsConfigChanged(String webScope)
Gets the change state for the specified webscope, true if configuration has changed since last deploy
|
boolean |
isActive()
Is this project active
|
boolean |
isAdmin(User user)
|
boolean |
isCalculatingReferences()
Returns
true if recalculating is in progress. |
boolean |
isMediaExtensionCheckEnabled()
Get the activation status of the project based media filename extension restrictions.
|
boolean |
isMediaSizeLimitEnabled()
Get the activation status of the project based media size limitations.
|
boolean |
isMember(User user)
Indicates whether the given user is member of this project.
|
boolean |
isReindexingSearch()
Returns if reindexing is in progress
|
void |
removeEditorialLanguage(Language language)
Removes the given language from the list of editorial languages of this project.
|
void |
removeGroup(Group group)
Remove a group
|
void |
removeLanguage(Language language)
Removes a project language from the project
|
void |
removeProjectLogo()
Remove the project logo
|
void |
removeProperty(String name)
Removes the project property with the given
name . |
void |
removeResolution(Resolution resolution)
Remove resolution
|
void |
removeTemplateSet(TemplateSet templateSet)
Remove
TemplateSet . |
void |
removeUser(User user)
Remove user from project
|
void |
setActiveWebServer(String webScope,
String associatedWebServer)
Sets the specified webserver id on the specified webscope.
|
void |
setAllowEveryone(boolean allowEveryone)
Defines to allow everyone to access this project.
|
void |
setAllowLanguageHiding(boolean allowLanguageHiding)
Set if project users are allowed to switch the display of language tabs in this project.
|
void |
setAllowUidChanges(boolean value)
Set allow UID changes project flag.
|
void |
setAppletEditors(List<String> editors)
Deprecated.
since 5.0 - no replacement
|
void |
setBarAdmin(boolean bar)
Set to bar the
server admin from using/editing the project. |
void |
setBrokenLinkMedia(String mediaRef)
Defines the UID of a media element to be shown when displaying a broken link.
|
void |
setBrokenLinkPage(String pageRef)
Defines the UID of a page reference to be used when displaying a broken link.
|
void |
setCacheWeight(double weight)
Set cache weight.
|
void |
setCustomProperties(String name,
Map<String,String> properties)
Set user defined project properties.
|
void |
setDeleteWorkflow(Workflow workflow)
Set delete Workflow.
|
void |
setDeploymentErrorHandling(int value)
Defines the code for how to handling deployment errors.
|
void |
setDescription(String description)
Sets the description of the project
|
void |
setEMail(String email)
Sets the email address that will be notified when the project generation is ready!
|
void |
setForbidPolyglotDataHierarchy(boolean forbid)
Defines, whether to forbid to use language dependent forms on arbitrary levels in data hierarchy.
|
void |
setGenerateAbsoluteLinks(boolean absolute)
Defines whether absolute links shall be generated.
|
void |
setInlinePreviewConstraints(InlinePreviewConstraints value)
Set the
inline preview settings of this project. |
void |
setLanguages(List<Language> languages)
Sets all projects languages.
|
void |
setLayers(List<String> layers)
Defines the layer names for this project.
|
void |
setMasterLanguage(Language language)
Set master language of the project
|
void |
setMaximumApplicationWidth(int width)
Provide the maximum allowed width of the inline preview frame or
-1 if there should be no restriction. |
void |
setMaximumWarningCount(int value)
Defines the maximum number of acceptable warnings.
|
void |
setMediaConstraints(MediaConstraints value)
Set the
media constraints settings of this project. |
void |
setMediaExtensionCheckEnabled(boolean enable)
Activate the project level based media filename extension restrictions.
|
void |
setMediaSizeLimitEnabled(boolean enable)
Activate the project level based file size limitations for files (non-image files) and images.
|
void |
setMetadataTemplate(long templateID)
Set Metadata template id.
|
void |
setMetadataTemplate(Template metadataTemplate)
Defines the metadata template for this project.
|
void |
setName(String name)
Sets the name of the project
|
void |
setNoSchemaSyncLayers(List<String> layers)
Defines the layers for which no schema sync should be performed.
|
void |
setNotTranslatedAlternativePage(String pageRef)
Defines the UID of a page reference for a page to be shown if no translation is given.
|
void |
setNotTranslatedPageStrategy(int strategy)
Defines the strategy to be applied for not translated pages.
|
void |
setPermissionCheck(boolean check)
Activates / Deactivates the permission check for this project
|
void |
setPermissionVariable(String variable)
Set Metadata variable used for permissions
|
void |
setProjectLogo(InputStream data)
Set the project logo
|
void |
setProperty(String name,
Object value)
Sets the project property
name to the given value . |
void |
setQuotaHDD(long quota)
Defines the harddisk quota for this project.
|
void |
setQuotaMail(String mail)
Defines the e-mail address to inform about quota issues.
|
void |
setQuotaPages(long quota)
Defines the quota for pages allowed in this project.
|
void |
setReadOnlyLayers(List<String> layers)
Defines the names of read only layers.
|
void |
setRedirectTemplate(PageTemplate template)
Sets the template which should be used to generate
external orrelated project linksof page reference nodes . |
void |
setRemoteProjectConfigurations(List<RemoteProjectConfiguration> remoteProjectConfigurations)
Sets the list of remote project configuratiosn for this project
|
void |
setRenderExternalLinks(boolean renderExternalLinks)
Sets the
render external links flag. |
void |
setResolutions(Resolution[] resolutions)
Set the Resolutions of this project
|
void |
setRevisionCommentMode(Store.Type type,
Project.CommentMode mode)
Set revison comment mode for a specific store.
|
void |
setSecureAccessURL(String secureAccessURL)
Set URL for secure media access
|
void |
setSecureDefaultAllow(boolean allow)
Set default allow access if no permissions are configured.
|
void |
setSecureMediaFolder(String folderUid)
Set fodler used for secure media
|
void |
setSelectedWebServer(String webScope,
String associatedWebServer)
Deprecated.
since 5.2.180906 - no replacement
|
void |
setShouldGenerateComment(boolean gc)
Defines whether comments should be generated.
|
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).
|
void |
setUseRelease(boolean useRelease)
Activates/deactives use of the release mechanism.
|
void |
setUseServerLockForDataset(boolean value)
Set how
dataset editing access is synced on server. |
void |
setUseWebEdit(boolean useWebEdit)
Set Webedit use
|
void |
setUseWebeditApplet(boolean useApplet)
Deprecated.
since 5.0 - no replacement
|
void |
setWebAppsConfigChanged(String webScope,
boolean changed)
Sets the specified change state on the specified webscope
|
void |
setWebeditDefaultTemplate(PageTemplate template)
Sets the default page template that should be used in webedit, or
null for no default page template. |
void |
setWebeditDefaultWorkflow(Workflow workflow)
Sets the default workflow that should be used in webedit, or
null for no default workflow. |
void |
setWebeditPreviewUrl(String url)
Sets the preview url for webedit.
|
void |
setWebeditSystemFolder(PageFolder folder)
Sets the pagefolder which should be used as webedit system folder.
|
void |
setWebEditTemplateSet(TemplateSet webEditTemplateSet)
sets the templateSet for webedit
|
boolean |
showReferenceNames()
Indicates whether reference names should be shown (e.g. in create dialogs) for this project or not.
|
boolean |
useRelease()
Returns
true if this project uses the release state, false if it is an auto release project. |
boolean |
useWebEdit()
Should Webedit be used
|
boolean |
useWebeditApplet()
Deprecated.
since 5.0 - no replacement
|
compareTo
static final String FONTS
static final String DEFAULT_ADMIN_GROUP_NAME
static final String DEFAULT_EVERYONE_GROUP_NAME
static final String EXTERNAL_SYNCHRONISATION_GROUP_NAME
static final int LAST_DEPLOYMENT_OK
static final int LAST_DEPLOYMENT_NOT_OK
static final int STRATEGY_IGNORE_NOT_TRANSLATED
static final int STRATEGY_REPLACE_NOT_TRANSLATED_WITH_MASTER_LANGUAGE
static final int STRATEGY_REPLACE_NOT_TRANSLATED_WITH_BROKEN_LINK_PAGE
static final int STRATEGY_REPLACE_NOT_TRANSLATED_WITH_SPECIAL_PAGE
static final int DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS_WARNING_COUNT_NOT_EXCEEDED
static final int DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS
static final int DEPLOY_IF_ZERO_FATALS
static final String CUSTOM_PROPERTY_IMPORT_IDMAP
getCustomProperties(IMPORT_IDMAP)
getCustomProperties(String)
,
Constant Field Valuesstatic final String CUSTOM_PROPERTY_IMPORT_LAYERMAP
getCustomProperties(IMPORT_IDMAP)
getCustomProperties(String)
,
Constant Field Valuesstatic final String CUSTOM_PROPERTY_IMPORT_SOURCE_INFOS
getCustomProperties(IMPORT_IDMAP)
getCustomProperties(String)
,
Constant Field Valuesvoid setName(@NotNull String name)
name
- the new name@Nullable String getDescription()
void setDescription(@Nullable String description)
description
- the new description. If null
, the description is set to an empty string.List<Language> getLanguages()
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.Languages
.getEditorialLanguages()
void setLanguages(List<Language> languages)
editorial languages
don't have to be a subset of each other, they even can be completely disjunctive.languages
- list of (content) Languages
, master language must be first.@Nullable Language getLanguage(String abbreviation)
abbreviation
- see Language.getAbbreviation()
null
if there is no matching languagevoid addLanguage(Language language)
language
- the languagevoid removeLanguage(Language language)
language
- the languageLanguage getMasterLanguage()
List<Language> getEditorialLanguages()
project languages
don't have to be a subset of eachother, they even can be completely disjunctive.getLanguages()
void addEditorialLanguage(Language language)
language
- the language to add to editorial languagesvoid removeEditorialLanguage(Language language)
language
- the language to removeboolean showReferenceNames()
true
if reference names should be shown, false
otherwisevoid setShowReferenceNames(boolean showRefNames)
showRefNames
- true
to show reference names, false
to hide reference namesshowReferenceNames()
Resolution getOriginalResolution()
void setMasterLanguage(Language language)
language
- the new master languageList<Resolution> getResolutions()
resolutions
of this project.resolutions
of this projectvoid setResolutions(Resolution[] resolutions)
resolutions
- A vector containing resolutionsResolution
@Nullable Resolution getResolutionByName(String name)
null
if no resolution exists in this project with the specified name.name
- name to specifiy the resolutionnull
Resolution createResolution(String name, String description)
void removeResolution(Resolution resolution)
resolution
- the resolution to removeboolean isActive()
@NotNull List<Group> getGroups()
groups
of this project.groups
@NotNull List<Group> getGroups(User user)
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.Groups
Group[] getGroupsArray(User user)
user
- User.void removeGroup(Group group)
group
- the groupGroup createGroup(String name)
name
- unique name of the groupIllegalArgumentException
- if a group with this name already exists.Group createExternalGroup(String name, String externalName)
name
- unique name of the group.externalName
- external name (or identifier) of the group.IllegalArgumentException
- if a group with this name already exists.boolean isAdmin(User user)
user
- to test for project admin.true
if the given user
is admin or member of a project admin-group.boolean isMember(User user)
true
ifadmin
and this project allows admins (! barAdmin()
)allows every user
explicit member
of this projectuser
- user to test.true
if the given user
is member of this project.void addUser(User user)
Lockable.save()
user
- the user to addLockable.save()
void removeUser(User user)
user
- the user to removeboolean accessAllowed(User user)
user
- the useraddUser(de.espirit.firstspirit.access.User)
@NotNull List<TemplateSet> getTemplateSets()
TemplateSet
s of this project.TemplateSet
saddTemplateSet(TemplateSet)
,
removeTemplateSet(TemplateSet)
,
createTemplateSet()
void addTemplateSet(TemplateSet templateSet)
TemplateSet
.templateSet
- the TemplateSet
to addremoveTemplateSet(TemplateSet)
,
createTemplateSet()
,
getTemplateSets()
void removeTemplateSet(TemplateSet templateSet)
TemplateSet
.templateSet
- the TemplateSet
to removeaddTemplateSet(TemplateSet)
,
getTemplateSets()
TemplateSet createTemplateSet()
void setProjectLogo(InputStream data) throws IOException
data
- the stream containing the logo. supported image formats: GIF or JPEG.IOException
- connection or save problemInputStream getProjectLogo() throws IOException
IOException
- connection problemboolean hasProjectLogo()
true
if a logo exists, false
otherwisevoid removeProjectLogo()
@Nullable String getSecureMediaFolder()
null
value means no secure folder is defined.null
if no secure media folder is definedString getPermissionVariable()
void setSecureMediaFolder(String folderUid)
folderUid
- Metadata folderUid used for secure mediavoid setPermissionVariable(String variable)
variable
- Metadata variable used for permissionsString getSecureAccessURL()
void setSecureAccessURL(String secureAccessURL)
secureAccessURL
- URL for secure media accessboolean getSecureDefaultAllow()
void setSecureDefaultAllow(boolean allow)
allow
- default allow accessboolean useWebEdit()
@Nullable TemplateSet getWebEditTemplateSet()
int getWebEditTemplateSetIndex()
void setWebEditTemplateSet(TemplateSet webEditTemplateSet)
webEditTemplateSet
- the templateSet for webeditvoid setUseWebEdit(boolean useWebEdit)
useWebEdit
- webedit use@Deprecated boolean useWebeditApplet()
@Deprecated void setUseWebeditApplet(boolean useApplet)
@Deprecated List<String> getAppletEditors()
@Deprecated void setAppletEditors(List<String> editors)
void setAllowEveryone(boolean allowEveryone)
allowEveryone
- true
, to allow everyone.boolean getAllowEveryone()
true
, if everyone has access.barAdmin()
void setBarAdmin(boolean bar)
server admin
from using/editing the project.bar
- If true
, the server admin
may not usethe project.boolean barAdmin()
server admin
is barred fromusing/editing the project.true
, if server admin
is barred,false
otherwiseboolean checkPermissions()
true
if the permission check is activated for this project, false
otherwise.setPermissionCheck(boolean)
void setPermissionCheck(boolean check)
check
- true
to activate permission check, false
to deactivatecheckPermissions()
long getId()
boolean useRelease()
true
if this project uses the release state, false
if it is an auto release project.false
if it is an auto release project, true
otherwisevoid setUseRelease(boolean useRelease)
List<String> getLayers()
set the list
.void setLayers(List<String> layers)
layers
- The layer names.List<String> getReadOnlyLayers()
set the list
.void setReadOnlyLayers(List<String> layers)
layers
- A list of layer names.long getMetadataTemplate()
void setMetadataTemplate(long templateID)
void setMetadataTemplate(Template metadataTemplate)
metadataTemplate
- The metadata template.@Nullable PageTemplate getWebeditDefaultTemplate()
null
if not specified.void setWebeditDefaultTemplate(@Nullable PageTemplate template)
null
for no default page template.template
- the default page template@Nullable Workflow getWebeditDefaultWorkflow()
null
if not specified.void setWebeditDefaultWorkflow(@Nullable Workflow workflow)
null
for no default workflow.workflow
- the default workflow@NotNull PageFolder getWebeditSystemFolder()
void setWebeditSystemFolder(PageFolder folder)
folder
- webedit system folder@Nullable PageTemplate getRedirectTemplate()
external
orrelated project
linksof page reference nodes
.null
a default redirect html is used:<head><meta http-equiv="refresh" content="0; URL=...."/></head>
null
if no such template is configured (default).setRedirectTemplate(de.espirit.firstspirit.access.store.templatestore.PageTemplate)
void setRedirectTemplate(@Nullable PageTemplate template)
external
orrelated project
linksof page reference nodes
.null
a default redirect html is used:<head><meta http-equiv="refresh" content="0; URL=...."/></head>
template
- a template or null
to cleargetRedirectTemplate()
List<String> getNoSchemaSyncLayers()
set the list
.void setNoSchemaSyncLayers(List<String> layers)
layers
- A list of layer names.@Deprecated ReferenceEntry[] getBrokenReferences()
ProjectReferencesAgent.getBrokenReferences(boolean)
.getBrokenReferences(false)
).@Deprecated ReferenceEntry[] getBrokenReferences(boolean release)
ProjectReferencesAgent.getBrokenReferences(boolean)
.release
- current (false
) or release (true
) broken references.@Deprecated ReferenceEntry[] getExternalReferences()
ProjectReferencesAgent.getExternalReferences(String,boolean)
.getExternalReferences(false)
).@Deprecated ReferenceEntry[] getExternalReferences(boolean release)
ProjectReferencesAgent.getExternalReferences(String,boolean)
.release
- current (false
) or release (true
) external references.@Deprecated ReferenceEntry[] getExternalReferences(String category, boolean release)
ProjectReferencesAgent.getExternalReferences(String,boolean)
.type
.release
- current (false
) or release (true
) external references.category
- external reference category.@Nullable RemoteProjectConfiguration getRemoteProjectConfiguration(@NotNull String symbolicName)
null
if not configuration with this name exists for this project.symbolicName
- name of the remote project configuarationnull
@NotNull List<RemoteProjectConfiguration> getRemoteProjectConfigurations()
write back
a modifiedlist and save
the change.RemoteProjectConfiguration
,
setRemoteProjectConfigurations(java.util.List)
@NotNull List<RemoteProjectConfiguration> getRemoteProjectConfigurations(@Nullable Filter<RemoteProjectConfiguration> filter)
filter
- A filter to be passed by remote projects.void setRemoteProjectConfigurations(List<RemoteProjectConfiguration> remoteProjectConfigurations)
remoteProjectConfigurations
- String getMajorVersion()
String getMinorVersion()
long getServerBuild()
String getEMail()
void setEMail(String email)
boolean getShouldGenerateComment()
true
, if comments shall be generated.void setShouldGenerateComment(boolean gc)
gc
- true
, for generating comments.boolean generateAbsoluteLinks()
true
, if absolute links shall be generated.void setGenerateAbsoluteLinks(boolean absolute)
absolute
- true
, to enable generating absolute links.boolean getRenderExternalLinks()
pages
withexternal links
should generate redirect html (see getRedirectTemplate()
).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.true
if a page
with anexternal target
should be generated like normal content page, false
to generate a redirect meta htmlsetRenderExternalLinks(boolean)
,
getRedirectTemplate()
,
setRedirectTemplate(de.espirit.firstspirit.access.store.templatestore.PageTemplate)
,
PageRef.getPageLangSpec(Language)
,
PageLangSpec.setUseExternalUrl(boolean)
,
PageLangSpec.setUrl(String)
void setRenderExternalLinks(boolean renderExternalLinks)
render external links
flag.true
a page
with an external link willgenerate like a normal content page.false
(default) a redirect meta html will be rendered as result page forpages
which point to an external target.renderExternalLinks
- provide false
to generate a redirect html forpages
which point to an external target.getRenderExternalLinks()
,
getRedirectTemplate()
,
setRedirectTemplate(de.espirit.firstspirit.access.store.templatestore.PageTemplate)
String getBrokenLinkPage()
void setBrokenLinkPage(String pageRef)
pageRef
- The UID of a page reference.String getBrokenLinkMedia()
void setBrokenLinkMedia(String mediaRef)
mediaRef
- A media UID.String getNotTranslatedAlternativePage()
void setNotTranslatedAlternativePage(String pageRef)
pageRef
- The UID of a page reference.int getNotTranslatedPageStrategy()
void setNotTranslatedPageStrategy(int strategy)
strategy
- The strategy code.getNotTranslatedPageStrategy()
void setDeploymentErrorHandling(int value)
value
- The handling code.DEPLOY_IF_ZERO_FATALS
,
DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS
,
DEPLOY_IF_ZERO_FATALS_ZERO_ERRORS_WARNING_COUNT_NOT_EXCEEDED
int getDeploymentErrorHandling()
setDeploymentErrorHandling(int)
void setMaximumWarningCount(int value)
value
- The maximum.int getMaximumWarningCount()
void setQuotaHDD(long quota)
quota
- The quota in Megabytes.long getQuotaHDD()
void setQuotaPages(long quota)
quota
- The page quota.long getQuotaPages()
void setQuotaMail(String mail)
mail
- An e-mail address.String getQuotaMail()
String addDefaultLayer()
double getCacheWeight()
void setCacheWeight(double weight)
@NotNull UserService getUserService()
UserService
for this project, or returns a cached instance.UserService
instance@NotNull UserService getUserService(@NotNull Date time)
time
- a valid dateIllegalArgumentException
- if there is no fitting revision)
,
getUserService(long)
,
UserService.getRevision()
@NotNull UserService getUserService(@NotNull Revision revision)
getFirstCompleteRevision()
the returned user service may behaveunexpectedly.revision
- a valid revision.getUserService(Date)
,
getUserService(long)
,
UserService.getRevision()
@NotNull UserService getUserService(long revisionId)
getFirstCompleteRevision()
the returned user service may behaveunexpectedly.revisionId
- a valid revision idgetUserService(Date)
,
getUserService(de.espirit.firstspirit.storage.Revision)
,
UserService.getRevision()
@NotNull Revision getRevision(long revisionId)
revisionId
- the id of the revisionIllegalArgumentException
- if no revision was found with the specified id@NotNull Revision getRevision(Date revisionDate)
creation time
less or equal to the time of the given revisionDaterevisionDate
- Use HistoryProvider.EVER_SINCE
to get the first revision, HistoryProvider.UNTIL_NOW
(and NOT "new Date()
") to get the latest revision of this project.List<Revision> getRevisions(@NotNull Revision from, @NotNull Revision to, int maxCount, @Nullable Filter<Revision> filter)
from to ---I-------------------------------------------------I---> revision I<---------------------------->I result list containing "maxCount" entriesThe 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.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
.getRevision(java.util.Date)
,
RevisionFilter
Map<String,String> getCustomProperties(@NotNull String name)
name
- Scope of the propertiesvoid setCustomProperties(@NotNull String name, Map<String,String> properties)
name
- Scope of the propertiesvoid deleteCustomProperties(@NotNull String name)
name
- Scope of the properties@Nullable Object getProperty(@NotNull String name)
name
or null
if not found.name
- property name.null
.void removeProperty(@NotNull String name)
name
.name
- property name.void setProperty(@NotNull String name, @NotNull Object value)
name
to the given value
.name
- property name.value
- property value.void setActiveWebServer(String webScope, String associatedWebServer)
WebEnvironment.WebScope.LIVE
are ignoredwebScope
- webscope the webserver is used forassociatedWebServer
- the id of specified webserver@Nullable String getActiveWebServer(String webScope)
webScope
- webscope the webserver is used forWebEnvironment.WebScope.LIVE
@Deprecated void setSelectedWebServer(String webScope, String associatedWebServer)
WebEnvironment.WebScope.LIVE
are ignoredwebScope
- webscope the webserver is used forassociatedWebServer
- the id of specified webserver@Deprecated @Nullable String getSelectedWebServer(String webScope)
webScope
- webscope the webserver is used forWebEnvironment.WebScope.LIVE
void setWebAppsConfigChanged(String webScope, boolean changed)
webScope
- webscope the webserver is used forchanged
- configuration has changedboolean hasWebAppsConfigChanged(String webScope)
webScope
- webscope the webserver is used forProject.CommentMode getRevisionCommentMode(Store.Type type)
void setRevisionCommentMode(Store.Type type, Project.CommentMode mode)
boolean isReindexingSearch()
boolean isCalculatingReferences()
true
if recalculating is in progress. Shortcut forProjectReferencesAgent.isRebuildingReferences()
.true
if recalculating of references is in progress, false
otherwise.ProjectReferencesAgent.isRebuildingReferences()
Workflow getDeleteWorkflow()
void setDeleteWorkflow(Workflow workflow)
String getStagingUrl()
void setMediaSizeLimitEnabled(boolean enable)
enable
- true
activate the media file size limitationsisMediaSizeLimitEnabled()
boolean isMediaSizeLimitEnabled()
true
if enabled otherwise false
void setMediaExtensionCheckEnabled(boolean enable)
enable
- true
to enable otherwise false
boolean isMediaExtensionCheckEnabled()
true
if enabled otherwise false
@NotNull MediaConstraints getMediaConstraints()
media constraints settings
of thisproject.MediaConstraints
setMediaConstraints(MediaConstraints)
void setMediaConstraints(@NotNull MediaConstraints value)
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.value
- the project level based media constraints settingsgetMediaConstraints()
int getMaximumApplicationWidth()
-1
if there is no restriction.void setMaximumApplicationWidth(int width)
-1
if there should be no restriction.@NotNull InlinePreviewConstraints getInlinePreviewConstraints()
media constraints settings
of this project.setInlinePreviewConstraints(InlinePreviewConstraints)
void setInlinePreviewConstraints(@NotNull InlinePreviewConstraints value)
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.getInlinePreviewConstraints()
@NotNull Tag createTag(@NotNull String tag, @Nullable String comment, @Nullable Map<String,String> properties)
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
.@NotNull Tag createTag(@NotNull Revision revision, @NotNull String tag, @Nullable String comment, @Nullable Map<String,String> properties)
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
.@NotNull List<Tag> getTags(@Nullable Revision revision, int maxRevisionCount)
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.@NotNull List<Tag> getTags(@Nullable Tag tag, int maxTagCount)
tag
- The tag to start, use null for latest tag.maxTagCount
- The maximum count of tags to return. Use 0 for unlimited count.boolean getAllowUidChanges()
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.true
if users are allowed to changes the UID of an element if the corresponding permission isgranted, false
if only admins
may change UIDs.void setAllowUidChanges(boolean value)
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.value
- If true
, project users which are not admins
may changethe UID of an element if the corresponding permission is granted.boolean getAllowLanguageHiding()
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.void setAllowLanguageHiding(boolean allowLanguageHiding)
allowLanguageHiding
- set to true if the user is allowed to switch the display of languages in this projectboolean getUseServerLockForDataset()
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.true
if dataset
editing access is synced on server, else false
.setUseServerLockForDataset(boolean)
void setUseServerLockForDataset(boolean value)
dataset
editing access is synced on server. If true
dataset
editing access is synced on server - i.e. not two clients can edit the same dataset concurrently. If false
editing is synchronization is optimistic.value
- true
if dataset
editing access is synced on server, else false
.getUseServerLockForDataset()
@NotNull Revision getFirstCompleteRevision()
boolean getForbidPolyglotDataHierarchy()
true
, if polyglot data is forbidden.void setForbidPolyglotDataHierarchy(boolean forbid)
forbid
- true
, to forbid polyglot data.void setWebeditPreviewUrl(@Nullable String url)
url
- to alternative previewCopyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210