public interface Project extends Comparable<Project>, Lockable
Modifier and Type | Interface and Description |
---|---|
static class |
Project.CommentMode
Comment mode options.
|
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)
Add a 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 from
using/editing the project. |
boolean |
checkPermissions()
Indicates wether 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.
|
Revision |
createTaggedRevision(String tag,
String comment)
Deprecated.
since 4.2.400 - use
createTag(String,String,java.util.Map) |
TemplateSet |
createTemplateSet()
Create a new TemplateSet
|
void |
deleteCustomProperties(String name)
Delete user defined project properties.
|
boolean |
generateAbsoluteLinks() |
String |
getActiveWebServer(String webScope)
Gets the webserver id for the specified webscope
|
boolean |
getAllowEveryone() |
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() |
String |
getBrokenLinkPage() |
ReferenceEntry[] |
getBrokenReferences()
Returns current broken references of this project (shortcut for
getBrokenReferences(false) ). |
ReferenceEntry[] |
getBrokenReferences(boolean release)
Returns current or release broken references of this project.
|
double |
getCacheWeight()
Get cache weight.
|
Map<String,String> |
getCustomProperties(String name)
Returns map of user defined properties.
|
Workflow |
getDeleteWorkflow()
Get delete Workflow.
|
int |
getDeploymentErrorHandling() |
String |
getDescription()
Gets the description of the project
|
List<Language> |
getEditorialLanguages()
Returns the list of editorial language for this project.
|
String |
getEMail() |
ReferenceEntry[] |
getExternalReferences()
Returns current external references of this project (shortcut for
getExternalReferences(false) ). |
ReferenceEntry[] |
getExternalReferences(boolean release)
Returns current or release external references of this project.
|
ReferenceEntry[] |
getExternalReferences(String category,
boolean release)
Returns project's current or release external references of the given
type . |
Revision |
getFirstCompleteRevision()
Returns the first revision up to that the history is complete (i.e. has not been archived).
|
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).
|
String |
getHTMLEncoding()
Deprecated.
since 4.2.200, use
Language.getHTMLEncoding() |
long |
getId()
Returns the ID of this project.
|
InlinePreviewConstraints |
getInlinePreviewConstraints()
Get the
media constraints settings of this project. |
Language |
getLanguage(String abbreviation)
Get the project language with the specified abbreviation.
|
List<Language> |
getLanguages()
Returns a list of all
Languages of this project. |
List<String> |
getLayers()
Returns the layer names defined for this project.
|
String |
getMajorVersion() |
Language |
getMasterLanguage()
Get the master language
|
int |
getMaximumApplicationWidth()
Returns the maximum allowed width of the inline preview frame or
-1 if there is no restriction. |
int |
getMaximumWarningCount() |
MediaConstraints |
getMediaConstraints()
Get the
media constraints settings of this
project. |
long |
getMetadataTemplate()
Get Metadata template id. -1 means no template set.
|
String |
getMinorVersion() |
String |
getName()
Get the unique project name
|
List<String> |
getNoSchemaSyncLayers()
Get the layers for which no schema sync's should be performed.
|
String |
getNotTranslatedAlternativePage() |
int |
getNotTranslatedPageStrategy()
|
Resolution |
getOriginalResolution() |
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() |
String |
getQuotaMail() |
long |
getQuotaPages() |
List<String> |
getReadOnlyLayers() |
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)
Gets the webserver id for the specified webscope
|
long |
getServerBuild() |
boolean |
getShouldGenerateComment() |
String |
getStagingUrl()
Return the url for the staging application.
|
Iterable<Pair<String,Revision>> |
getTaggedRevisions()
Deprecated.
since 4.2.400 - use
getTags(Revision,int) |
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 same
dataset concurrently. |
PageTemplate |
getWebeditDefaultTemplate()
Returns the default page template that should be used in webedit,
or
null if not specified. |
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
|
String |
getWebeditTheme()
Deprecated.
since 4.2.400 - no replacement
|
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 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)
Remove 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) |
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) |
void |
setBrokenLinkPage(String pageRef) |
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) |
void |
setDescription(String description)
Sets the description project
|
void |
setEMail(String email)
Sets the email address that will be notified when the project generation is ready!
|
void |
setGenerateAbsoluteLinks(boolean absolute) |
void |
setHTMLEncoding(String encoding)
Deprecated.
since 4.2.200, use
Language.setHTMLEncoding(String) |
void |
setInlinePreviewConstraints(InlinePreviewConstraints value)
Set the
inline preview settings of this project. |
void |
setLanguages(List<Language> languages)
Sets the languages for this project.
|
void |
setLayers(List<String> layers) |
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) |
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) |
void |
setMultiView(boolean b)
Deprecated.
since 4.2.27 - see
GenerateTask#getUrlCreatorClassName() , GenerateTask#setUrlCreatorClassName(String) |
void |
setName(String name)
Sets the name of the project
|
void |
setNoSchemaSyncLayers(List<String> layers) |
void |
setNotTranslatedAlternativePage(String pageRef) |
void |
setNotTranslatedPageStrategy(int strategy) |
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) |
void |
setQuotaMail(String mail) |
void |
setQuotaPages(long quota) |
void |
setReadOnlyLayers(List<String> layers) |
void |
setRedirectTemplate(PageTemplate template)
Sets the template which should be used to generate
external orrelated project links
of 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)
Sets the specified webserver id on the specified webscope
|
void |
setShouldGenerateComment(boolean gc) |
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 |
setUseCompatibilityMode(boolean useCompatibilityMode)
Deprecated.
since 4.2.29 - no replacement
|
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 |
setWebeditSystemFolder(PageFolder folder)
Sets the pagefolder which should be used as webedit system folder.
|
void |
setWebEditTemplateSet(TemplateSet webEditTemplateSet)
sets the templateSet for webedit
|
void |
setWebeditTheme(String webeditTheme)
Deprecated.
since 4.2.400 - no replacement
|
boolean |
showReferenceNames()
Indicates wether reference names should be shown (e.g. in create dialogs) for this project or not.
|
boolean |
useCompatibilityMode()
Deprecated.
since 4.2.29 - no replacement
|
boolean |
useMultiView()
Deprecated.
since 4.2.27 - see
GenerateTask#getUrlCreatorClassName() , GenerateTask#setUrlCreatorClassName(String) |
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 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 ValuesString getName()
void setName(@NotNull String name)
name
- the new nameString getDescription()
void setDescription(String description)
description
- the new descriptionList<Language> getLanguages()
Languages
of this project.Languages
void setLanguages(List<Language> languages)
languages
- list of 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()
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
if
admin
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 webedit@Deprecated String getWebeditTheme()
@Deprecated void setWebeditTheme(String webeditTheme)
void 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)
boolean getAllowEveryone()
barAdmin()
void setBarAdmin(boolean bar)
server admin
from using/editing the project.bar
- If true
, the server admin
may not use
the project.boolean barAdmin()
server admin
is barred from
using/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()
long getMetadataTemplate()
void setMetadataTemplate(long templateID)
void setMetadataTemplate(Template metadataTemplate)
@Nullable PageTemplate getWebeditDefaultTemplate()
null
if not specified.void setWebeditDefaultTemplate(@Nullable PageTemplate template)
null
for no default page template.template
- the default page template@NotNull PageFolder getWebeditSystemFolder()
void setWebeditSystemFolder(PageFolder folder)
folder
- webedit system folder@Nullable PageTemplate getRedirectTemplate()
external
orrelated project
links
of 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
links
of 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()
ReferenceEntry[] getBrokenReferences()
getBrokenReferences(false)
).ReferenceEntry[] getBrokenReferences(boolean release)
release
- current (false
) or release (true
) broken references.ReferenceEntry[] getExternalReferences()
getExternalReferences(false)
).ReferenceEntry[] getExternalReferences(boolean release)
release
- current (false
) or release (true
) external references.ReferenceEntry[] getExternalReferences(String category, boolean release)
type
.release
- current (false
) or release (true
) external references.category
- external reference category.RemoteProjectConfiguration getRemoteProjectConfiguration(String symbolicName)
null
if not configuration with
this name exists for this project.symbolicName
- name of the remote project configuarationnull
@NotNull List<RemoteProjectConfiguration> getRemoteProjectConfigurations()
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
- @Deprecated String getHTMLEncoding()
Language.getHTMLEncoding()
language
encoding
is used.@Deprecated void setHTMLEncoding(String encoding)
Language.setHTMLEncoding(String)
language
encoding
is used.String getMajorVersion()
String getMinorVersion()
long getServerBuild()
String getEMail()
void setEMail(String email)
@Deprecated boolean useMultiView()
GenerateTask#getUrlCreatorClassName()
, GenerateTask#setUrlCreatorClassName(String)
GenerateTask
used in a ScheduleEntry
.false
always.@Deprecated void setMultiView(boolean b)
GenerateTask#getUrlCreatorClassName()
, GenerateTask#setUrlCreatorClassName(String)
GenerateTask
used in a ScheduleEntry
.boolean getShouldGenerateComment()
void setShouldGenerateComment(boolean gc)
boolean generateAbsoluteLinks()
void setGenerateAbsoluteLinks(boolean absolute)
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 like
normal 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 will
generate 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)
String getBrokenLinkMedia()
void setBrokenLinkMedia(String mediaRef)
String getNotTranslatedAlternativePage()
void setNotTranslatedAlternativePage(String pageRef)
int getNotTranslatedPageStrategy()
void setNotTranslatedPageStrategy(int strategy)
void setDeploymentErrorHandling(int value)
int getDeploymentErrorHandling()
void setMaximumWarningCount(int value)
int getMaximumWarningCount()
void setQuotaHDD(long quota)
long getQuotaHDD()
void setQuotaPages(long quota)
long getQuotaPages()
void setQuotaMail(String mail)
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 behave
unexpectedly.revision
- a valid revision.getUserService(Date)
,
getUserService(long)
,
UserService.getRevision()
@NotNull UserService getUserService(long revisionId)
getFirstCompleteRevision()
the returned user service may behave
unexpectedly.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 revisionDaterevisionDateUse
- 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 all
revisions 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)
webScope
- webscope the webserver is used forassociatedWebServer
- the id of specified webserverString getActiveWebServer(String webScope)
webScope
- webscope the webserver is used forvoid setSelectedWebServer(String webScope, String associatedWebServer)
webScope
- webscope the webserver is used forassociatedWebServer
- the id of specified webserverString getSelectedWebServer(String webScope)
webScope
- webscope the webserver is used forvoid 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()
@Deprecated boolean useCompatibilityMode()
@Deprecated void setUseCompatibilityMode(boolean useCompatibilityMode)
useCompatibilityMode=false
calling has no effect,
if method would be called with value true
an
UnsupportedOperationException
would be thrown.UnsupportedOperationException
- for useCompatibilityMode=true
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 this
project.MediaConstraints
setMediaConstraints(MediaConstraints)
void setMediaConstraints(@NotNull MediaConstraints value)
media constraints settings
of this project. The provided instance is cloned
so 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 cloned
so changing the instance after setting has no effect for this project. You have to set the instance again to
persist the changes.getInlinePreviewConstraints()
@Deprecated @NotNull Revision createTaggedRevision(@NotNull String tag, @Nullable String comment)
createTag(String,String,java.util.Map)
tag
- Name for the tag, must not be null
and not empty after trimmed
.comment
- Comment for the tag, may be null
.getTaggedRevisions()
@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
.@Deprecated @NotNull Iterable<Pair<String,Revision>> getTaggedRevisions()
getTags(Revision,int)
key
) and revision (value
) are returned by Iterable#iterator()getTaggedRevisions().iterator()
.
The returned iterator does not support the remove
method.
@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 thechange permission
of the corresponding element.true
if users are allowed to changes the UID of an element if the corresponding permission is
granted, 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 thechange permission
of the corresponding element.value
- If true
, project users which are not admins
may change
the 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. If
allowed, 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 same
dataset 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. Iffalse
editing is synchronization is optimistic.value
- true
if dataset
editing access is synced on server, else false
.getUseServerLockForDataset()
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500