Package com.jalios.jcms.archive
Class ArchivedPublication
java.lang.Object
com.jalios.jcms.archive.ArchivedPublication
- All Implemented Interfaces:
DBData,JcmsConstants,JaliosConstants,Serializable,Comparable<ArchivedPublication>
@Deprecated(since="11.0 / JCMS-8887",
forRemoval=true)
public class ArchivedPublication
extends Object
implements Comparable<ArchivedPublication>, DBData, JcmsConstants
Deprecated, for removal: This API element is subject to removal in a future version.
This class represents an archived Publication in memory, used to keep track
of authors, rights, category, workspace of archived publication
- Since:
- jcms-4.1.1
- Author:
- Olivier Jaquemet
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected MemberDeprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.protected DateDeprecated, for removal: This API element is subject to removal in a future version.protected StringDeprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.protected StringDeprecated, for removal: This API element is subject to removal in a future version.protected StringDeprecated, for removal: This API element is subject to removal in a future version.protected shortDeprecated, for removal: This API element is subject to removal in a future version.protected StringDeprecated, for removal: This API element is subject to removal in a future version.protected LongDeprecated, for removal: This API element is subject to removal in a future version.protected StringDeprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.static final shortDeprecated, for removal: This API element is subject to removal in a future version.static final shortDeprecated, for removal: This API element is subject to removal in a future version.protected WorkspaceDeprecated, for removal: This API element is subject to removal in a future version.Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Create a new ArchivedPublication from a publication. -
Method Summary
Modifier and TypeMethodDescriptionbooleancanBeDeletedBy(Member member) Deprecated, for removal: This API element is subject to removal in a future version.Check if this archive can be deleted by specified member.booleancanBeReadBy(Member member) Deprecated, for removal: This API element is subject to removal in a future version.Check if this archive can be ready by specified member.booleancanBeUpdatedBy(Member member) Deprecated, for removal: This API element is subject to removal in a future version.Check if this archive can be updated by specified member.intcompareTo(ArchivedPublication other) Deprecated, for removal: This API element is subject to removal in a future version.voiddelete()Deprecated, for removal: This API element is subject to removal in a future version.Delete this archive (from the DB and all associated files on disk).Deprecated, for removal: This API element is subject to removal in a future version.Retrieve files associated with the given archive.Deprecated, for removal: This API element is subject to removal in a future version.Get the author of this Archive.Deprecated, for removal: This API element is subject to removal in a future version.Returns the JStore ID of the authorDeprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Get the set of Group authorized to read this archive.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Get the set of Member authorized to read this archive.getCdate()Deprecated, for removal: This API element is subject to removal in a future version.Get the archive creation date.Deprecated, for removal: This API element is subject to removal in a future version.getDescription(String lang) Deprecated, for removal: This API element is subject to removal in a future version.getDescription(String lang, boolean useDefault) Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Retrieves an xml serialization of the descriptions of this Publication in all the languages.Deprecated, for removal: This API element is subject to removal in a future version.Get the value of main language.Deprecated, for removal: This API element is subject to removal in a future version.shortDeprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.getReadRightsString(int max) Deprecated, for removal: This API element is subject to removal in a future version.This convenient method returns a String displaying group/member read rights (eg if this publication is restricted to g1, g2, m1, m2 and m3, getReadRightsString(3) will return "g1, g2, m1, ...")getRowId()Deprecated, for removal: This API element is subject to removal in a future version.getSavedHtmlPath(String userLang) Deprecated, for removal: This API element is subject to removal in a future version.Return the path (webapp relative, for jsp inclusion) of the file in which the original publication was savedDeprecated, for removal: This API element is subject to removal in a future version.Return the path (webapp relative) of the XML file in which the original publication's data was savedgetTitle()Deprecated, for removal: This API element is subject to removal in a future version.Retrieve the title of this publication in the main site language.Deprecated, for removal: This API element is subject to removal in a future version.Get the value of title bound to the given language.Deprecated, for removal: This API element is subject to removal in a future version.Get the value of title bound to the given language.Deprecated, for removal: This API element is subject to removal in a future version.Retrieve the HashMap containing the titles of this publication in language other than the main site language.Deprecated, for removal: This API element is subject to removal in a future version.Retrieves an xml serialization of the titles of this Publication in all the languages.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.booleanDeprecated, for removal: This API element is subject to removal in a future version.Tests if this archive has member or group read rights.voidsave()Deprecated, for removal: This API element is subject to removal in a future version.Creates or updates this archive in the DB.voidDeprecated, for removal: This API element is subject to removal in a future version.Set the author of this Archive.voidsetAuthorId(String authordId) Deprecated, for removal: This API element is subject to removal in a future version.Sets the JStore ID of the authorvoidsetAuthorizedGroupIds(String authorizedGroupIds) Deprecated, for removal: This API element is subject to removal in a future version.voidsetAuthorizedGroupSet(TreeSet<Group> groupSet) Deprecated, for removal: This API element is subject to removal in a future version.Set the set of Group authorized to read this archive.voidsetAuthorizedMemberIds(String authorizedMemberIds) Deprecated, for removal: This API element is subject to removal in a future version.voidsetAuthorizedMemberSet(TreeSet<Member> memberSet) Deprecated, for removal: This API element is subject to removal in a future version.Set the set of Member authorized to read this archive.voidDeprecated, for removal: This API element is subject to removal in a future version.Set the creation date of this ArchivedPublication.voidsetDescription(String value) Deprecated, for removal: This API element is subject to removal in a future version.voidsetDescriptionML(HashMap<String, String> map) Deprecated, for removal: This API element is subject to removal in a future version.voidsetDescriptionXml(String xml) Deprecated, for removal: This API element is subject to removal in a future version.Set the descriptions of this Publication in all the languages using the specified XML string.voidDeprecated, for removal: This API element is subject to removal in a future version.Set the value of main language.voidsetOriginalId(String originalId) Deprecated, for removal: This API element is subject to removal in a future version.voidsetOriginalType(short originalType) Deprecated, for removal: This API element is subject to removal in a future version.voidsetOriginalTypeLabel(String originalTypeLabel) Deprecated, for removal: This API element is subject to removal in a future version.voidDeprecated, for removal: This API element is subject to removal in a future version.voidDeprecated, for removal: This API element is subject to removal in a future version.Set the title of this publication in the main site language.voidDeprecated, for removal: This API element is subject to removal in a future version.Set the HashMap containing the titles of this publication in language other than the main site language.voidsetTitleXml(String xml) Deprecated, for removal: This API element is subject to removal in a future version.Set the titles of this Publication in all the languages using the specified XML string.voidsetWorkspace(Workspace workspace) Deprecated, for removal: This API element is subject to removal in a future version.voidsetWorkspaceId(String workspaceId) Deprecated, for removal: This API element is subject to removal in a future version.
-
Field Details
-
TYPE_CONTENT
public static final short TYPE_CONTENTDeprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
TYPE_FORM
public static final short TYPE_FORMDeprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
rowId
Deprecated, for removal: This API element is subject to removal in a future version. -
cdate
Deprecated, for removal: This API element is subject to removal in a future version. -
workspace
Deprecated, for removal: This API element is subject to removal in a future version. -
author
Deprecated, for removal: This API element is subject to removal in a future version. -
mainLanguage
Deprecated, for removal: This API element is subject to removal in a future version. -
title
Deprecated, for removal: This API element is subject to removal in a future version. -
titleML
Deprecated, for removal: This API element is subject to removal in a future version. -
description
Deprecated, for removal: This API element is subject to removal in a future version. -
descriptionML
Deprecated, for removal: This API element is subject to removal in a future version. -
originalId
Deprecated, for removal: This API element is subject to removal in a future version. -
originalType
protected short originalTypeDeprecated, for removal: This API element is subject to removal in a future version. -
originalTypeLabel
Deprecated, for removal: This API element is subject to removal in a future version. -
authorizedMemberSet
Deprecated, for removal: This API element is subject to removal in a future version. -
authorizedGroupSet
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Constructor Details
-
ArchivedPublication
public ArchivedPublication()Deprecated, for removal: This API element is subject to removal in a future version. -
ArchivedPublication
Deprecated, for removal: This API element is subject to removal in a future version.Create a new ArchivedPublication from a publication.Should only be called by the ArchiveManager which performs the whole archiving process.
- Parameters:
pub- the Publication from which we create this Archive- Since:
- jcms-4.1.1
-
-
Method Details
-
save
public void save()Deprecated, for removal: This API element is subject to removal in a future version.Creates or updates this archive in the DB. -
delete
public void delete()Deprecated, for removal: This API element is subject to removal in a future version.Delete this archive (from the DB and all associated files on disk). -
canBeReadBy
Deprecated, for removal: This API element is subject to removal in a future version.Check if this archive can be ready by specified member.- Parameters:
member- the member to check (can be null)- Returns:
- true is Member can read archive, false otherwise
-
canBeUpdatedBy
Deprecated, for removal: This API element is subject to removal in a future version.Check if this archive can be updated by specified member.- Parameters:
member- the member to check (can be null)- Returns:
- true is Member can delete archive, false otherwise
-
canBeDeletedBy
Deprecated, for removal: This API element is subject to removal in a future version.Check if this archive can be deleted by specified member.- Parameters:
member- the member to check (can be null)- Returns:
- true is Member can delete archive, false otherwise
-
getSavedHtmlPath
Deprecated, for removal: This API element is subject to removal in a future version.Return the path (webapp relative, for jsp inclusion) of the file in which the original publication was saved- Parameters:
userLang- the lang in which the Publication is wanted, if available- Returns:
- the path of the html file were the Publication was saved, or null if no file was found
- Since:
- jcms-4.1.1
-
getSavedXmlPath
Deprecated, for removal: This API element is subject to removal in a future version.Return the path (webapp relative) of the XML file in which the original publication's data was saved- Returns:
- the path of the XML file were the Publication was saved
- Since:
- jcms-4.1.1
-
getAssociatedFilesMap
Deprecated, for removal: This API element is subject to removal in a future version.Retrieve files associated with the given archive.- Returns:
- an hashmap, filename ==> filepath (webapp relative)
-
setRowId
Deprecated, for removal: This API element is subject to removal in a future version. -
getRowId
Deprecated, for removal: This API element is subject to removal in a future version. -
getCdate
Deprecated, for removal: This API element is subject to removal in a future version.Get the archive creation date.- Returns:
- a date.
-
setCdate
Deprecated, for removal: This API element is subject to removal in a future version.Set the creation date of this ArchivedPublication.- Parameters:
cdate- Value to assign to cdate.
-
getWorkspace
Deprecated, for removal: This API element is subject to removal in a future version. -
setWorkspace
Deprecated, for removal: This API element is subject to removal in a future version. -
getWorkspaceId
Deprecated, for removal: This API element is subject to removal in a future version. -
setWorkspaceId
Deprecated, for removal: This API element is subject to removal in a future version. -
getAuthor
Deprecated, for removal: This API element is subject to removal in a future version.Get the author of this Archive.- Returns:
- the Member author of this archive.
- Since:
- jcms-6.0
-
setAuthor
Deprecated, for removal: This API element is subject to removal in a future version.Set the author of this Archive.- Parameters:
mbr- Value to assign to author.- Since:
- jcms-6.0
-
getAuthorId
Deprecated, for removal: This API element is subject to removal in a future version.Returns the JStore ID of the author- Returns:
- the JStore ID of the author
- Since:
- jcms-6.0
-
setAuthorId
Deprecated, for removal: This API element is subject to removal in a future version.Sets the JStore ID of the author- Parameters:
authordId- the JStore author id- Since:
- jcms-6.0
-
getMainLanguage
Deprecated, for removal: This API element is subject to removal in a future version.Get the value of main language.- Returns:
- Value of main language.
-
setMainLanguage
Deprecated, for removal: This API element is subject to removal in a future version.Set the value of main language.- Parameters:
v- Value to assign to main language.
-
getTitle
Deprecated, for removal: This API element is subject to removal in a future version.Get the value of title bound to the given language.- Parameters:
lang- the language to get the title- Returns:
- title in the given language.
- Since:
- jcms-6.0
-
getTitle
Deprecated, for removal: This API element is subject to removal in a future version.Get the value of title bound to the given language.- Parameters:
lang- the language to get the titleuseDefault- should main language used as default language if title does not exist in the given language- Returns:
- title in the given language.
- Since:
- jcms-6.0
-
getTitle
Deprecated, for removal: This API element is subject to removal in a future version.Retrieve the title of this publication in the main site language.- Returns:
- Value of title.
- Since:
- jcms-6.0
-
setTitle
Deprecated, for removal: This API element is subject to removal in a future version.Set the title of this publication in the main site language.- Parameters:
v- value to assign to title.- Since:
- jcms-6.0
-
getTitleML
Deprecated, for removal: This API element is subject to removal in a future version.Retrieve the HashMap containing the titles of this publication in language other than the main site language.- Returns:
- an HashMap of String.
- Since:
- jcms-6.0
-
setTitleML
Deprecated, for removal: This API element is subject to removal in a future version.Set the HashMap containing the titles of this publication in language other than the main site language.- Parameters:
v- an HashMap of String.- Since:
- jcms-6.0
-
getTitleXml
Deprecated, for removal: This API element is subject to removal in a future version.Retrieves an xml serialization of the titles of this Publication in all the languages.- Returns:
- a valid XML document, as returned by
JcmsUtil.convertMultilingualFieldToXml(String, Map) - Since:
- jcms-6.0
-
setTitleXml
Deprecated, for removal: This API element is subject to removal in a future version.Set the titles of this Publication in all the languages using the specified XML string.- Parameters:
xml- an xml string as returned bygetTitleXml()- Since:
- jcms-6.0
-
getDescription
Deprecated, for removal: This API element is subject to removal in a future version. -
setDescription
Deprecated, for removal: This API element is subject to removal in a future version. -
getDescription
Deprecated, for removal: This API element is subject to removal in a future version. -
getDescription
Deprecated, for removal: This API element is subject to removal in a future version. -
getDescriptionML
Deprecated, for removal: This API element is subject to removal in a future version. -
setDescriptionML
Deprecated, for removal: This API element is subject to removal in a future version. -
getDescriptionXml
Deprecated, for removal: This API element is subject to removal in a future version.Retrieves an xml serialization of the descriptions of this Publication in all the languages.- Returns:
- a valid XML document, as returned by
JcmsUtil.convertMultilingualFieldToXml(String, Map) - Since:
- jcms-6.0
-
setDescriptionXml
Deprecated, for removal: This API element is subject to removal in a future version.Set the descriptions of this Publication in all the languages using the specified XML string.- Parameters:
xml- an xml string as returned bygetDescriptionXml()- Since:
- jcms-6.0
-
getAuthorizedMemberSet
Deprecated, for removal: This API element is subject to removal in a future version.Get the set of Member authorized to read this archive.- Returns:
- a set of Member.
- Since:
- jcms-6.0
-
setAuthorizedMemberSet
Deprecated, for removal: This API element is subject to removal in a future version.Set the set of Member authorized to read this archive.- Parameters:
memberSet- a set of Member.- Since:
- jcms-6.0
-
getAuthorizedMemberIds
Deprecated, for removal: This API element is subject to removal in a future version. -
setAuthorizedMemberIds
Deprecated, for removal: This API element is subject to removal in a future version. -
getAuthorizedGroupSet
Deprecated, for removal: This API element is subject to removal in a future version.Get the set of Group authorized to read this archive.- Returns:
- a set of Group.
- Since:
- jcms-6.0
-
setAuthorizedGroupSet
Deprecated, for removal: This API element is subject to removal in a future version.Set the set of Group authorized to read this archive.- Parameters:
groupSet- a set of Group.- Since:
- jcms-6.0
-
getAuthorizedGroupIds
Deprecated, for removal: This API element is subject to removal in a future version. -
setAuthorizedGroupIds
Deprecated, for removal: This API element is subject to removal in a future version. -
hasAnyReadRights
public boolean hasAnyReadRights()Deprecated, for removal: This API element is subject to removal in a future version.Tests if this archive has member or group read rights.- Returns:
- true if there are member or group read rights.
- Since:
- jcms-6.0
-
getReadRightsString
Deprecated, for removal: This API element is subject to removal in a future version.This convenient method returns a String displaying group/member read rights (eg if this publication is restricted to g1, g2, m1, m2 and m3, getReadRightsString(3) will return "g1, g2, m1, ...")- Parameters:
max- how many group/member to display- Returns:
- a String
- Since:
- jcms-6.0
-
getOriginalId
Deprecated, for removal: This API element is subject to removal in a future version. -
setOriginalId
Deprecated, for removal: This API element is subject to removal in a future version. -
getOriginalType
public short getOriginalType()Deprecated, for removal: This API element is subject to removal in a future version. -
setOriginalType
public void setOriginalType(short originalType) Deprecated, for removal: This API element is subject to removal in a future version. -
getOriginalTypeLabel
Deprecated, for removal: This API element is subject to removal in a future version. -
setOriginalTypeLabel
Deprecated, for removal: This API element is subject to removal in a future version. -
compareTo
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
compareToin interfaceComparable<ArchivedPublication>
-