Publication (JCMS API)

java.lang.Object
- com.jalios.jstore.BasicStorable
- - com.jalios.jcms.Data
  - - com.jalios.jcms.Publication

All Implemented Interfaces:

EditableData, JcmsConstants, ImportConstants, MashupConstants, Searchable, Storable, JaliosConstants, LangPropertyArgument, TreeNode, java.lang.Cloneable, java.lang.Comparable<BasicStorable>

Direct Known Subclasses:

Content, Form, PortalElement, UserContent
```
public abstract class Publication
extends Data
implements ImportConstants, EditableData, Searchable, TreeNode
```
This abstract class is the super class of all the Publication classes.

Version:

$Revision: 93811 $

Author:

Olivier Dedieu

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Publication.AdateComparator<T extends Publication>` Compares two Publications using their Adate in descending order (newest date first).
`static class`	`Publication.AdateSelector` AdateSelector selects all the publications with a adate in a given range
`static class`	`Publication.AudienceRightComparator<T extends Publication>` Comparator to compare Publication using their audience rights.
`static class`	`Publication.AudienceRightSelector` AudienceRightSelector selects all publications being audienced.
`static class`	`Publication.AuthorComparator<T extends Publication>`
`static class`	`Publication.AuthorizedSelector` AuthorizedSelector selects all the publications a member is authorized to read.
`static class`	`Publication.CanWorkOnSelector` CanWorkOnSelector selects all the publications a member can work on.
`static class`	`Publication.DdateComparator<T extends Publication>` Compares two Publications using their Ddate in descending order (newest date first).
`static class`	`Publication.EdateComparator<T extends Publication>` Compares two Publications using their Edate in descending order (newest date first).
`static class`	`Publication.EdateSelector` EdateSelector selects all the publications with a edate in a given range
`static class`	`Publication.PdateComparator<T extends Publication>` Compares two Publications using their Pdate in descending order (newest date first).
`static class`	`Publication.PdateSelector` PdateSelector selects all the publications with a pdate in a given range
`static class`	`Publication.PopularityComparator<T extends Publication>` Comparator to compare Publication using their score based on votes
`static class`	`Publication.PstatusComparator<T extends Publication>`
`static class`	`Publication.PstatusSelector` PstatusSelector selects all the publications with a given pstatus.
`static class`	`Publication.ReaderComparator<T extends Publication>`
`static class`	`Publication.ReadRightSelector` ReadRightSelector selects all publications which have any read right.
`static class`	`Publication.RightComparator<T extends Publication>`
`static class`	`Publication.SdateComparator<T extends Publication>` Compares two Publications using their Sdate in descending order (newest date first).
`static class`	`Publication.SdateSelector` SdateSelector select all the publications with a sdate in a given range
`static class`	`Publication.TitleComparator<T extends Publication>`
`static class`	`Publication.TrackedSelector` TrackedSelector selects all the publications which are tracked.
`static class`	`Publication.TypeComparator<T extends Publication>`
`static class`	`Publication.UdateComparator<T extends Publication>` Compares two Publications using their udate in descending order (newest date first).
`static class`	`Publication.UdateSelector` UdateSelector selects all the publications with a udate in a given range
`static class`	`Publication.UserContentSelector` UserContentSelector selects all publications which are UGC (UserContent).
`static class`	`Publication.VisibleStateSelector` VisibleStateSelector selects all the publications which are in a visible state
`static class`	`Publication.VoteScoreComparator<T extends Publication>` Comparator to compare Publication using their score based the score of votes (positive votes - negative votes)
`static class`	`Publication.WorkspaceAuthorSelector` WorkspaceAuthorSelector selects all the publication the given member is the author and which belong to the given workspace.
`static class`	`Publication.WorkspaceComparator<T extends Publication>`
`static class`	`Publication.WorkspaceSelector` WorkspaceSelector selects all the publications which belong to the given workspace.

Nested classes/interfaces inherited from class com.jalios.jcms.Data
Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable
BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Date`	`adate`
`protected java.util.Set<java.lang.String>`	`allCatIdSet`
`protected java.util.Set<java.lang.String>`	`authGrpIdSet`
`protected boolean`	`authGrpIdSetDirty`
`protected boolean`	`authGrpIdSetInit`
`protected java.util.Set<java.lang.String>`	`authMbrIdSet`
`protected boolean`	`authMbrIdSetDirty`
`protected boolean`	`authMbrIdSetInit`
`protected java.util.TreeSet<Group>`	`authorizedGroupSet`
`protected java.util.TreeSet<Member>`	`authorizedMemberSet`
`protected Category[]`	`categories`
`protected java.util.TreeSet<Category>`	`categorySet`
`protected java.util.Set<java.lang.String>`	`catIdSet`
`protected boolean`	`catIdSetDirty`
`protected boolean`	`catIdSetInit`
`static int`	`CTRL_TOPIC_ADVANCED`
`static int`	`CTRL_TOPIC_CATEGORIES`
`static int`	`CTRL_TOPIC_WORKFLOW`
`protected java.util.Date`	`edate`
`protected java.util.TreeSet<java.lang.String>`	`friendlyURLSet`
`protected boolean`	`hasNoReadRightsDBData`
`protected static PublicationIndexManager`	`indexMgr`
`protected boolean`	`isTracked`
`protected Publication`	`mainInstance`
`protected java.lang.String`	`mainLanguage`
`protected int`	`majorVersion`
`protected java.util.Date`	`mergeDate`
`protected java.lang.String`	`mergeId`
`protected int`	`minorVersion`
`protected java.util.Date`	`pdate`
`protected int`	`pstatus`
`static java.lang.String`	`PUBLICATION_WFNOTE`
`protected int`	`readerCount`
`static java.lang.String`	`REVISION`
`protected java.util.HashMap<java.lang.String,java.util.TreeSet<Member>>`	`roleMap`
`protected java.util.Date`	`sdate`
`protected java.lang.String[]`	`templates`
`protected java.lang.String`	`title`
`protected java.util.HashMap<java.lang.String,java.lang.String>`	`titleML`
`protected java.util.Date`	`udate`
`protected java.util.TreeSet<Group>`	`updateGroupSet`
`protected java.util.Set<java.lang.String>`	`updateGrpIdSet`
`protected boolean`	`updateGrpIdSetDirty`
`protected boolean`	`updateGrpIdSetInit`
`protected java.util.Set<java.lang.String>`	`updateMbrIdSet`
`protected boolean`	`updateMbrIdSetDirty`
`protected boolean`	`updateMbrIdSetInit`
`protected java.util.TreeSet<Member>`	`updateMemberSet`
`protected int`	`voteCount`
`protected int`	`voteScore`
`protected java.lang.String`	`weakDataImage`
`protected AlarmEntry`	`wfExpressAlarmEntry`
`protected AlarmEntry`	`wfReminderAlarmEntry`
`protected java.lang.String`	`workflowId`
`protected Workspace`	`workspace`

Fields inherited from class com.jalios.jcms.Data
author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate

Fields inherited from class com.jalios.jstore.BasicStorable
cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants
IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants
DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, 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, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, 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, 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_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, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, 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, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

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_YEAR

Constructor Summary

Constructors
Constructor and Description

Publication()

Publication(Publication other)

Constructors
Constructor and Description
`Publication()`
`Publication(Publication other)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAuthorizedGroup(Group grp)` Add an authorized group
`void`	`addAuthorizedMember(Member mbr)` Add an authorized member.
`void`	`addCategory(Category cat)` Add the given category to the categories of this publication
`void`	`addFollower(Member mbr)` Adds a follower for this publication.
`void`	`addWeakReferrer(Publication referrer)` Add a weak referrer.
`void`	`addWFExpressAlarm()` Adds a WFExpress alarm for this publication (only for main leader replica).
`void`	`addWFReminderAlarm()` Adds a WFReminder alarm for this publication (only for main leader replica).
`void`	`assignCommonPublicationFields(Publication pub)` Assign all the common fields (author, workspace, pstatus, pdate, ...) of this publication from the given one.
`void`	`assignRole(java.lang.String roleId, Member mbr)` Assigns a member to a role
`void`	`assignRole(java.lang.String roleId, java.util.TreeSet<Member> mbrSet)`
`boolean`	`attachPublication(java.lang.String fieldName, Publication attachment)` Attaches the given publication to the given field of this publication.
`boolean`	`canBeArchived(Member mbr)` Check if the publication can be archived by the given member.
`ControllerStatus`	`canBeArchived(Member mbr, java.util.Map context)` Returns a ControllerStatus indicating if this publication can be archived or not
`boolean`	`canBeEditedFieldByField(Member mbr)` Returns true if this publication can be edited field by field on the front-office by the given member.
`boolean`	`canBeFollowedBy(Member mbr)` Returns true if the given member can follow this publication
`boolean`	`canBeReadBy(Group group)` Checks if a group can read this publication.
`boolean`	`canBeReadBy(Group group, RightInfo rightInfo)`
`boolean`	`canBeReadBy(Member member)` This convenient method is the same that canBeReadBy(member, true).
`boolean`	`canBeReadBy(Member member, boolean searchInGroups)` Check if a member can read this publication.
`boolean`	`canBeReadBy(Member member, boolean searchInGroups, RightInfo rightInfo)`
`boolean`	`canBeVotedBy(Member mbr)`
`boolean`	`canCreateCopy(Member mbr)` Returns true if the given member can create a copy of this publication
`boolean`	`canCreateCopy(Member mbr, boolean isWorkCopy)` Returns true if the given member can create a copy of this publication
`boolean`	`canCreateWorkCopy(Member mbr)` Returns true if the given member can create a work copy of this publication
`boolean`	`canMergeWorkCopy(Member mbr)` Returns true if the given member can merge this work copy with it's main instance
`boolean`	`canRequestUnlock(Member mbr)` Returns true if the given member can request to unlock this data.
`ControllerStatus`	`checkCreate(Member mbr, java.util.Map context)` Checks if the creation can be performed
`ControllerStatus`	`checkDelete(Member mbr, java.util.Map context)` Checks if the deletion can be performed
`ControllerStatus`	`checkIntegrity()` Checks whether or not data integrity constraints are respected.
`boolean`	`checkLang(java.lang.String lang)` Check if the publication is available for the given language.
`ControllerStatus`	`checkMember(int op, Member mbr, java.util.Map context)` Checks if the given member can perform the given operation.
`ControllerStatus`	`checkMerge(Member mbr, java.util.Map context)` Checks if the merge can be performed
`java.lang.Object[]`	`checkStateChange(Member mbr, int newPstatus)` Checks if the state change can be performed (it checks if the transition's rule can be perfomed)
`java.lang.Object[]`	`checkStateChange(Member mbr, int newPstatus, int oldPstatus)` Checks if the state change can be performed (it checks if the transition's rule can be perfomed)
`protected static boolean`	`checkTemplateEntry(TypeTemplateEntry tte, java.lang.String usage, boolean devModeChecks, java.lang.String label)` Checks if the given TypeTemplateEntry is matching dev modes In developpement mode it throws exception if template is null or jsp is missing In production mode it returns default template if template is null but do not check if JSP template exists to improve performances.
`ControllerStatus`	`checkUpdate(Member mbr, java.util.Map context)` Checks if the update can be performed
`ControllerStatus`	`checkWrite(int op, Member mbr, boolean checkIntegrity, java.util.Map context)` Checks if the given write operation can be performed
`void`	`clearTransientIndex()` Clear all the transient fields that contains indexes.
`void`	`cloneDBDataCollections()`
`java.lang.String`	`computeSignature()` Deprecated. use #computeSignature(boolean, boolean)
`java.lang.String`	`computeSignature(boolean includePublicationFields, boolean hash)` Compute the signature of this publication.
`boolean`	`containsCategory(Category category)` This convenient method returns true if the publication contains a given category.
`Publication`	`createCopy(Member mbr)` Creates a copy from this publication
`boolean`	`createWFNote(Member mbr, int newPstatus, int oldPstatus, java.lang.String note)` Create/Update a WFNote and check if the transition can be performed.
`boolean`	`createWFNote(Member mbr, int newPstatus, java.lang.String note)` Create/Update a WFNote and check if the transition can be performed.
`Publication`	`createWorkCopy(Member mbr)` Creates a work copy for this publication
`void`	`discardCopy(Publication copy)` This method is called when the creation of copy or a work copy of this publication has failed.
`void`	`exportXmlField(java.lang.StringBuffer sb, int indentLevel)` Fills the given StringBuffer with Xml export of fields of this data.
`java.lang.String`	`getAbstract()` Returns the abstract of this publication in the channel's main language.
`java.lang.String`	`getAbstract(java.lang.String lang)` Returns the abstract of this publication.
`java.lang.String`	`getAbstract(java.lang.String lang, boolean useDefault)` Returns the abstract of this publication.
`java.util.HashMap<java.lang.String,java.lang.String>`	`getAbstractML()` Returns the map containing abstracts of this publication in all language but the channel's main language.
`int`	`getAccessCount()`
`java.util.Date`	`getAdate()` Retrieve the archiving date of this publication.
`static <T extends Publication> java.util.Comparator<T>`	`getAdateComparator()`
`static Publication.AdateSelector`	`getAdateSelector(java.util.Date begin, java.util.Date end)`
`java.util.Set<java.lang.String>`	`getAllCatIdSet()` Do not call this method.
`java.util.Set<java.lang.String>`	`getAllFilePath()` Gives the set of all relatives path to all kind (image, media) of files linked from the given publication.
`java.lang.String`	`getAllWikiText()` Returns a String which contains the concatenation of all the wiki fields.
`java.lang.String`	`getAllWysiwygText()` Returns a String which contains the concatenation of all the wysiwyg fields.
`java.lang.String`	`getAudiencedRightsString(java.lang.String userLang, int max)` This convenient method returns a String displaying categories used by audience right (eg if this publication is restricted to member, g2, m1, m2 and m3, getReadRightsString(3) will return "g1, g2, m1, ...")
`static <T extends Publication> java.util.Comparator<T>`	`getAudienceRightComparator()`
`static Publication.AudienceRightSelector`	`getAudienceRightSelector()`
`java.util.Set<java.lang.String>`	`getAuthGrpIdSet()` Do not call this method.
`java.util.Set<java.lang.String>`	`getAuthMbrIdSet()` Do not call this method.
`java.util.Set<Group>`	`getAuthorizedGroupSet()` Get the set of Group authorized to read this Publication.
`java.util.Set<Member>`	`getAuthorizedMemberSet()` Get the set of Member authorized to read this Publication.
`static Publication.AuthorizedSelector`	`getAuthorizedSelector(Member member)`
`static Publication.CanWorkOnSelector`	`getCanWorkOnSelector(Member member)`
`Category[]`	`getCategories()` Retrieve the categories of this publication.
`Category[]`	`getCategories(Member member)` Returns the categories of the publication the member can read
`java.util.TreeSet<Category>`	`getCategorySet()` Returns the categories of this publication as a Set.
`java.util.Set<java.lang.String>`	`getCatIdSet()` Do not call this method.
`static <T extends Publication> java.util.Comparator<T>`	`getComparator(java.lang.Class<T> clazz, java.lang.String str, boolean reverse)` Deprecated. use `ComparatorManager`
`static java.util.Comparator`	`getComparator(java.lang.String str, boolean reverse)` Deprecated. use `ComparatorManager`
`static java.util.Comparator`	`getComparator(java.lang.String str, boolean reverse, QueryResultSet queryResultSet)` Deprecated. use `ComparatorManager`
`static java.lang.String`	`getCSVHeader(java.lang.String lang)` Returns the CSV header of this object
`java.lang.String`	`getDataIcon()` Returns source information for the icon associated to this Data, either a relative path or sprite classes name.
`java.lang.String`	`getDataIconTitle(java.lang.String lang)` Returns the icon's tooltip.
`java.lang.String`	`getDataImage()` Returns a data image of this publication based on the image contains in its wiki or wysiwyg fields.
`java.lang.String`	`getDataName(java.lang.String language)` Return the name of this Data, every sub class Data which will be displayed to user should implements this method already.
`java.util.Date`	`getDate(java.lang.String dateType)` Return the date corresponding to the given parameter : date/cdate, mdate, edate, pdate, sdate, adate, udate or null if nothing match or the matching date is null.
`java.util.Date`	`getDate(java.lang.String dateType, java.util.Date defaultDate)` Return the date corresponding to the given parameter : date/cdate, mdate, edate, pdate, sdate, adate, udate, or null if nothing match or the matching date is null.
`static DataSelector`	`getDateSelector(java.lang.String str, java.util.Date begin, java.util.Date end)` Retrieves a new `DataSelector` given a name representing it.
`DBDataRevision`	`getDBDataRevision(Data data, int op)`
`static <T extends Publication> java.util.Comparator<T>`	`getDdateComparator()`
`java.lang.String`	`getDefaultTemplateUsage()` Returns the default template usage used to display the publication.
`java.util.TreeSet<Category>`	`getDescendantCategorySet(Category parent)` Return the set of category of this publication which are the descendant category of a given parent category.
`java.util.TreeSet<Category>`	`getDescendantCategorySet(Category parent, boolean includingParent)` Return the set of category of this publication which are the descendant category of a given parent category, including the given parent category in case the parameter `includingParent` is true.
`java.util.TreeSet<Category>`	`getDescendantCategorySet(Category parent, boolean includingParent, Member member)` Return the set of category of this publication which are the descendant category of a given parent category, including the given parent category in case the parameter `includingParent` is true.
`java.lang.String`	`getDisplayTemplateFile()` Deprecated. Must call instead getTemplatePath()
`java.util.Set<FileDocument>`	`getDocumentLinkSet()` Returns the set of documents attached to this publication.
`java.util.Date`	`getEdate()` Retrieve the expiration date of this publication.
`static <T extends Publication> java.util.Comparator<T>`	`getEdateComparator()`
`static Publication.EdateSelector`	`getEdateSelector(java.util.Date begin, java.util.Date end)`
`int`	`getEstimatedReminderCount()` Returns an estimation of how many reminders have been sent since this publication is in this state.
`java.util.Set<java.lang.String>`	`getExternalLinkSet()` Returns all the external link contains in this publication.
`java.lang.Object`	`getFieldInMainLanguage(java.lang.Object field, java.util.HashMap fieldML)`
`java.lang.Object`	`getFieldValue(java.lang.String fieldName, java.lang.String lang, boolean useDefault)` Gets the value of the given `Object` field name for the current `Data`.
`Category`	`getFirstDescendantCategory(Category parent)` This convenient method returns the first category of the set returned by getDescendantCategorySet.
`Category`	`getFirstDescendantCategory(Category parent, boolean includingParent)` This convenient method returns the first category of the set returned by getDescendantCategorySet, including the parent in case parameter `includingParent` is true and the current publication has `parent` as category.
`Category`	`getFirstDescendantCategory(Category parent, boolean includingParent, Member member)` This convenient method returns the first category of the set returned by getDescendantCategorySet, including the parent in case parameter `includingParent` is true and the current publication has `parent` as category.
`java.util.List<Member>`	`getFollowerList(boolean searchParents)` Returns all the followers of this publication.
`java.util.TreeSet<java.lang.String>`	`getFriendlyURLSet()` Get friendly urls Set.
`boolean`	`getHasNoReadRights()` Do not call this method.
`Publication`	`getImportConflictCopy()` Returns the conflict copy bound to this imported publication (or null if there is no conflict copy).
`java.lang.String`	`getImportVersion()` Get the value of importVersion.
`java.util.Date`	`getIndexingDate()` Retrieve the Date at which this Publication was indexed in its search engine.
`Workflow`	`getInternalWorkflow()` Returns the Workflow bound internaly to this publication
`java.util.TreeSet`	`getLinkDataSet(java.lang.Class clazz)` Retuns all the data, instance of a given class, targeted by this publication through its link field (ie the link defined with the Type Editor.
`Publication`	`getMainInstance()` If this publication is a work copy then return the main instance
`java.lang.String`	`getMainLanguage()` Get the value of main language.
`int`	`getMajorVersion()` Returns the major version.
`java.util.TreeSet<Member>`	`getMemberSetAssignedToRole(java.lang.String roleId)` Returns the member bound to the given role.
`java.util.Date`	`getMergeDate()` Returns the date of the last merge with a work copy.
`java.lang.String`	`getMergeId()` Returns the id of the work copy used for the last merge.
`int`	`getMinorVersion()` Returns the minor version.
`java.util.Set<WFState>`	`getNextWFStateSet(Member member)` Returns the set of WFState the given member can put this publication in, according the rights of the member, the workflow and the current state of the publication.
`java.util.Date`	`getPdate()` Retrieve the publication date of this publication.
`static <T extends Publication> java.util.Comparator<T>`	`getPdateComparator()`
`static Publication.PdateSelector`	`getPdateSelector(java.util.Date begin, java.util.Date end)`
`int`	`getPopularity()`
`static <T extends Publication> java.util.Comparator<T>`	`getPopularityComparator()`
`int`	`getPstatus()` Get the value of pstatus.
`AlarmEntry`	`getPstatusAlarmEntry(int pstatus)` Get the alarmEntry bound to a given pstatus
`static <T extends Publication> java.util.Comparator<T>`	`getPstatusComparator()`
`static Publication.PstatusSelector`	`getPstatusSelector(int pstatus)`
`static Publication.PstatusSelector`	`getPstatusSelector(int pstatus, int greater)`
`java.lang.String`	`getQueryTemplateFile()` Deprecated. Must call instead getTemplatePath()
`static <T extends Publication> java.util.Comparator<T>`	`getReaderComparator()`
`int`	`getReaderCount()`
`java.util.List<ReaderTracker>`	`getReaderTrackerList()` Returns the reader list for the given publication.
`static Publication.ReadRightSelector`	`getReadRightSelector()`
`java.lang.String`	`getReadRightsString(int max)` 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, ...")
`static <T extends Publication> java.util.Comparator<T>`	`getRightComparator()`
`java.util.HashMap<java.lang.String,java.util.TreeSet<Member>>`	`getRoleMap()`
`java.lang.String`	`getRoleMapStr()` Returns the encoded String from the current roleMap (only used for DBData property mapping)
`java.util.Date`	`getSdate()` Retrieve the sort date of this publication.
`static <T extends Publication> java.util.Comparator<T>`	`getSdateComparator()`
`static Publication.SdateSelector`	`getSdateSelector(java.util.Date begin, java.util.Date end)`
`java.lang.String[]`	`getSearchStrings()` Searchable implementation
`java.lang.String`	`getTemplate(java.lang.String usage)` Returns the template name for the given usage
`TypeTemplateEntry`	`getTemplateEntry(java.lang.String usage, boolean devModeChecks)` Returns the TypeTemplateEntry matching the given parameters.
`static TypeTemplateEntry`	`getTemplateEntry(java.lang.String usage, boolean devModeChecks, java.lang.Class<? extends Data> clazz, Workspace ws)` Returns the TypeTemplateEntry matching the given parameters.
`java.util.Set<TypeTemplateEntry>`	`getTemplateEntrySet()` Returns a Set of TypeTemplateEntry matching current publication templates
`java.lang.String`	`getTemplatePath(JcmsJspContext ctxt)` Returns the template path for the current context
`java.lang.String`	`getTemplatePath(java.lang.String usage, boolean devModeChecks)` Returns the template path for the given usage
`java.lang.String[]`	`getTemplates()` Get the value of templates.
`java.lang.String`	`getTitle()` Retrieve the title of this publication in the main site language.
`java.lang.String`	`getTitle(java.lang.String lang)` Get the value of title bound to the given language.
`java.lang.String`	`getTitle(java.lang.String lang, boolean useDefault)` Get the value of title bound to the given language.
`static <T extends Publication> java.util.Comparator<T>`	`getTitleComparator()`
`static <T extends Publication> java.util.Comparator<T>`	`getTitleComparator(java.lang.String lang)`
`java.util.HashMap<java.lang.String,java.lang.String>`	`getTitleML()` Retrieve the HashMap containing the titles of this publication in language other than the main site language.
`static Publication.TrackedSelector`	`getTrackedSelector()`
`java.util.Collection<? extends TreeNode>`	`getTreeChildren()` Returns a Collection of TreeNode children of the current node
`TreeNode`	`getTreeParent()` Returns parent of the current node
`TreeNode`	`getTreeRoot()` Returns the root of the current node
`static <T extends Publication> java.util.Comparator<T>`	`getTypeComparator()`
`java.lang.String`	`getTypeFieldLabel(java.lang.String fieldName, java.lang.String lang)` Returns the localized label of the given field of the given publication.
`java.lang.String`	`getTypeLabel(java.lang.String lang)` Returns the label of the type of this publication.
`java.util.Date`	`getUdate()` Returns the date of last major update.
`static <T extends Publication> java.util.Comparator<T>`	`getUdateComparator()`
`static Publication.UdateSelector`	`getUdateSelector(java.util.Date begin, java.util.Date end)`
`java.util.Set<Group>`	`getUpdateGroupSet()` Get the value of updateGroupSet.
`java.util.Set<java.lang.String>`	`getUpdateGrpIdSet()` Do not call this method.
`java.util.Set<java.lang.String>`	`getUpdateMbrIdSet()` Do not call this method.
`java.util.Set<Member>`	`getUpdateMemberSet()` Get the value of updateMemberSet.
`java.lang.String`	`getVersionString()` Returns the current version (major.minor) of this publication.
`static Publication.VisibleStateSelector`	`getVisibleStateSelector()`
`int`	`getVoteCount()`
`int`	`getVoteScore()`
`static <T extends Publication> java.util.Comparator<T>`	`getVoteScoreComparator()`
`int`	`getVoteValue()`
`java.util.Set<Publication>`	`getWeakReferrerSet()` Returns the set of weak referrers.
`java.util.List<WFNote>`	`getWFNoteList()` Returns the list of WFNote bound to this publication.
`WFState`	`getWFState()` Returns the WFState bound to the current pstatus or null if none
`java.lang.String`	`getWFStateLabel(java.lang.String lang)` This convenient method returns the Workflow's state label this publication is in.
`java.lang.String`	`getWFStateLabelHtml(java.lang.String lang)` This convenient method returns the HTML Workflow's state label this publication is in.
`java.util.Set<Publication>`	`getWorkCopySet()` Get the value of workCopySet.
`Workflow`	`getWorkflow()` Returns the Workflow bound to this publication
`java.lang.String`	`getWorkflowId()` Returns the internal workflow id if set (only worklow instance, not workflow associated with the publication class)
`Workspace`	`getWorkspace()`
`static Publication.WorkspaceAuthorSelector`	`getWorkspaceAuthorSelector(Workspace workspace, Member author)`
`static <T extends Publication> java.util.Comparator<T>`	`getWorkspaceComparator(java.lang.String lang)`
`java.lang.String`	`getWorkspaceId()` Returns the JStore ID of the workspace (only for DBData)
`static Publication.WorkspaceSelector`	`getWorkspaceSelector(Workspace workspace)`
`WSTypeEntry`	`getWSTypeEntry()` This method return a WSTypeEntry for the current workspace in the current class.
`WSTypeEntry`	`getWSTypeEntry(Workspace wrkspc)` This method return a WSTypeEntry for the given workspace in the current class.
`boolean`	`hasAlreadyVoted(Member member)` Check if the given member has already voted for this publication
`boolean`	`hasAnyReadRights()` Tests if this publication has member or group read rights.
`boolean`	`hasBeenReadBy(Member mbr)` Check if the given member has read this publication
`boolean`	`hasCategory(Category cat)` Test if a publication references a given category.
`boolean`	`hasImportConflict()` Returns true if this imported publication has a conflict copy.
`boolean`	`hasNoReadRights()` Tests if this publication has NO member read rights AND NO group read rights.
`boolean`	`hasWeakReferrers()` Returns true if this publication has weak referrers.
`void`	`importConvertToLocal(Member opAuthor)` Converts this imported publication to a local data
`void`	`importMarkAsMerged(Member opAuthor)` Merges all the import extra data (import date, import version, ....) of the most recent conflict copy with the original.
`void`	`importOverrideAndUpdate(Member opAuthor)` Ignores all the local changes and replaces the local imported data with the conflict copy.
`void`	`importXml(org.jdom.Element elt, ImportOptions options)` Fill this data with the values contains in the JDOM element.
`void`	`init(Member author, Workspace ws)` This method initialise the object with default values for the given workspace: Default categories Default Authorized groups Default Pstatus Given Workspace Given Author and opAuthor
`void`	`initCopy(Member newAuthor)` Initialize this publication once it has been cloned for a copy (eg by duplicate.jsp)
`void`	`initializeDBDataCollections()` This methods force the collections of the DBData to be initialized()
`protected boolean`	`internalCanBeReadBy(Member member, boolean searchInGroups, RightInfo rightInfo)`
`void`	`invalidateWeakDataImage()`
`boolean`	`isAudienced()` Check if this publication is Audienced.
`boolean`	`isDefaultTemplate(java.lang.String usage)` Checks if the publication use a default template for the given usage
`boolean`	`isFollowedBy(Member mbr)` Returns true if the given member follows this publication.
`boolean`	`isImportConflictCopy()` Returns true if this publication is an import conflict copy.
`boolean`	`isInRole(java.lang.String roleId, Member mbr)` Determines whether the given member can use the given role for this publication
`boolean`	`isInVisibleState()` Returns true if this publication is in a visible state
`boolean`	`isPublic()` Returns true is this publication can be read by any one.
`boolean`	`isRoleAssigned(java.lang.String roleId)` Determines whether there exists at least one member assigned to the given role
`boolean`	`isTracked()` Check if a the publication's readers are tracked
`boolean`	`isTreeLeaf()` Returns boolean true if the TreeNode is a leaf
`boolean`	`isTreeNode()` Returns boolean true if the TreeNode is a node
`boolean`	`isUserContent()` Returns true if this data is User Content.
`static boolean`	`isUserContentType(java.lang.Class<?> clazz)` Checks if the given class is a "User Content" That means a Publication not manage by JCMS workers.
`boolean`	`isVersioned()` Returns true if the current Publication is versioned (is stored or is instance of HistorizedDBData)
`boolean`	`isVotable()`
`boolean`	`isWorkCopy()` Return true if this publication have a main instance
`void`	`majorUpdate()` Increments the major version
`void`	`notifyFollowers(Member opAuthor, java.util.Map context)` Notify all the follower of this publication.
`protected void`	`performAfterWrite(int op, Member mbr, java.util.Map context)` Called to perform some action after the write.
`protected void`	`performBeforeWrite(int op, Member mbr, java.util.Map context)` Called to perform some action before the write.
`void`	`performCreate(Member mbr, java.util.Map context)` Performs data creation
`void`	`performDelete(Member mbr, java.util.Map context)` Performs data deletion
`void`	`performMerge(Member mbr)` Performs publication merge
`void`	`performMerge(Member mbr, java.util.Map context)` Performs publication merge
`void`	`performUpdate(Member mbr, java.util.Map context)` Performs data update
`protected Publication`	`prepareMergeCopy()`
`void`	`putPstatusAlarmEntry(int pstatus, AlarmEntry alarmEntry)` Bind an AlarmEntry to a given pstatus
`void`	`recomputeScore()` Recompute the score of the publication
`void`	`removeAllDescendants(Member opAuthor, java.util.Map context)` Remove all descendant TreeNode that can be deleted
`void`	`removeAllFollowers()` Removes all the follower for this publication.
`void`	`removeAllReaderTracker(Member opAuthor)` Remove all the readers notes
`boolean`	`removeAuthorizedGroup(Group grp)` Remove an authorized group.
`boolean`	`removeAuthorizedMember(Member mbr)` Remove an authorized member.
`void`	`removeCategory(Category cat)` Remove the specified category from this publication's categories
`protected void`	`removeDataSet(Member opAuthor, java.util.Set<? extends Data> dataSet)` Remove all the data of the given data set
`void`	`removeFollower(Member mbr)` Removes the given follower for this publication.
`void`	`removeImportMetadata()` Remove all the import metadata on this publication
`AlarmEntry`	`removePstatusAlarmEntry(int pstatus)` Remove an AlarmEntry to a given pstatus
`void`	`removeWeakReferrer(Publication referrer)` Remove a weak referrer.
`void`	`removeWFExpressAlarm()` Removes the WFExpress alarm for this publication.
`void`	`removeWFReminderAlarm()` Removes the WFExpress alarm for this publication.
`protected static TypeTemplateEntry`	`resolveTypeTemplateEntry(WSTypeEntry wste, java.lang.String usage, java.lang.String[] templates)` Returns `TypeTemplateEntry` matching given parameters.
`void`	`setAbstract(java.lang.String value)` Set the value of the Abstract field in the main language (default site language or any other).
`void`	`setAbstract(java.lang.String lang, java.lang.String value)` Convenient method to set the value of the Abstract field in any language (default site language or any other). depending on the specified language.
`void`	`setAdate(java.util.Date v)` Set the archiving date of this publication.
`void`	`setAllCatIdSet(java.util.Set<java.lang.String> v)` Do not call this method.
`void`	`setAuthGrpIdSet(java.util.Set<java.lang.String> v)` Do not call this method.
`void`	`setAuthMbrIdSet(java.util.Set<java.lang.String> v)` Do not call this method.
`void`	`setAuthorizedGroupSet(java.util.TreeSet<Group> groupSet)` Set the set of Group authorized to read this Publication.
`void`	`setAuthorizedMemberSet(java.util.TreeSet<Member> memberSet)` Set the set of Member authorized to read this Publication.
`void`	`setCategories(Category[] cats)` Set categories of this publication.
`void`	`setCategorySet(java.util.Set<Category> catSet)` Replaces the current categories with this set of categories.
`void`	`setCatIdSet(java.util.Set<java.lang.String> v)` Do not call this method.
`void`	`setCdate(java.util.Date cdate)` Set the cdate and update the udate
`void`	`setEdate(java.util.Date v)` Set the expiration date of this publication.
`void`	`setFieldValue(java.lang.String fieldName, java.lang.Object value, java.lang.String lang)` Sets the value of the given `Object` field name for the current `Data`.
`void`	`setFriendlyURLSet(java.util.TreeSet<java.lang.String> v)` Set the value of friendlyURLSet.
`void`	`setHasNoReadRights(java.lang.Boolean b)` Do not call this method.
`void`	`setImportConflictCopy(boolean v)` Set the value of isImportConflictCopy.
`void`	`setImportVersion(java.lang.String v)` Set the value of importVersion.
`void`	`setMainInstance(Publication mainInstance)` If this publication is a work copy then set it's main instance
`void`	`setMainLanguage(java.lang.String v)` Set the value of main language.
`void`	`setMajorVersion(int majorVersion)` Set the major version.
`void`	`setMergeDate(java.util.Date mergeDate)` Set the date of the last merge with a work copy
`void`	`setMergeId(java.lang.String mergeId)` Set the id of the work copy used for the last merge.
`void`	`setMinorVersion(int minorVersion)` Set the minor version.
`void`	`setPdate(java.util.Date v)` Set the publication date of this publication.
`void`	`setPstatus(int v)` Set the value of pstatus.
`void`	`setReaderCount(int v)` Do not call this method.
`void`	`setRoleMap(java.util.HashMap<java.lang.String,java.lang.Object> roleMap)`
`void`	`setRoleMapStr(java.lang.String str)` Assigns the roleMap from the given encoded String (only used for DBData property mapping)
`void`	`setRoleMemberSetMap(java.util.HashMap<java.lang.String,java.util.TreeSet<Member>> roleMap)`
`void`	`setSdate(java.util.Date v)` Set the sort date of this publication.
`void`	`setTemplate(java.lang.String name)`
`void`	`setTemplates(java.lang.String[] v)` Set the value of templates.
`void`	`setTitle(java.lang.String v)` Set the title of this publication in the main site language.
`void`	`setTitle(java.lang.String lang, java.lang.String value)` Convenient method to set the value of the Title field in any language (default site language or any other). This method will set the proper field value (`setTitle(String)` or `setTitleML(HashMap)`) depending on the specified language.
`void`	`setTitleML(java.util.HashMap<java.lang.String,java.lang.String> v)` Set the HashMap containing the titles of this publication in language other than the main site language.
`void`	`setTracked(boolean bool)` Set the track flag
`void`	`setUdate(java.util.Date udate)` Set the date of last major update.
`void`	`setUpdateGroupSet(java.util.TreeSet<Group> v)` Set the value of updateGroupSet.
`void`	`setUpdateGrpIdSet(java.util.Set<java.lang.String> v)` Do not call this method.
`void`	`setUpdateMbrIdSet(java.util.Set<java.lang.String> v)` Do not call this method.
`void`	`setUpdateMemberSet(java.util.TreeSet<Member> v)` Set the value of updateMemberSet.
`void`	`setVoteCount(java.lang.Integer voteCount)`
`void`	`setVoteScore(java.lang.Integer voteScore)`
`void`	`setWorkflow(Workflow workflow)`
`void`	`setWorkflowId(java.lang.String wfId)` Set the internal workflow id (if the id is null, workflow will be workflow associated with publication class)
`void`	`setWorkspace(Workspace workspace)`
`void`	`setWorkspaceId(java.lang.String v)` Sets the JStore ID of the workspace (only for DBData)
`java.lang.String`	`toCSV(java.lang.String lang)` Returns a CSV view of this object
`java.lang.String`	`toFullString()`
`java.lang.String`	`toString()`
`void`	`trackReader(Member mbr)` Track the given reader.
`void`	`trackReader(Member mbr, int accessType)` Track the given reader for given access type.
`void`	`unassignMember(Member mbr)` Unassign a member from all the role he has been assigned to.
`void`	`unassignRole(java.lang.String roleId)` Unassigns a member to a role
`void`	`updatePstatus(Member author, int newPstatus, java.lang.String note)` Change the pstatus of this publication, store it and generate a WFNote
`protected java.lang.String[]`	`updateTemplate(java.lang.String name, java.lang.String[] templates)`

Methods inherited from class com.jalios.jcms.Data
canBeUnlockedBy, checkAndPerformCreate, checkAndPerformCreate, checkAndPerformDelete, checkAndPerformDelete, checkAndPerformUpdate, checkAndPerformUpdate, checkCreate, checkDelete, checkIntegrity, checkLockMember, checkStrongLockMember, checkUpdate, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataIconAlt, getDataIconCSS, getDataIconHtml, getDataIconHtml, getDataImage, getDataImage, getDataNameComparator, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLangPropertyValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getReferrerSet, getRowId, getRowIdComparator, getStrongLock, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, hashCode, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, performCreate, performDelete, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setId, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpDelegate, setRowId, unlock, unlock, unmarkNewImport, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable
clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, isStored, resolveAtt, resolveVal, setAttributes, setAttributes, setDdate, setStore, toXml

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jalios.util.TreeNode
getId

- Field Detail
  - PUBLICATION_WFNOTE
```
public static final java.lang.String PUBLICATION_WFNOTE
```
    See Also:
    Constant Field Values
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    Constant Field Values
  - CTRL_TOPIC_CATEGORIES
```
public static final int CTRL_TOPIC_CATEGORIES
```
    See Also:
    Constant Field Values
  - CTRL_TOPIC_WORKFLOW
```
public static final int CTRL_TOPIC_WORKFLOW
```
    See Also:
    Constant Field Values
  - CTRL_TOPIC_ADVANCED
```
public static final int CTRL_TOPIC_ADVANCED
```
    See Also:
    Constant Field Values
  - indexMgr
```
protected static PublicationIndexManager indexMgr
```
  - mainLanguage
```
protected java.lang.String mainLanguage
```
  - title
```
protected java.lang.String title
```
  - titleML
```
protected java.util.HashMap<java.lang.String,java.lang.String> titleML
```
  - pdate
```
protected java.util.Date pdate
```
  - edate
```
protected java.util.Date edate
```
  - sdate
```
protected java.util.Date sdate
```
  - adate
```
protected java.util.Date adate
```
  - udate
```
protected java.util.Date udate
```
  - majorVersion
```
protected int majorVersion
```
  - minorVersion
```
protected transient int minorVersion
```
  - pstatus
```
protected int pstatus
```
  - mergeDate
```
protected java.util.Date mergeDate
```
  - mergeId
```
protected java.lang.String mergeId
```
  - categories
```
protected Category[] categories
```
  - templates
```
protected java.lang.String[] templates
```
  - authorizedMemberSet
```
protected java.util.TreeSet<Member> authorizedMemberSet
```
  - authorizedGroupSet
```
protected java.util.TreeSet<Group> authorizedGroupSet
```
  - updateMemberSet
```
protected java.util.TreeSet<Member> updateMemberSet
```
  - updateGroupSet
```
protected java.util.TreeSet<Group> updateGroupSet
```
  - mainInstance
```
protected Publication mainInstance
```
  - isTracked
```
protected boolean isTracked
```
  - friendlyURLSet
```
protected java.util.TreeSet<java.lang.String> friendlyURLSet
```
  - workspace
```
protected Workspace workspace
```
  - roleMap
```
protected java.util.HashMap<java.lang.String,java.util.TreeSet<Member>> roleMap
```
  - workflowId
```
protected java.lang.String workflowId
```
  - categorySet
```
protected transient java.util.TreeSet<Category> categorySet
```
  - wfExpressAlarmEntry
```
protected transient AlarmEntry wfExpressAlarmEntry
```
  - wfReminderAlarmEntry
```
protected transient AlarmEntry wfReminderAlarmEntry
```
  - weakDataImage
```
protected transient java.lang.String weakDataImage
```
  - catIdSet
```
protected transient java.util.Set<java.lang.String> catIdSet
```
  - catIdSetDirty
```
protected transient boolean catIdSetDirty
```
  - catIdSetInit
```
protected transient boolean catIdSetInit
```
  - allCatIdSet
```
protected transient java.util.Set<java.lang.String> allCatIdSet
```
  - authMbrIdSet
```
protected transient java.util.Set<java.lang.String> authMbrIdSet
```
  - authMbrIdSetDirty
```
protected transient boolean authMbrIdSetDirty
```
  - authMbrIdSetInit
```
protected transient boolean authMbrIdSetInit
```
  - authGrpIdSet
```
protected transient java.util.Set<java.lang.String> authGrpIdSet
```
  - authGrpIdSetDirty
```
protected transient boolean authGrpIdSetDirty
```
  - authGrpIdSetInit
```
protected transient boolean authGrpIdSetInit
```
  - updateMbrIdSet
```
protected transient java.util.Set<java.lang.String> updateMbrIdSet
```
  - updateMbrIdSetDirty
```
protected transient boolean updateMbrIdSetDirty
```
  - updateMbrIdSetInit
```
protected transient boolean updateMbrIdSetInit
```
  - updateGrpIdSet
```
protected transient java.util.Set<java.lang.String> updateGrpIdSet
```
  - updateGrpIdSetDirty
```
protected transient boolean updateGrpIdSetDirty
```
  - updateGrpIdSetInit
```
protected transient boolean updateGrpIdSetInit
```
  - hasNoReadRightsDBData
```
protected transient boolean hasNoReadRightsDBData
```
  - readerCount
```
protected transient int readerCount
```
  - voteScore
```
protected transient int voteScore
```
  - voteCount
```
protected transient int voteCount
```
- Constructor Detail
  - Publication
```
public Publication()
```
  - Publication
```
public Publication(Publication other)
```
- Method Detail
  - init
```
public void init(Member author,
        Workspace ws)
```
    This method initialise the object with default values for the given workspace:
    - Default categories
    - Default Authorized groups
    - Default Pstatus
    - Given Workspace
    - Given Author and opAuthor
    It should be called after constructor and before setting parameters. Handlers already set theses parameters. This is a convenient method for external developpements.
    Parameters:
    author - the Author of the publication
    ws - the workspace of the publication
    Since:
    
    jcms-5.6.0
  - getAllWikiText
```
public java.lang.String getAllWikiText()
```
    Returns a String which contains the concatenation of all the wiki fields.
    
    Returns:
    a String which contains the concatenation of all the wiki fields.
    Since:
    
    jcms-5.5.0
  - getAllWysiwygText
```
public java.lang.String getAllWysiwygText()
```
    Returns a String which contains the concatenation of all the wysiwyg fields.
    
    Returns:
    a String which contains the concatenation of all the wysiwyg fields.
    Since:
    
    jcms-5.5.0
  - getSearchStrings
```
public java.lang.String[] getSearchStrings()
```
    Searchable implementation
    
    Specified by:
    
    getSearchStrings in interface Searchable
    
    Returns:
    an array of Strings which contains only one string which is the concatenation of all the searchable string of this publication.
    See Also:
    Searchable.getSearchStrings()
  - hasCategory
```
public boolean hasCategory(Category cat)
```
    Test if a publication references a given category.
    
    Parameters:
    cat - the category to be tested
    
    Returns:
    true if this publication has this category.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Data
    
    Returns:
    the title of the publication
  - importXml
```
public void importXml(org.jdom.Element elt,
             ImportOptions options)
```
    Description copied from class: Data
    
    Fill this data with the values contains in the JDOM element.
    
    Overrides:
    
    importXml in class Data
    
    Parameters:
    elt - the JDOM element
    options - the ImportOptions
  - getImportConflictCopy
```
public Publication getImportConflictCopy()
```
    Returns the conflict copy bound to this imported publication (or null if there is no conflict copy).
    
    Returns:
    the conflict copy bound to this imported publication (or null if there is no conflict copy).
    Since:
    
    jcms-5.7.2
  - hasImportConflict
```
public boolean hasImportConflict()
```
    Returns true if this imported publication has a conflict copy.
    
    Returns:
    true if this imported publication has a conflict copy.
    Since:
    
    jcms-5.7.2
  - isImportConflictCopy
```
public boolean isImportConflictCopy()
```
    Returns true if this publication is an import conflict copy.
    
    Returns:
    true if this publication is an import conflict copy.
    Since:
    
    jcms-5.7.2
  - setImportConflictCopy
```
public void setImportConflictCopy(boolean v)
```
    Set the value of isImportConflictCopy.
    
    Parameters:
    v - Value to assign to isImportConflictCopy.
    Since:
    
    jcms-5.7.2
  - importMarkAsMerged
```
public void importMarkAsMerged(Member opAuthor)
```
    Merges all the import extra data (import date, import version, ....) of the most recent conflict copy with the original. Then, removes all the conflit copies.
    
    Parameters:
    opAuthor - the author of the operation
    Since:
    
    jcms-5.7.2
  - importOverrideAndUpdate
```
public void importOverrideAndUpdate(Member opAuthor)
```
    Ignores all the local changes and replaces the local imported data with the conflict copy.
    
    Parameters:
    opAuthor - the author of the operation.
    Since:
    
    jcms-5.7.2
  - importConvertToLocal
```
public void importConvertToLocal(Member opAuthor)
```
    Converts this imported publication to a local data
    
    Parameters:
    opAuthor - the author of the operation
    Since:
    
    jcms-5.7.2
  - removeImportMetadata
```
public void removeImportMetadata()
```
    Remove all the import metadata on this publication
    
    Since:
    
    jcms-5.7.3
  - computeSignature
```
@Deprecated
public java.lang.String computeSignature()
```
    Deprecated. use #computeSignature(boolean, boolean)
    
    Compute the signature (MD5) of this publication. Common fields are ignored.
    
    Returns:
    the signature of this publication.
    Since:
    
    jcms-5.7.2
    
    See Also:
    computeSignature(boolean, boolean)
  - computeSignature
```
public java.lang.String computeSignature(boolean includePublicationFields,
                                boolean hash)
```
    Compute the signature of this publication.
    
    Parameters:
    includePublicationFields - if true add the common publication fields (author, pdate, categories, ...). Computed fields (cdate, mdate, udate, minorVersion) are skipped.
    hash - if true hash (MD5) the signature otherwise return the complete string of the signature.
    
    Returns:
    the signature of this publication.
    Since:
    
    jcms-6.2.0
  - exportXmlField
```
public void exportXmlField(java.lang.StringBuffer sb,
                  int indentLevel)
```
    Description copied from class: Data
    
    Fills the given StringBuffer with Xml export of fields of this data.
    
    Overrides:
    
    exportXmlField in class Data
    
    Parameters:
    sb - the StringBuffer
    indentLevel - the indent level
  - getDocumentLinkSet
```
public java.util.Set<FileDocument> getDocumentLinkSet()
```
    Returns the set of documents attached to this publication.
    
    Returns:
    the set of documents attached to this publication.
    Since:
    
    jcms-6.0.1
  - getAllFilePath
```
public java.util.Set<java.lang.String> getAllFilePath()
```
    Gives the set of all relatives path to all kind (image, media) of files linked from the given publication.
    
    Returns:
    a not null set of all relative path to linked files.
    Since:
    
    JCMS-6.1
  - getTypeLabel
```
public java.lang.String getTypeLabel(java.lang.String lang)
```
    Returns the label of the type of this publication.
    
    Parameters:
    lang - the language
    
    Returns:
    the label of the type of this publication.
    Since:
    
    jcms-5.5.0
  - getTypeFieldLabel
```
public java.lang.String getTypeFieldLabel(java.lang.String fieldName,
                                 java.lang.String lang)
```
    Returns the localized label of the given field of the given publication.
    
    Parameters:
    fieldName - the name of the field
    lang - the language
    
    Returns:
    the localized label of the given field of the given publication.
    Since:
    
    jcms-9.0.3
    
    See Also:
    Channel.getTypeFieldLabel(Class, String, String)
  - getVersionString
```
public java.lang.String getVersionString()
```
    Returns the current version (major.minor) of this publication.
    
    Returns:
    the current version (major.minor) of this publication.
    Since:
    
    jcms-5.7.0
  - majorUpdate
```
public void majorUpdate()
```
    Increments the major version
    
    Since:
    
    jcms-5.7.0
  - toFullString
```
public java.lang.String toFullString()
```
    Overrides:
    
    toFullString in class Data
    
    Returns:
    a debug string
  - toCSV
```
public java.lang.String toCSV(java.lang.String lang)
```
    Returns a CSV view of this object
    
    Overrides:
    
    toCSV in class Data
    
    Parameters:
    lang - the output language
    
    Returns:
    a CSV view of this object
    Since:
    
    jcms-5.0.0
  - getCSVHeader
```
public static java.lang.String getCSVHeader(java.lang.String lang)
```
    Returns the CSV header of this object
    
    Parameters:
    lang - the output language
    
    Returns:
    the CSV header of this object
    Since:
    
    jcms-5.0.0
  - getAbstract
```
public java.lang.String getAbstract()
```
    Returns the abstract of this publication in the channel's main language.
    
    Returns:
    the abstract of this publication in the channel's main language.
  - getAbstract
```
public java.lang.String getAbstract(java.lang.String lang,
                           boolean useDefault)
```
    Returns the abstract of this publication.
    
    Parameters:
    lang - the user language (ISO-639 language code)
    useDefault - should the default language be used
    
    Returns:
    the abstract of this publication.
  - getAbstract
```
public java.lang.String getAbstract(java.lang.String lang)
```
    Returns the abstract of this publication.
    
    Parameters:
    lang - the user language
    
    Returns:
    the abstract of this publication.
  - getAbstractML
```
public java.util.HashMap<java.lang.String,java.lang.String> getAbstractML()
```
    Returns the map containing abstracts of this publication in all language but the channel's main language.
    
    Returns:
    the map with ISO-639 language code as the key and abstract as the value, never return null.
    Since:
    
    jcms-6.0.0
  - setAbstract
```
public void setAbstract(java.lang.String lang,
               java.lang.String value)
```
    Convenient method to set the value of the Abstract field in any language (default site language or any other).
    depending on the specified language.
    
    Parameters:
    lang - the language (ISO 639 code) in which to set the value
    value - the value to set.
    Since:
    
    jcms-7.0.0
  - setAbstract
```
public void setAbstract(java.lang.String value)
```
    Set the value of the Abstract field in the main language (default site language or any other).
    
    Parameters:
    value - the value to set.
    Since:
    
    jcms-7.0.0
  - clearTransientIndex
```
public void clearTransientIndex()
```
    Clear all the transient fields that contains indexes. This method is typically called after cloning a publication.
  - setWorkflow
```
public void setWorkflow(Workflow workflow)
```
  - initCopy
```
public void initCopy(Member newAuthor)
```
    Initialize this publication once it has been cloned for a copy (eg by duplicate.jsp)
    
    Parameters:
    newAuthor - the author of this publication
    Since:
    
    jcms-4.0.2
  - discardCopy
```
public void discardCopy(Publication copy)
```
    This method is called when the creation of copy or a work copy of this publication has failed. It is intended to perform cleaning operations.
    
    Parameters:
    copy - the copy which has been discarded.
    Since:
    
    jcms-8.0.0
  - createCopy
```
public Publication createCopy(Member mbr)
```
    Creates a copy from this publication
    
    Parameters:
    mbr - the author of the copy
    
    Returns:
    a (stored) copy of this publication.
    Since:
    
    jcms-5.5.0
  - createWorkCopy
```
public Publication createWorkCopy(Member mbr)
```
    Creates a work copy for this publication
    
    Parameters:
    mbr - the author of the work copy
    
    Returns:
    a (stored) work copy of this publication. Returns null if the member cannot create a work copy.
    Since:
    
    jcms-5.5.0
  - getDescendantCategorySet
```
public java.util.TreeSet<Category> getDescendantCategorySet(Category parent)
```
    Return the set of category of this publication which are the descendant category of a given parent category. The set is ordered according the Category.OrderComparator. This methods only returns public categories (ie without read rights).
    
    Parameters:
    parent - the parent category
    
    Returns:
    a set of category.
  - getDescendantCategorySet
```
public java.util.TreeSet<Category> getDescendantCategorySet(Category parent,
                                                   boolean includingParent)
```
    Return the set of category of this publication which are the descendant category of a given parent category, including the given parent category in case the parameter includingParent is true. The set is ordered according the Category.OrderComparator. This methods only returns public categories (ie without read rights).
    
    Parameters:
    parent - the parent category
    includingParent - true if the parent has to be included in the set of tested categories
    
    Returns:
    a set of category.
  - getDescendantCategorySet
```
public java.util.TreeSet<Category> getDescendantCategorySet(Category parent,
                                                   boolean includingParent,
                                                   Member member)
```
    Return the set of category of this publication which are the descendant category of a given parent category, including the given parent category in case the parameter includingParent is true. Check category read rights for the given member. The set is ordered according the Category.OrderComparator using current userLang (see Channel.getCurrentUserLang().
    
    Parameters:
    parent - the parent category
    includingParent - true if the parent has to be included in the set of tested categories
    member - if not null, checks if the category read rights for this member
    
    Returns:
    a set of category.
    Since:
    
    jcms-4.1
  - getFirstDescendantCategory
```
public Category getFirstDescendantCategory(Category parent)
```
    This convenient method returns the first category of the set returned by getDescendantCategorySet. This methods only returns a public category (ie without read rights).
    
    Parameters:
    parent - the parent category
    
    Returns:
    the first category (or null if none)
  - getFirstDescendantCategory
```
public Category getFirstDescendantCategory(Category parent,
                                  boolean includingParent)
```
    This convenient method returns the first category of the set returned by getDescendantCategorySet, including the parent in case parameter includingParent is true and the current publication has parent as category. This methods returns a public category (ie without read rights).
    
    Parameters:
    parent - the parent category
    includingParent - true if the category membership test must be made on parent too
    
    Returns:
    the first category (or null if none)
  - getFirstDescendantCategory
```
public Category getFirstDescendantCategory(Category parent,
                                  boolean includingParent,
                                  Member member)
```
    This convenient method returns the first category of the set returned by getDescendantCategorySet, including the parent in case parameter includingParent is true and the current publication has parent as category. Check category read rights for the given member.
    
    Parameters:
    parent - the parent category
    includingParent - true if the category membership test must be made on parent too
    member - if not null, checks if the category read rights for this member
    
    Returns:
    the first category (or null if none)
    Since:
    
    jcms-4.1
  - containsCategory
```
public boolean containsCategory(Category category)
```
    This convenient method returns true if the publication contains a given category.
    
    Parameters:
    category - the category
    
    Returns:
    true if the publication contains the given category, false otherwise.
  - hasWeakReferrers
```
public boolean hasWeakReferrers()
```
    Returns true if this publication has weak referrers.
    
    Returns:
    true if this publication has weak referrers.
    Since:
    
    jcms-5.5.0
  - getWeakReferrerSet
```
public java.util.Set<Publication> getWeakReferrerSet()
```
    Returns the set of weak referrers.
  - DO NOT alter the returned set, clone prior modification..

Returns:: the set of weak referrers.
Since:: jcms-5.5.0

addWeakReferrer
```
public void addWeakReferrer(Publication referrer)
```
Add a weak referrer.

Parameters:
referrer - the weak referrer to be added.
Since:

jcms-5.5.0

removeWeakReferrer
```
public void removeWeakReferrer(Publication referrer)
```
Remove a weak referrer.

Parameters:
referrer - the weak referrer to be removed.
Since:

jcms-5.5.0

getExternalLinkSet
```
public java.util.Set<java.lang.String> getExternalLinkSet()
```
Returns all the external link contains in this publication. An external link is an absolute URL contained in an URL field, a wiki field or a wysiwyg field. URLs of the site are exclude. This method is overridden by type having URL fields.

Returns:
all the external link contains in this publication.
Since:

jcms-5.5.0

canBeReadBy
```
public final boolean canBeReadBy(Member member,
                  boolean searchInGroups)
```
Check if a member can read this publication.

Parameters:
member - the member to check
searchInGroups - if true check if one of the group this member belongs to is authorized to read this publication.

Returns:
true if the member can read this publication
Since:

jcms-2.1

canBeReadBy

public final boolean canBeReadBy(Member member,
                  boolean searchInGroups,
                  RightInfo rightInfo)

internalCanBeReadBy

protected boolean internalCanBeReadBy(Member member,
                          boolean searchInGroups,
                          RightInfo rightInfo)

isUserContent
```
public boolean isUserContent()
```
Returns true if this data is User Content.

Returns:
true if this data is an instance of UserContent.
Since:

jcms-6.0.0

isUserContentType
```
public static boolean isUserContentType(java.lang.Class<?> clazz)
```
Checks if the given class is a "User Content" That means a Publication not manage by JCMS workers.

Parameters:
clazz - the working class

Returns:
boolean true if it is a UGC Publication
Since:

jcms-6.0.0

canBeReadBy
```
public boolean canBeReadBy(Member member)
```
This convenient method is the same that canBeReadBy(member, true).

Parameters:
member - the member to check

Returns:
true if the member can read this publication
Since:

jcms-2.1

See Also:
canBeReadBy(com.jalios.jcms.Member,boolean)

canBeReadBy
```
public boolean canBeReadBy(Group group)
```
Checks if a group can read this publication.

Parameters:
group - the group to check

Returns:
true if the group can read this publication
Since:

jcms-2.1

canBeReadBy

public boolean canBeReadBy(Group group,
                  RightInfo rightInfo)

isAudienced
```
public boolean isAudienced()
```
Check if this publication is Audienced.
This methods directly calls RightPolicy.isAudienced(Publication).

Returns:
true if this publication is Audienced.
Since:

jcms-5.5.0

See Also:
RightPolicy.isAudienced(Publication)

getAudiencedRightsString
```
public java.lang.String getAudiencedRightsString(java.lang.String userLang,
                                        int max)
```
This convenient method returns a String displaying categories used by audience right (eg if this publication is restricted to member, g2, m1, m2 and m3, getReadRightsString(3) will return "g1, g2, m1, ...")

Parameters:
userLang - the user language
max - how many group/member to display

Returns:
a String
Since:

jcms-5.5.0

hasAnyReadRights
```
public boolean hasAnyReadRights()
```
Tests if this publication has member or group read rights.

Returns:
true if there are member or group read rights.
Since:

jcms-5.0.4

hasNoReadRights
```
public boolean hasNoReadRights()
```
Tests if this publication has NO member read rights AND NO group read rights.

Returns:
true if there are NO member read rights AND NO group read rights.
Since:

jcms-5.0.4

getHasNoReadRights
```
public boolean getHasNoReadRights()
```
Do not call this method. It is reserved for DBData mapping.

Returns:
the value of hasNoReadRights()
Since:

jcms-6.2.0

setHasNoReadRights
```
public void setHasNoReadRights(java.lang.Boolean b)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
b - the value
Since:

jcms-9.0.2

getReadRightsString
```
public java.lang.String getReadRightsString(int max)
```
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, ...")
The returned string is properly encoded for use in HTML attribute.

Parameters:
max - how many group/member to display

Returns:
a String
Since:

jcms-4.0

isPublic
```
public boolean isPublic()
```
Returns true is this publication can be read by any one.

Returns:
true is this publication can be read by any one.
Since:

jcms-6.0.1

getMainInstance
```
public Publication getMainInstance()
```
If this publication is a work copy then return the main instance

Returns:
the main instance
Since:

jcms-4.0

setMainInstance
```
public void setMainInstance(Publication mainInstance)
```
If this publication is a work copy then set it's main instance

Parameters:
mainInstance - the main instance
Since:

jcms-4.0

isWorkCopy
```
public boolean isWorkCopy()
```
Return true if this publication have a main instance

Returns:
true if this publication have a main instance
Since:

jcms-4.0

isInVisibleState
```
public boolean isInVisibleState()
```
Returns true if this publication is in a visible state

Returns:
true if this publication is in a visible state
Since:

jcms-4.0.2

See Also:
WFState.isVisible()

canBeArchived
```
public ControllerStatus canBeArchived(Member mbr,
                             java.util.Map context)
```
Returns a ControllerStatus indicating if this publication can be archived or not

Parameters:
mbr - the member to check
context - the

Returns:
a ControllerStatus indicating if this publication can be archived or not
See Also:
CustomArchiveManager.canBeArchived(com.jalios.jcms.Publication, com.jalios.jcms.Member, Map)

canBeArchived
```
public boolean canBeArchived(Member mbr)
```
Check if the publication can be archived by the given member.

Parameters:
mbr - the member

Returns:
true if this publication can be archived
Since:

jcms-4.1.1

See Also:
canBeArchived(Member, Map)

canCreateCopy
```
public boolean canCreateCopy(Member mbr)
```
Returns true if the given member can create a copy of this publication

Parameters:
mbr - the member to be checked

Returns:
true if a given member can create a copy of this publication
Since:

jcms-5.5.0

canCreateCopy
```
public boolean canCreateCopy(Member mbr,
                    boolean isWorkCopy)
```
Returns true if the given member can create a copy of this publication

Parameters:
mbr - the member to be checked
isWorkCopy - true if this is a workCopy

Returns:
true if a given member can create a copy of this publication
Since:

jcms-5.6.0

canCreateWorkCopy
```
public boolean canCreateWorkCopy(Member mbr)
```
Returns true if the given member can create a work copy of this publication

Parameters:
mbr - the member to be checked

Returns:
true if a given member can create a work copy of this publication
Since:

jcms-4.0

canMergeWorkCopy
```
public boolean canMergeWorkCopy(Member mbr)
```
Returns true if the given member can merge this work copy with it's main instance

Parameters:
mbr - the member to be checked

Returns:
true if the given member can merge this work copy with it's main instance
Since:

jcms-4.0

canBeEditedFieldByField
```
public boolean canBeEditedFieldByField(Member mbr)
```
Returns true if this publication can be edited field by field on the front-office by the given member.

Parameters:
mbr - the member to check

Returns:
true if this publication can be edited field by field on the front-office by the given member.
Since:

jcms-5.5.0

canRequestUnlock
```
public boolean canRequestUnlock(Member mbr)
```
Description copied from class: Data

Returns true if the given member can request to unlock this data.

Overrides:

canRequestUnlock in class Data

Parameters:
mbr - the member who request the lock

Returns:
true if the given member can request to unlock this data.

getInternalWorkflow
```
public Workflow getInternalWorkflow()
```
Returns the Workflow bound internaly to this publication

Returns:
the Workflow bound internaly to this publication, if none null is return
Since:

jcms-7.1.0

getWorkflowId
```
public java.lang.String getWorkflowId()
```
Returns the internal workflow id if set (only worklow instance, not workflow associated with the publication class)

Returns:
the internal workflow id if set (only worklow instance, not workflow associated with the publication class)

setWorkflowId
```
public void setWorkflowId(java.lang.String wfId)
```
Set the internal workflow id (if the id is null, workflow will be workflow associated with publication class)

Parameters:
wfId - the workflow id

getWorkflow
```
public Workflow getWorkflow()
```
Returns the Workflow bound to this publication

Returns:
the Workflow bound to this publication
Since:

jcms-4.0.1

getWFState
```
public WFState getWFState()
```
Returns the WFState bound to the current pstatus or null if none

Returns:
the WFState bound to the current pstatus or null if none
Since:

jcms-3.0

getWFStateLabel
```
public java.lang.String getWFStateLabel(java.lang.String lang)
```
This convenient method returns the Workflow's state label this publication is in. The label is localized according the given language.

Parameters:
lang - the language used for localisation.

Returns:
the String of the label of the WFState bound to the current pstatus or "???" if unknown state.
Since:

jcms-5.7

See Also:
getWFState()

getWFStateLabelHtml
```
public java.lang.String getWFStateLabelHtml(java.lang.String lang)
```
This convenient method returns the HTML Workflow's state label this publication is in. The label is localized according the given language.

Parameters:
lang - the language

Returns:
the HTML code of the label of the WFState bound to the current pstatus or "???" if unknown state.
Since:

jcms-7.0.0

getNextWFStateSet
```
public java.util.Set<WFState> getNextWFStateSet(Member member)
```
Returns the set of WFState the given member can put this publication in, according the rights of the member, the workflow and the current state of the publication.

Parameters:
member - the member.

Returns:
the set of WFState the given member can put this publication in.
Since:

jcms-5.7.0

getPstatusAlarmEntry
```
public AlarmEntry getPstatusAlarmEntry(int pstatus)
```
Get the alarmEntry bound to a given pstatus

Parameters:
pstatus - the pstatus

Returns:
an AlarmEntry
Since:

jcms-2.1

putPstatusAlarmEntry
```
public void putPstatusAlarmEntry(int pstatus,
                        AlarmEntry alarmEntry)
```
Bind an AlarmEntry to a given pstatus

Parameters:
pstatus - the pstatus
alarmEntry - the AlarmEntry
Since:

jcms-2.1

removePstatusAlarmEntry
```
public AlarmEntry removePstatusAlarmEntry(int pstatus)
```
Remove an AlarmEntry to a given pstatus

Parameters:
pstatus - the pstatus

Returns:
the removed AlarmEntry
Since:

jcms-2.1

getLinkDataSet
```
public java.util.TreeSet getLinkDataSet(java.lang.Class clazz)
```
Retuns all the data, instance of a given class, targeted by this publication through its link field (ie the link defined with the Type Editor. It does not includes the author. The default implementation of this method return an empty TreeSet. It must be overided by each Custom Publication Type.

Parameters:
clazz - the class of Data

Returns:
a TreeSet of instance of clazz
Since:

jcms-4.0

checkLang
```
public boolean checkLang(java.lang.String lang)
```
Check if the publication is available for the given language. Returns true if the title or the abstract of the publication is available in the given language.

Parameters:
lang - the language to check (lower-case two-letter codes as defined by ISO-639 (eg: en, fr, de, es, ...)

Returns:
true if the title or the abstract of the publication is available in the given language
Since:

jcms-4.0

getCategories
```
public Category[] getCategories(Member member)
```
Returns the categories of the publication the member can read

Parameters:
member - the member to be checked

Returns:
the categories of the publication the member can read
Since:

jcms-4.1

getCategorySet
```
public java.util.TreeSet<Category> getCategorySet()
```
Returns the categories of this publication as a Set.

Do not modify the returned value !! This method returns an internal index which is not stored. If you need to modify the categories of this publication, see methods setCategories(Category[]), addCategory(Category) or removeCategory(Category).
This methods always returns a set with the exact same categories available through getCategories().

Returns:
a TreeSet of categories (never return null). DO NOT modify this set.
Since:

jcms-5.0.0

setCategorySet
```
public void setCategorySet(java.util.Set<Category> catSet)
```
Replaces the current categories with this set of categories.

Parameters:
catSet - the new category set
Since:

jcms-5.7.2

addCategory
```
public void addCategory(Category cat)
```
Add the given category to the categories of this publication

Parameters:
cat - the category to be added
Since:

jcms-5.0.0

removeCategory
```
public void removeCategory(Category cat)
```
Remove the specified category from this publication's categories

Parameters:
cat - the category to be removed
Since:

jcms-5.6.2 jcms-5.7.1

updatePstatus
```
public void updatePstatus(Member author,
                 int newPstatus,
                 java.lang.String note)
```
Change the pstatus of this publication, store it and generate a WFNote

Parameters:
author - the author of this update (ie the author of the WFNote)
newPstatus - new value of pstatus
note - the WFNote's comment
Since:

jcms-5.0.0

getWSTypeEntry
```
public WSTypeEntry getWSTypeEntry(Workspace wrkspc)
```
This method return a WSTypeEntry for the given workspace in the current class. If workspace is null then the workspace of the publication will be used.

Parameters:
wrkspc - The working Workspace

Returns:
WSTypeEntry the TypeEntry
Since:

jcms-5.5.0

See Also:
Workspace.getWSTypeEntry(Class)

getWSTypeEntry
```
public WSTypeEntry getWSTypeEntry()
```
This method return a WSTypeEntry for the current workspace in the current class.

Returns:
WSTypeEntry the TypeEntry
Since:

jcms-6.0.0

See Also:
getWSTypeEntry(Workspace)

getDisplayTemplateFile
```
@Deprecated
public java.lang.String getDisplayTemplateFile()
```
Deprecated. Must call instead getTemplatePath()

Returns:
see getTemplatePath()

getQueryTemplateFile
```
@Deprecated
public java.lang.String getQueryTemplateFile()
```
Deprecated. Must call instead getTemplatePath()

Returns:
see getTemplatePath()

getDefaultTemplateUsage
```
public java.lang.String getDefaultTemplateUsage()
```
Returns the default template usage used to display the publication. This default template may change between Content and Portlets

Returns:
String the default usage

isDefaultTemplate
```
public boolean isDefaultTemplate(java.lang.String usage)
```
Checks if the publication use a default template for the given usage

Parameters:
usage - the template usage

Returns:
boolean true if the publication use a default template for the given usage

getTemplate
```
public java.lang.String getTemplate(java.lang.String usage)
```
Returns the template name for the given usage

Parameters:
usage - the template usage

Returns:
String the name of the template used

getTemplatePath
```
public java.lang.String getTemplatePath(JcmsJspContext ctxt)
```
Returns the template path for the current context

Parameters:
ctxt - the JcmsJspContext

Returns:
String the path of the template used

getTemplatePath
```
public java.lang.String getTemplatePath(java.lang.String usage,
                               boolean devModeChecks)
```
Returns the template path for the given usage

Parameters:
usage - the template usage
devModeChecks - perform developpement checks on template

Returns:
String the path of the template used

getTemplateEntry
```
public TypeTemplateEntry getTemplateEntry(java.lang.String usage,
                                 boolean devModeChecks)
```
Returns the TypeTemplateEntry matching the given parameters. It returns a default template if the given one does work.

Parameters:
usage - the template usage
devModeChecks - perform developpement checks on template

Returns:
TypeTemplateEntry the matching templates

getTemplateEntry
```
public static TypeTemplateEntry getTemplateEntry(java.lang.String usage,
                                 boolean devModeChecks,
                                 java.lang.Class<? extends Data> clazz,
                                 Workspace ws)
```
Returns the TypeTemplateEntry matching the given parameters. It returns a default template if the given one does work.

Parameters:
usage - the template usage
devModeChecks - perform developpement checks on template
clazz - the template publication class
ws - the workspace where to create the publication

Returns:
TypeTemplateEntry the matching templates

resolveTypeTemplateEntry
```
protected static TypeTemplateEntry resolveTypeTemplateEntry(WSTypeEntry wste,
                                         java.lang.String usage,
                                         java.lang.String[] templates)
```
Returns TypeTemplateEntry matching given parameters.
Internal mechanism:
- may default usage on a more generic usage
- will use default template if the template list is null
Parameters:
wste - the Type Description
usage - the template usage
templates - null or available templates

Returns:
TypeTemplateEntry
See Also:
TypeEntry.getFirstTemplateEntry(String, String[])

checkTemplateEntry
```
protected static boolean checkTemplateEntry(TypeTemplateEntry tte,
                         java.lang.String usage,
                         boolean devModeChecks,
                         java.lang.String label)
```
Checks if the given TypeTemplateEntry is matching dev modes In developpement mode it throws exception if template is null or jsp is missing In production mode it returns default template if template is null but do not check if JSP template exists to improve performances.

Parameters:
tte - the TypeTemplateEntry to check
usage - the usage
devModeChecks - perform developpement checks on template
label - String use for error message

Returns:
true if the TypeTemplateEntry match requirement

getTemplateEntrySet
```
public java.util.Set<TypeTemplateEntry> getTemplateEntrySet()
```
Returns a Set of TypeTemplateEntry matching current publication templates

Returns:
Set of TypeTemplateEntry

getTemplates
```
public java.lang.String[] getTemplates()
```
Get the value of templates.

Returns:
Value of templates.

setTemplates
```
public void setTemplates(java.lang.String[] v)
```
Set the value of templates.

Parameters:
v - Value to assign to templates.

setTemplate

public void setTemplate(java.lang.String name)

updateTemplate

protected java.lang.String[] updateTemplate(java.lang.String name,
                                java.lang.String[] templates)

getFieldInMainLanguage

public java.lang.Object getFieldInMainLanguage(java.lang.Object field,
                                      java.util.HashMap fieldML)

getMainLanguage
```
public java.lang.String getMainLanguage()
```
Get the value of main language.

Returns:
Value of main language.

setMainLanguage
```
public void setMainLanguage(java.lang.String v)
```
Set the value of main language.

Parameters:
v - Value to assign to main language.

getDataImage
```
public java.lang.String getDataImage()
```
Returns a data image of this publication based on the image contains in its wiki or wysiwyg fields.

Overrides:

getDataImage in class Data

Returns:
a data image of this publication based on the image contains in its wiki or wysiwyg fields.
Since:

JCMS-9.0.0

See Also:
Data.getDataImage()

invalidateWeakDataImage
```
public void invalidateWeakDataImage()
```

getDataIcon
```
public java.lang.String getDataIcon()
```
Description copied from class: Data
Returns source information for the icon associated to this Data, either a relative path or sprite classes name.
If this method behavior has not been overriden by subclass, the default icon can be declared using property types.{Type}.icon, where {Type} is the short class name of the type concerned.
- Either by specifying a relative image path :
```
types.Article.icon: images/jalios/icon/abstract.gif 
```
- or else by using a sprite icon :
```
types.Article.icon: ss_sprite ss_date
```
Overrides:

getDataIcon in class Data

Returns:
a relative path (eg images/jalios/icon/abstract.gif) or sprite classes name (eg ss_sprite ss_date).
See Also:
Data.getDataIconHtml(String)

getDataIconTitle
```
public java.lang.String getDataIconTitle(java.lang.String lang)
```
Description copied from class: Data

Returns the icon's tooltip.
If this method behavior has not been overriden by subclass, the default alternative text can be declared using language property types.{Type}.title, where {Type} is the short class name of the type concerned.

Overrides:

getDataIconTitle in class Data

Parameters:
lang - the user language.

Returns:
the title Html attribute for the IMG Html tag
See Also:
Data.getDataIconHtml(String)

getDataName
```
public java.lang.String getDataName(java.lang.String language)
```
Description copied from class: Data
Return the name of this Data, every sub class Data which will be displayed to user should implements this method already.
- The Title (multi-language) for a Publication.
- The Name (multi-language) for a Category.
- The Name for a Group, a Member.
- The Title (multi-language) for a Workspace.
Can be seen as a smart multi-language toString(), but never returning null.
Default behaviour is to return toFullString() of Data or empty string if toFullString is null.
Overrides:

getDataName in class Data

Parameters:
language - the language in which to return the name if multilang available for the data.

Returns:
title of Publication in given language or empty String if not specified.
Since:

jcms-5.1

See Also:
getTitle(String), Data.getDataName(String)

getTitle
```
public java.lang.String getTitle(java.lang.String lang)
```
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-4.0

getTitle
```
public java.lang.String getTitle(java.lang.String lang,
                        boolean useDefault)
```
Get the value of title bound to the given language.

Parameters:
lang - the language to get the title
useDefault - should main language used as default language if title does not exist in the given language

Returns:
title in the given language.
Since:

jcms-4.0

getTitle
```
public java.lang.String getTitle()
```
Retrieve the title of this publication in the main site language.

Returns:
Value of title.

setTitle
```
public void setTitle(java.lang.String v)
```
Set the title of this publication in the main site language.

Parameters:
v - value to assign to title.

getTitleML
```
public java.util.HashMap<java.lang.String,java.lang.String> getTitleML()
```
Retrieve the HashMap containing the titles of this publication in language other than the main site language.

Returns:
an HashMap of String.
Since:

jcms-4.0

setTitleML
```
public void setTitleML(java.util.HashMap<java.lang.String,java.lang.String> v)
```
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-4.0

setTitle
```
public void setTitle(java.lang.String lang,
            java.lang.String value)
```
Convenient method to set the value of the Title field in any language (default site language or any other).
This method will set the proper field value (setTitle(String) or setTitleML(HashMap)) depending on the specified language.

Parameters:
lang - the language (ISO 639 code) in which to set the value
value - the value to set.
Since:

jcms-5.7

getPdate
```
public java.util.Date getPdate()
```
Retrieve the publication date of this publication.

Returns:
the publication Date or null if not available.

setPdate
```
public void setPdate(java.util.Date v)
```
Set the publication date of this publication.

Parameters:
v - the Date to assign, can be null.

getEdate
```
public java.util.Date getEdate()
```
Retrieve the expiration date of this publication.

Returns:
the expiration Date or null if not available.

setEdate
```
public void setEdate(java.util.Date v)
```
Set the expiration date of this publication.

Parameters:
v - the Date to assign, can be null.

getSdate
```
public java.util.Date getSdate()
```
Retrieve the sort date of this publication.

Returns:
the sort Date or null if not available.
Since:

jcms-4.0

setSdate
```
public void setSdate(java.util.Date v)
```
Set the sort date of this publication.

Parameters:
v - the Date to assign, can be null.
Since:

jcms-4.0

getAdate
```
public java.util.Date getAdate()
```
Retrieve the archiving date of this publication.

Returns:
the archiving Date or null if not available.
Since:

jcms-4.1.1

setAdate
```
public void setAdate(java.util.Date v)
```
Set the archiving date of this publication.

Parameters:
v - the Date to assign, can be null.
Since:

jcms-5.0.0

setUdate
```
public void setUdate(java.util.Date udate)
```
Set the date of last major update.

Parameters:
udate - the date
Since:

jcms-5.7.0

getUdate
```
public java.util.Date getUdate()
```
Returns the date of last major update.

Returns:
the date of last major update.
Since:

jcms-5.7.0

getPstatus
```
public int getPstatus()
```
Get the value of pstatus.

Returns:
Value of pstatus.

setPstatus
```
public void setPstatus(int v)
```
Set the value of pstatus.

Parameters:
v - Value to assign to pstatus.

isVersioned
```
public boolean isVersioned()
```
Returns true if the current Publication is versioned (is stored or is instance of HistorizedDBData)

Returns:
true if the current Publication is versioned (is stored or is instance of HistorizedDBData)
Since:

jcms-7.0.3

getMajorVersion
```
public int getMajorVersion()
```
Returns the major version.

Returns:
the major version.
Since:

jcms-5.7.0

setMajorVersion
```
public void setMajorVersion(int majorVersion)
```
Set the major version.

Parameters:
majorVersion - the major version
Since:

jcms-5.7.0

getMinorVersion
```
public int getMinorVersion()
```
Returns the minor version. This field is not persistent. It is incremented each time the object is saved. It is reset when the major version is incremented (e.g. 1.0, 1.1, 1.2, 2.0, 2.1, ...)

Returns:
the minor version.
Since:

jcms-5.7.0

setMinorVersion
```
public void setMinorVersion(int minorVersion)
```
Set the minor version.

Parameters:
minorVersion - the minor version.
Since:

jcms-5.7.0

setCdate
```
public void setCdate(java.util.Date cdate)
```
Set the cdate and update the udate

Specified by:

setCdate in interface Storable

Overrides:

setCdate in class BasicStorable

Parameters:
cdate - Value to assign to cdate.
Since:

jcms-5.7.0

See Also:
BasicStorable.setCdate(java.util.Date)

setMergeDate
```
public void setMergeDate(java.util.Date mergeDate)
```
Set the date of the last merge with a work copy

Parameters:
mergeDate - the merge date.
Since:

jcms-5.7.0

getMergeDate
```
public java.util.Date getMergeDate()
```
Returns the date of the last merge with a work copy.

Returns:
the date of the last merge with a work copy.
Since:

jcms-5.7.0

setMergeId
```
public void setMergeId(java.lang.String mergeId)
```
Set the id of the work copy used for the last merge.

Parameters:
mergeId - the id of the work copy used for the last merge.
Since:

jcms-5.7.0

getMergeId
```
public java.lang.String getMergeId()
```
Returns the id of the work copy used for the last merge.

Returns:
the id of the work copy used for the last merge.
Since:

jcms-5.7.0

getCategories
```
public Category[] getCategories()
```
Retrieve the categories of this publication.

Returns:
an array of Category (can be null or empty).

setCategories
```
public void setCategories(Category[] cats)
```
Set categories of this publication.

Parameters:
cats - an array of Category (can be null or empty).

getCatIdSet
```
public java.util.Set<java.lang.String> getCatIdSet()
```
Do not call this method. It is reserved for DBData mapping.

Returns:
the category id set
Since:

jcms-6.2.0

setCatIdSet
```
public void setCatIdSet(java.util.Set<java.lang.String> v)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
v - the category id set
Since:

jcms-6.2.0

getAllCatIdSet
```
public java.util.Set<java.lang.String> getAllCatIdSet()
```
Do not call this method. It is reserved for DBData mapping.

Returns:
the "all category" id set
Since:

jcms-6.2.0

setAllCatIdSet
```
public void setAllCatIdSet(java.util.Set<java.lang.String> v)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
v - the "all category" id set
Since:

jcms-6.2.0

getVoteScore
```
public int getVoteScore()
```

setVoteScore

public void setVoteScore(java.lang.Integer voteScore)

getVoteCount
```
public int getVoteCount()
```

setVoteCount

public void setVoteCount(java.lang.Integer voteCount)

getPopularity
```
public int getPopularity()
```
Returns:
the popularity of current Publication
Since:

jcms-8.0.0

getVoteValue
```
public int getVoteValue()
```
Returns:
the vote value based on property defined in jcms.prop ("vote.default-value") or the default value
Since:

jcms-8.0.0

recomputeScore
```
public void recomputeScore()
```
Recompute the score of the publication

Since:

jcms-8.0.0

canBeVotedBy
```
public boolean canBeVotedBy(Member mbr)
```
Parameters:
mbr - the Member

Returns:
true if given Member can vote on current Publication
Since:

jcms-8.0.0

isVotable
```
public boolean isVotable()
```
Returns:
true if this Publication is votable

getWorkCopySet
```
public java.util.Set<Publication> getWorkCopySet()
```
Get the value of workCopySet.

Returns:
Value of workCopySet.
Since:

jcms-5.5.0

getAuthorizedMemberSet
```
public java.util.Set<Member> getAuthorizedMemberSet()
```
Get the set of Member authorized to read this Publication.

Returns:
a set of Member.
Since:

jcms-2.1

setAuthorizedMemberSet
```
public void setAuthorizedMemberSet(java.util.TreeSet<Member> memberSet)
```
Set the set of Member authorized to read this Publication.

Parameters:
memberSet - a set of Member.
Since:

jcms-2.1

addAuthorizedMember
```
public void addAuthorizedMember(Member mbr)
```
Add an authorized member.

Parameters:
mbr - the member to be added.
Since:

jcms-5.5.0

removeAuthorizedMember
```
public boolean removeAuthorizedMember(Member mbr)
```
Remove an authorized member.

Parameters:
mbr - the member to be removed.

Returns:
true if the set contained the specified member.
Since:

jcms-5.5.0

getAuthMbrIdSet
```
public java.util.Set<java.lang.String> getAuthMbrIdSet()
```
Do not call this method. It is reserved for DBData mapping.

Returns:
he authMbrIdSet
Since:

jcms-6.2.0

setAuthMbrIdSet
```
public void setAuthMbrIdSet(java.util.Set<java.lang.String> v)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
v - the authMbrIdSet
Since:

jcms-6.2.0

getAuthorizedGroupSet
```
public java.util.Set<Group> getAuthorizedGroupSet()
```
Get the set of Group authorized to read this Publication.

Returns:
a set of Group.
Since:

jcms-2.1

setAuthorizedGroupSet
```
public void setAuthorizedGroupSet(java.util.TreeSet<Group> groupSet)
```
Set the set of Group authorized to read this Publication.

Parameters:
groupSet - a set of Group.
Since:

jcms-2.1

addAuthorizedGroup
```
public void addAuthorizedGroup(Group grp)
```
Add an authorized group

Parameters:
grp - the group to be added.
Since:

jcms-5.5.0

removeAuthorizedGroup
```
public boolean removeAuthorizedGroup(Group grp)
```
Remove an authorized group.

Parameters:
grp - the group to be removed.

Returns:
true if the set contained the specified group.
Since:

jcms-5.5.0

getAuthGrpIdSet
```
public java.util.Set<java.lang.String> getAuthGrpIdSet()
```
Do not call this method. It is reserved for DBData mapping.

Returns:
the authGrpIdSet
Since:

jcms-6.2.0

setAuthGrpIdSet
```
public void setAuthGrpIdSet(java.util.Set<java.lang.String> v)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
v - the authGrpIdSet
Since:

jcms-6.2.0

getUpdateMemberSet
```
public java.util.Set<Member> getUpdateMemberSet()
```
Get the value of updateMemberSet.

Returns:
Value of updateMemberSet.
Since:

jcms-2.1

setUpdateMemberSet
```
public void setUpdateMemberSet(java.util.TreeSet<Member> v)
```
Set the value of updateMemberSet.

Parameters:
v - Value to assign to updateMemberSet.
Since:

jcms-2.1

getUpdateMbrIdSet
```
public java.util.Set<java.lang.String> getUpdateMbrIdSet()
```
Do not call this method. It is reserved for DBData mapping.

Returns:
he authMbrIdSet
Since:

jcms-9.0.2

setUpdateMbrIdSet
```
public void setUpdateMbrIdSet(java.util.Set<java.lang.String> v)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
v - the authMbrIdSet
Since:

jcms-9.0.2

getUpdateGroupSet
```
public java.util.Set<Group> getUpdateGroupSet()
```
Get the value of updateGroupSet.

Returns:
Value of updateGroupSet.
Since:

jcms-2.1

setUpdateGroupSet
```
public void setUpdateGroupSet(java.util.TreeSet<Group> v)
```
Set the value of updateGroupSet.

Parameters:
v - Value to assign to updateGroupSet.
Since:

jcms-2.1

getUpdateGrpIdSet
```
public java.util.Set<java.lang.String> getUpdateGrpIdSet()
```
Do not call this method. It is reserved for DBData mapping.

Returns:
the updateGrpIdSet
Since:

jcms-9.0.2

setUpdateGrpIdSet
```
public void setUpdateGrpIdSet(java.util.Set<java.lang.String> v)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
v - the authGrpIdSet
Since:

jcms-9.0.2

isTracked
```
public boolean isTracked()
```
Check if a the publication's readers are tracked

Returns:
true if the publication's readers are tracked
Since:

jcms-4.0.2

setTracked
```
public void setTracked(boolean bool)
```
Set the track flag

Parameters:
bool - a boolean
Since:

jcms-4.0.2

canBeFollowedBy
```
public boolean canBeFollowedBy(Member mbr)
```
Returns true if the given member can follow this publication

Parameters:
mbr - the member

Returns:
true if the given member can follow this publication
Since:

jcms-7.0.0

addFollower
```
public void addFollower(Member mbr)
```
Adds a follower for this publication.

Parameters:
mbr - the follower
Since:

jcms-7.0.0

removeFollower
```
public void removeFollower(Member mbr)
```
Removes the given follower for this publication.

Parameters:
mbr - the follower
Since:

jcms-7.0.0

removeAllFollowers
```
public void removeAllFollowers()
```
Removes all the follower for this publication.

Since:

jcms-7.0.0

isFollowedBy
```
public boolean isFollowedBy(Member mbr)
```
Returns true if the given member follows this publication.

Parameters:
mbr - the member to test

Returns:
true if the given member follows this publication.
Since:

jcms-7.0.0

getFollowerList
```
public java.util.List<Member> getFollowerList(boolean searchParents)
```
Returns all the followers of this publication.

Parameters:
searchParents - if true search followers of the (TreeNode) parent of this publication

Returns:
all the followers of this publication.
Since:

jcms-7.0.0

notifyFollowers
```
public void notifyFollowers(Member opAuthor,
                   java.util.Map context)
```
Notify all the follower of this publication.

Parameters:
opAuthor - the member who sets off this notification. This member won't be notified.
context - the context
Since:

jcms-7.0.0

getWorkspace
```
public Workspace getWorkspace()
```
Returns:
Returns the workspace.

setWorkspace
```
public void setWorkspace(Workspace workspace)
```
Parameters:
workspace - The workspace to set.

getRoleMap

public java.util.HashMap<java.lang.String,java.util.TreeSet<Member>> getRoleMap()

Returns:: Returns the roleMap.
Since:: jcms-5.5.0

setRoleMap

public void setRoleMap(java.util.HashMap<java.lang.String,java.lang.Object> roleMap)

Parameters:: roleMap - The roleMap to set
Since:: jcms-5.5.0

setRoleMemberSetMap

public void setRoleMemberSetMap(java.util.HashMap<java.lang.String,java.util.TreeSet<Member>> roleMap)

setRoleMapStr
```
public void setRoleMapStr(java.lang.String str)
```
Assigns the roleMap from the given encoded String (only used for DBData property mapping)

Parameters:
str - the encoded string.
Since:

jcms-7.0.1

getRoleMapStr
```
public java.lang.String getRoleMapStr()
```
Returns the encoded String from the current roleMap (only used for DBData property mapping)

Returns:
the encoded String from the current roleMap.
Since:

jcms-7.0.1

assignRole
```
public void assignRole(java.lang.String roleId,
              Member mbr)
```
Assigns a member to a role

Parameters:
roleId - the identifier of the WF role (e.g. "basic-validators")
mbr - the member to be assigned to the role
Since:

jcms-5.5.0

assignRole

public void assignRole(java.lang.String roleId,
              java.util.TreeSet<Member> mbrSet)

unassignRole
```
public void unassignRole(java.lang.String roleId)
```
Unassigns a member to a role

Parameters:
roleId - the identifier of the WF role (e.g. "basic-validators")
Since:

jcms-5.5.0

unassignMember
```
public void unassignMember(Member mbr)
```
Unassign a member from all the role he has been assigned to.

Parameters:
mbr - the member to be unassigned.
Since:

jcms-5.5.0

isRoleAssigned
```
public boolean isRoleAssigned(java.lang.String roleId)
```
Determines whether there exists at least one member assigned to the given role

Parameters:
roleId - the WFRole ID to be checked

Returns:
true if there exists at least one member assigned to the given role
Since:

jcms-5.5.0

getMemberSetAssignedToRole
```
public java.util.TreeSet<Member> getMemberSetAssignedToRole(java.lang.String roleId)
```
Returns the member bound to the given role.

Parameters:
roleId - the WFRole ID to be checked

Returns:
the member bound to the given role.
Since:

jcms-5.5.0

isInRole
```
public boolean isInRole(java.lang.String roleId,
               Member mbr)
```
Determines whether the given member can use the given role for this publication

Parameters:
roleId - the WFRole ID
mbr - the member to be checked

Returns:
true if the member can use the given role
Since:

jcms-5.5.0

getFriendlyURLSet
```
public java.util.TreeSet<java.lang.String> getFriendlyURLSet()
```
Get friendly urls Set.

Returns:
a TreeSet of friendly url (String).

setFriendlyURLSet
```
public void setFriendlyURLSet(java.util.TreeSet<java.lang.String> v)
```
Set the value of friendlyURLSet.

Parameters:
v - Value to assign to friendlyURLSet.

hasBeenReadBy
```
public boolean hasBeenReadBy(Member mbr)
```
Check if the given member has read this publication

Parameters:
mbr - The member you want to test

Returns:
true if the member has read false instead
Since:

jcms-4.0.2

getReaderTrackerList
```
public java.util.List<ReaderTracker> getReaderTrackerList()
```
Returns the reader list for the given publication.

Returns:
the reader list for the given publication.
Since:

jcms-6.0.0

getReaderCount
```
public int getReaderCount()
```
Returns:
the number of reader for this publication
Since:

jcms-4.0.2

setReaderCount
```
public void setReaderCount(int v)
```
Do not call this method. It is reserved for DBData mapping.

Parameters:
v - the value
Since:

jcms-6.2.0

getAccessCount
```
public int getAccessCount()
```
Returns:
the number of access for this publication
Since:

jcms-6.0.0

trackReader
```
public void trackReader(Member mbr)
```
Track the given reader.

Parameters:
mbr - the user to be tracked (may be null).
Since:

jcms-6.0.0

trackReader
```
public void trackReader(Member mbr,
               int accessType)
```
Track the given reader for given access type.

Parameters:
mbr - the user to be tracked (may be null).
accessType - the type of access
Since:

jcms-8.0.0

removeAllReaderTracker
```
public void removeAllReaderTracker(Member opAuthor)
```
Remove all the readers notes

Parameters:
opAuthor - the member who performs this operation
Since:

jcms-6.0.0

removeDataSet
```
protected void removeDataSet(Member opAuthor,
                 java.util.Set<? extends Data> dataSet)
```
Remove all the data of the given data set

Parameters:
opAuthor - the member who performs this operation
dataSet - the data set to be removed
Since:

jcms-5.5.0

removeAllDescendants
```
public void removeAllDescendants(Member opAuthor,
                        java.util.Map context)
```
Remove all descendant TreeNode that can be deleted

Parameters:
opAuthor - the member who performs this operation
context - the DataController's context
Since:

jcms-5.0.0

hasAlreadyVoted
```
public boolean hasAlreadyVoted(Member member)
```
Check if the given member has already voted for this publication

Parameters:
member - the member to check

Returns:
true if the given member has already voted (ie add a WFNote) in the workflow for this publication.
Since:

jcms-4.0.2

addWFExpressAlarm
```
public void addWFExpressAlarm()
```
Adds a WFExpress alarm for this publication (only for main leader replica).

Since:

jcms-5.5.0

removeWFExpressAlarm
```
public void removeWFExpressAlarm()
```
Removes the WFExpress alarm for this publication.

Since:

jcms-5.5.0

addWFReminderAlarm
```
public void addWFReminderAlarm()
```
Adds a WFReminder alarm for this publication (only for main leader replica).

Since:

jcms-5.5.0

removeWFReminderAlarm
```
public void removeWFReminderAlarm()
```
Removes the WFExpress alarm for this publication.

Since:

jcms-5.5.0

getEstimatedReminderCount
```
public int getEstimatedReminderCount()
```
Returns an estimation of how many reminders have been sent since this publication is in this state. If the publication is in a state without reminder, it returns -1.

Returns:
the reminder count or -1 if this publication is in a state without reminder.
Since:

jcms-5.5.0

checkStateChange
```
public java.lang.Object[] checkStateChange(Member mbr,
                                  int newPstatus)
```
Checks if the state change can be performed (it checks if the transition's rule can be perfomed)

Parameters:
mbr - the member who submit the state change
newPstatus - the new pstatus

Returns:
an Objec[] which contains 1) a Boolean which determines if the transition must be performed 2) the WFNote of the member if it has already voted.
Since:

jcms-5.5.0

checkStateChange
```
public java.lang.Object[] checkStateChange(Member mbr,
                                  int newPstatus,
                                  int oldPstatus)
```
Checks if the state change can be performed (it checks if the transition's rule can be perfomed)

Parameters:
mbr - the member who submit the state change
newPstatus - the new pstatus
oldPstatus - the old pstatus

Returns:
an Objec[] which contains 1) a Boolean which determines if the transition must be performed 2) the WFNote of the member if it has already voted.
Since:

jcms-6.1.3

createWFNote
```
public boolean createWFNote(Member mbr,
                   int newPstatus,
                   java.lang.String note)
```
Create/Update a WFNote and check if the transition can be performed.

Parameters:
mbr - the member which performe this operation
newPstatus - new pstatus
note - member's comment

Returns:
true if state transition must be performed
Since:

jcms-5.5.0

createWFNote
```
public boolean createWFNote(Member mbr,
                   int newPstatus,
                   int oldPstatus,
                   java.lang.String note)
```
Create/Update a WFNote and check if the transition can be performed.

Parameters:
mbr - the member which performe this operation
newPstatus - new pstatus
oldPstatus - old pstatus
note - member's comment

Returns:
true if state transition must be performed
Since:

jcms-6.1.3

getTitleComparator

public static <T extends Publication> java.util.Comparator<T> getTitleComparator()

Returns:: a new instance of Publication.TitleComparator.

getTitleComparator
```
public static <T extends Publication> java.util.Comparator<T> getTitleComparator(java.lang.String lang)
```
Parameters:
lang - the user language

Returns:
a new instance of Publication.TitleComparator using the given language.
Since:

jcms-4.0

getPdateComparator

public static <T extends Publication> java.util.Comparator<T> getPdateComparator()

Returns:: a new instance of Publication.PdateComparator.
Since:: jcms-2.1

getEdateComparator

public static <T extends Publication> java.util.Comparator<T> getEdateComparator()

Returns:: a new instance of Publication.EdateComparator.
Since:: jcms-2.1

getSdateComparator

public static <T extends Publication> java.util.Comparator<T> getSdateComparator()

Returns:: a new instance of Publication.SdateComparator.
Since:: jcms-4.0

getAdateComparator
```
public static <T extends Publication> java.util.Comparator<T> getAdateComparator()
```
Returns:
a new instance of Publication.AdateComparator.
Since:

jcms-4.1.1

getUdateComparator
```
public static <T extends Publication> java.util.Comparator<T> getUdateComparator()
```
Returns:
a new instance of Publication.UdateComparator.
Since:

jcms-5.7.0

getDdateComparator
```
public static <T extends Publication> java.util.Comparator<T> getDdateComparator()
```
Returns:
a new instance of Publication.DdateComparator.
Since:

jcms-5.5.0

getWorkspaceComparator
```
public static <T extends Publication> java.util.Comparator<T> getWorkspaceComparator(java.lang.String lang)
```
Parameters:
lang - the user language

Returns:
a new instance of Publication.WorkspaceComparator.
Since:

jcms-5.6.1

getPstatusComparator
```
public static <T extends Publication> java.util.Comparator<T> getPstatusComparator()
```
Returns:
a new instance of Publication.PstatusComparator.
Since:

jcms-2.1

getRightComparator

public static <T extends Publication> java.util.Comparator<T> getRightComparator()

Returns:: a new instance of Publication.RightComparator.
Since:: jcms-2.1

getAudienceRightComparator
```
public static <T extends Publication> java.util.Comparator<T> getAudienceRightComparator()
```
Returns:
a new instance of Publication.AudienceRightComparator.
Since:

jcms-5.5.0

getTypeComparator

public static <T extends Publication> java.util.Comparator<T> getTypeComparator()

Returns:: a new instance of Publication.TypeComparator.
Since:: jcms-2.1

getReaderComparator
```
public static <T extends Publication> java.util.Comparator<T> getReaderComparator()
```
Returns:
a new instance of Publication.ReaderComparator.
Since:

jcms-4.0.2

getVoteScoreComparator
```
public static <T extends Publication> java.util.Comparator<T> getVoteScoreComparator()
```
Returns:
a new instance of Publication.VoteScoreComparator.
Since:

jcms-8.0.0

getPopularityComparator
```
public static <T extends Publication> java.util.Comparator<T> getPopularityComparator()
```
Returns:
a new instance of Publication.PopularityComparator.
Since:

jcms-8.0.0

getComparator
```
public static java.util.Comparator getComparator(java.lang.String str,
                                 boolean reverse)
```
Deprecated. use ComparatorManager

Retrieves a new Comparator given a name representing it. The returned comparator can be used to sort any Collection containing Publications.

You can specify any of the following value:
"title": getTitleComparator()
"workspace": getWorkspaceComparator(String)
"pstatus": getPstatusComparator()
"right": getRightComparator()
"audienceRight": getAudienceRightComparator()
"type": getTypeComparator()
"pdate": getPdateComparator()
"edate": getEdateComparator()
"sdate": getSdateComparator()
"adate": getAdateComparator()
"udate": getUdateComparator()
"ddate": getDdateComparator()
"reader": getReaderComparator()

Data.getComparator(String, boolean)

Class Publication

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

Field Summary

Fields inherited from class com.jalios.jcms.Data

Fields inherited from class com.jalios.jstore.BasicStorable

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

Fields inherited from interface com.jalios.jcms.JcmsConstants

Fields inherited from interface com.jalios.util.JaliosConstants

Constructor Summary

Method Summary

Methods inherited from class com.jalios.jcms.Data

Methods inherited from class com.jalios.jstore.BasicStorable

Methods inherited from class java.lang.Object

Methods inherited from interface com.jalios.util.TreeNode

Field Detail

PUBLICATION_WFNOTE

REVISION

CTRL_TOPIC_CATEGORIES

CTRL_TOPIC_WORKFLOW

CTRL_TOPIC_ADVANCED

indexMgr

mainLanguage

title

titleML

pdate

edate

sdate

adate

udate

majorVersion

minorVersion

pstatus

mergeDate

mergeId

categories

templates

authorizedMemberSet

authorizedGroupSet

updateMemberSet

updateGroupSet

mainInstance

isTracked

friendlyURLSet

workspace

roleMap

workflowId

categorySet

wfExpressAlarmEntry

wfReminderAlarmEntry

weakDataImage

catIdSet

catIdSetDirty

catIdSetInit

allCatIdSet

authMbrIdSet

authMbrIdSetDirty

authMbrIdSetInit

authGrpIdSet

authGrpIdSetDirty

authGrpIdSetInit

updateMbrIdSet

updateMbrIdSetDirty

updateMbrIdSetInit

updateGrpIdSet

updateGrpIdSetDirty

updateGrpIdSetInit

hasNoReadRightsDBData

readerCount

voteScore

voteCount

Constructor Detail

Publication

Publication

Method Detail

init

getAllWikiText

getAllWysiwygText