Class PortalElement
- All Implemented Interfaces:
EditableData,JcmsConstants,ImportConstants,MashupConstants,Searchable,Storable,JaliosConstants,LangPropertyArgument,TreeNode,Cloneable,Comparable<BasicStorable>
- Direct Known Subclasses:
AbstractJPortal,Portal,PortalRedirect,Portlet
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAbilitySelector selects all the publications with the given abilityNested classes/interfaces inherited from class com.jalios.jcms.Publication
Publication.AdateComparator<T extends Publication>, Publication.AdateSelector, Publication.AudienceRightComparator<T extends Publication>, Publication.AudienceRightSelector, Publication.AuthorComparator<T extends Publication>, Publication.AuthorizedSelector, Publication.CanWorkOnSelector, Publication.DdateComparator<T extends Publication>, Publication.EdateComparator<T extends Publication>, Publication.EdateSelector, Publication.PdateComparator<T extends Publication>, Publication.PdateSelector, Publication.PopularityComparator<T extends Publication>, Publication.PstatusComparator<T extends Publication>, Publication.PstatusSelector, Publication.ReaderComparator<T extends Publication>, Publication.ReadRightSelector, Publication.RelatedCategoryComparator<T extends Publication>, Publication.RightComparator<T extends Publication>, Publication.SdateComparator<T extends Publication>, Publication.SdateSelector, Publication.TitleComparator<T extends Publication>, Publication.TrackedSelector, Publication.TypeComparator<T extends Publication>, Publication.UdateComparator<T extends Publication>, Publication.UdateSelector, Publication.UserContentSelector, Publication.VisibleStateSelector, Publication.VoteScoreComparator<T extends Publication>, Publication.WorkspaceAuthorSelector, Publication.WorkspaceComparator<T extends Publication>, Publication.WorkspaceSelectorNested 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.StrongLockSelectorNested 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
FieldsModifier and TypeFieldDescriptionprotected String[]protected Liststatic final Stringstatic final Stringprotected static TypeTemplateEntryFields inherited from class com.jalios.jcms.Publication
ACL_CAN_ATTACH_WS, adate, attachWorkspaceSet, ATTACHWS_CHECK_PUB_RIGHTS_PROP, authorizedGroupSet, authorizedMemberSet, authorizedMemberSetDBID, categories, categorySet, classificationLevel, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_FRIENDLY_URLS, CTRL_TOPIC_WORKFLOW, CTX_COPY_CATEGORIES, CTX_COPY_TITLE, CTX_COPY_TITLEML, CTX_COPY_WORKSPACE, CTX_PSTATUS_UPDATE, dbFriendlyURLSet, dbFriendlyURLSetInit, edate, extendedReadRightsDBData, friendlyURLSet, hasAttachWS, hasNoReadRightsDBData, hasNoReadRightsDBDataInitialized, indexMgr, isTracked, mainInstance, mainInstanceId, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, PUBLICATION_WFNOTE, readAck, readerCount, restrictUpdateRights, roleMap, sdate, SYNC_ATTACH_WORKSPACE_MEDIA_ENABLED_PROP, templates, title, titleML, udate, updateGroupSet, updateMemberSet, voteCount, voteScore, weakDataImage, wfExpressAlarmEntry, wfReminderAlarmEntry, workflowId, workspace, workspaceIdFields inherited from class com.jalios.jcms.Data
author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate, WRITE_IN_PROGRESS_EXTRA_INFO, WYSIWYG_INLINE_EDIT_REQUEST_PARAMETERFields inherited from class com.jalios.jstore.BasicStorable
cdate, ddate, id, isStoreCache, mdate, storeFields 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_PROPFields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XMLFields 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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAbility(String ability) Add the given ability to this portal abilitiesbooleanSame as getAllTreeChildren() but stop when there is a match.Duplicate a PortalElement using one of its default constructor, and create it in the store.duplicate(WizardContext context, boolean deep) Performs a deep duplicate.Duplicates a PortalElement and add a Prefix to the title.Performs a deep duplicate.Deprecated.protected voidduplicateDeep(PortalElement parent, String prefix, Member author, Workspace wkspc, Map catMap, Map groupMap) Deprecated.Used insteadduplicateDeep(WizardContext, PortalElement)protected voidduplicateDeep(WizardContext context, PortalElement parent) Performs a deep duplicate of the PortalElement in a WizardContext.String[]String[]getAbilities(String lang) String[]getAbilities(String lang, boolean useDefault) getAbilityLabel(String userLang, String ability) Deprecated.getAbilitySelector(String ability) Retrieves a new instance ofPortalElement.AbilitySelectorusing the specified abilityString.Returns the abstract of this publication in the channel's main language.getAbstract(String lang, boolean useDefault) Returns the abstract of this publication.static String[]Deprecated.static String[]getAllAbilities(Class clazz) Deprecated.static MapDeprecated.Deprecated.Retrieve a new collection containing all PortalElement children of this PortalElementabstract Stringabstract Stringabstract StringintgetContentTitle(String lang) abstract Stringabstract StringgetCssId()Returns source information for the icon associated to this Data, either a relative path or sprite classes name.Returns the default template usage used to display the publication.abstract StringgetDescription(String lang) abstract StringgetDescription(String lang, boolean b) getIcon()abstract String[]abstract longabstract StringgetPortletImage(String lang) abstract StringgetPortletImage(String lang, boolean b) getPreview(JcmsJspContext ctxt, int width, int height, String defaultImagePath) Retrieve the preview image of this Portlet in the specified context and dimensions.Class[]getSkinPath(JcmsJspContext ctxt) Returns the template skin path for the given usagegetSkinPath(String usage, boolean devModeChecks) Returns the template skin path for the given usagegetSkinTemplateEntry(String usage, boolean devModeChecks) Returns the TypeTemplateEntry Skin matching the given parameters.Collection<? extends TreeNode> Returns a Collection of TreeNode children of the current nodeReturns parent of the current nodegetTreeParent(TreeNode node) booleanReturns true if the portlet has an abilitybooleanhasAbility(String ability) Returns true if the portlet have the given ability Or if the ability is empty and the portlet have no abilitybooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisChildTreeNode(TreeNode child) booleanisCopy()booleanbooleanReturns boolean true if the TreeNode is a leafbooleanReturns boolean true if the TreeNode is a nodebooleanbooleanvoidsetAbilities(String[] v) abstract voidabstract voidabstract voidabstract voidabstract voidabstract voidabstract voidabstract voidsetInvalidClass(String[] v) abstract voidsetInvalidTime(long v) abstract voidabstract voidMethods inherited from class com.jalios.jcms.Publication
ackRead, addAuthorizedGroup, addAuthorizedMember, addCategory, addFollower, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, attachPublication, attachTo, canBeArchived, canBeArchived, canBeAttachedBy, canBeAttachedTo, canBeDetachedFrom, canBeEditedFieldByField, canBeFollowedBy, canBeReadBy, canBeReadBy, canBeVotedBy, canCreateCopy, canCreateCopy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, canRequestUnlock, checkAndPerformTrash, checkAndPerformUntrash, checkCreate, checkDelete, checkIntegrity, checkLang, checkMember, checkMerge, checkStateChange, checkStateChange, checkTemplateEntry, checkTrash, checkUntrash, checkUpdate, checkWrite, cleanHybridCollections, clearTransientIndex, cloneDBDataCollections, computeSignature, computeSignature, containsCategory, createCopy, createCopy, createWFNote, createWFNote, createWorkCopy, createWorkCopy, detachFrom, discardCopy, exportXmlField, exportXmlRelated, getAbstract, getAbstractAsText, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllCatIdSet, getAllFilePath, getAllWikiText, getAllWysiwygText, getAttachWorkspaceSet, getAttachWSIdSet, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthenticatedReaderCount, getAuthGrpIdSet, getAuthMbrIdSet, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedMemberSet, getAuthorizedMemberSetDBID, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getCatIdSet, getClassificationLevel, getComparator, getComparator, getComparator, getCSVHeader, getCurrentWorkerSet, getDataIconTitle, getDataName, getDate, getDate, getDateSelector, getDBDataRevision, getDbFriendlyURLSet, getDdateComparator, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEffectiveClassificationLevel, getEstimatedReminderCount, getExtendedReadRights, getExternalLinkSet, getFieldInMainLanguage, getFieldValue, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFollowerList, getFriendlyURLSet, getGenericThumbnail, getHasAttachWS, getHasNoReadRights, getImportConflictCopy, getImportVersion, getIndexingDate, getInternalWorkflow, getLinkDataSet, getMainInstance, getMainInstanceId, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPopularity, getPopularityComparator, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getReadAck, getReadAckCount, getReaderComparator, getReaderCount, getReaderTracker, getReaderTrackerList, getReadRightSelector, getReadRightsString, getReferrerSet, getRestrictUpdateRights, getRightComparator, getRoleMap, getRoleMapStr, getSdate, getSdateComparator, getSdateSelector, getSearchStrings, getTemplate, getTemplateEntry, getTemplateEntry, getTemplateEntrySet, getTemplatePath, getTemplatePath, getTemplates, getTitle, getTitle, getTitle, getTitleComparator, getTitleComparator, getTitleML, getTitleMLE, getTrackedSelector, getTreeRoot, getTypeComparator, getTypeFieldLabel, getTypeLabel, getUdate, getUdateComparator, getUdateSelector, getUpdateGroupSet, getUpdateGrpIdSet, getUpdateMbrIdSet, getUpdateMemberSet, getVersionString, getVisibleStateSelector, getVoteCount, getVoteScore, getVoteScoreComparator, getVoteValue, getWeakReferrerSet, getWFNoteList, getWFState, getWFStateLabel, getWFStateLabelHtml, getWorkCopySet, getWorkflow, getWorkflowId, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadAckBy, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, importXml, init, initCopy, initializeDBDataCollections, internalCanBeReadBy, invalidateWeakDataImage, isAudienced, isClassified, isDefaultTemplate, isFollowedBy, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isTrashed, isUserContent, isUserContentType, isVersioned, isWorkCopy, majorUpdate, notifyFollowers, performAfterWrite, performBeforeWrite, performCreate, performDelete, performMerge, performMerge, performTrash, performUntrash, performUpdate, prepareMergeCopy, putPstatusAlarmEntry, recomputeScore, removeAllDescendants, removeAllFollowers, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeFollower, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAbstract, setAbstract, setAdate, setAllCatIdSet, setAttachWorkspaceSet, setAttachWSIdSet, setAuthGrpIdSet, setAuthMbrIdSet, setAuthorizedGroupSet, setAuthorizedMemberSet, setAuthorizedMemberSetDBID, setCategories, setCategorySet, setCatIdSet, setCdate, setClassificationLevel, setDbFriendlyURLSet, setEdate, setExtendedReadRights, setFieldValue, setFriendlyURLSet, setHasAttachWS, setHasNoReadRights, setImportConflictCopy, setImportVersion, setMainInstance, setMainInstanceId, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setMinorVersion, setPdate, setPstatus, setReadAck, setReaderCount, setRestrictUpdateRights, setRoleMap, setRoleMapStr, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTitleMLE, setTracked, setUdate, setUpdateGroupSet, setUpdateGrpIdSet, setUpdateMbrIdSet, setUpdateMemberSet, setVoteCount, setVoteScore, setWorkflow, setWorkflowId, setWorkspace, setWorkspaceId, splitHybridCollections, supportsClassification, toCSV, toFullString, toString, trackReader, trackReader, unassignMember, unassignRole, updateDisplayLinkCss, updateDisplayLinkDataAttribute, updatePstatus, updateTemplateMethods inherited from class com.jalios.jcms.Data
canBeReadBy, canBeUnlockedBy, checkAndPerformCreate, checkAndPerformCreate, checkAndPerformDelete, checkAndPerformDelete, checkAndPerformUpdate, checkAndPerformUpdate, checkCreate, checkDelete, checkIntegrity, checkLockMember, checkStrongLockMember, checkStrongLockMember, checkUpdate, cleanHybridCollection, cleanHybridCollection, cleanHybridCollection, clone, computeDBIDArray, computeDBIDList, computeDBIDSet, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllRelatedData, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataIconAlt, getDataIconCSS, getDataIconHtml, getDataIconHtml, getDataImage, getDataImage, getDataImage, getDataNameComparator, getDefaultFieldStatus, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayLinkCss, getDisplayLinkDataAttribute, getDisplayLinkHtmlAttributes, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, 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, getOpAuthorId, getOpDelegate, getReadAuthorizedSelector, getReferrerSet, getRowId, getRowIdComparator, getStrongLock, getStrongLockContext, getStrongLockContextData, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, mergeHybridLink, performCreate, performDelete, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, putStrongLock, releaseStrongLock, releaseStrongLock, removeAllRelatedData, removeAllRelatedData, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpAuthorId, setOpDelegate, setRowId, unlock, unlock, unmarkNewImport, updateDisplayLinkHtmlAttributes, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSetMethods inherited from class com.jalios.jstore.BasicStorable
clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, hashCode, isStored, resetInternalCaches, resolveAtt, resolveVal, setAttributes, setAttributes, setDdate, setId, setStore, toXmlMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.jalios.util.TreeNode
getId, getTreeRoot
-
Field Details
-
tteDefault
-
abilities
-
cachedAbilities
-
ICON_PORTLET
- See Also:
-
ICON_STATS
- See Also:
-
-
Constructor Details
-
PortalElement
public PortalElement() -
PortalElement
-
PortalElement
-
-
Method Details
-
getContentTitle
-
getAbstract
Description copied from class:PublicationReturns the abstract of this publication in the channel's main language.- Overrides:
getAbstractin classPublication- Returns:
- the abstract of this publication in the channel's main language.
-
getAbstract
Description copied from class:PublicationReturns the abstract of this publication.- Overrides:
getAbstractin classPublication- Parameters:
lang- the user language (ISO-639 language code)useDefault- should the default language be used- Returns:
- the abstract of this publication.
-
getDescriptionML
-
getDescription
-
getDescription
-
setDescription
-
setDescriptionML
-
getPortletImageML
-
getPortletImage
-
getPortletImage
-
setPortletImage
-
setPortletImageML
-
getPreview
Retrieve the preview image of this Portlet in the specified context and dimensions.Current implementation is as follow :
If the portlet image of this portlet has been defined, it is used as the source image for the preview. Otherwise the preview of the template being use for the specified context is used.Then, the thumbnail tag is used to create the image in the appropriate dimension, from this source, if the source image file could no be found, the default image specified in parameters is used.
Warning : This method create a thumbnail when it does not exists, this process can be a little time consumming, make sure you do not need immediate response time when using it, as it might slow down your jsp access time (on first call only).
- Parameters:
ctxt- the current JcmsJspContextwidth- target max width (if a value of 0 or less is specified, 200 will be used)height- target max height (if a value of 0 or less is specified, 150 will be used)defaultImagePath- the default image to use if thumbnail do not exists- Returns:
- a path relative to the webapp root (e.g. "types/PortletRSS/th-60x45-doPortletRSSFullDisplay.jpg.jpg").
-
getCssId
-
setCssId
-
getCssClasses
-
setCssClasses
-
getDefaultTemplateUsage
Returns the default template usage used to display the publication. This default tempalte may change between Content and Portlets- Overrides:
getDefaultTemplateUsagein classPublication- Returns:
- String the default usage
- See Also:
-
getSkinPath
Returns the template skin path for the given usage- Parameters:
usage- the template usagedevModeChecks- perform developement checks on template- Returns:
- String the path of the template used
-
getSkinPath
Returns the template skin path for the given usage- Parameters:
ctxt- the JcmsJspContext- Returns:
- String the path of the template used
-
getSkinTemplateEntry
Returns the TypeTemplateEntry Skin matching the given parameters. It returns a default template if the given one does work.- Parameters:
usage- the template usagedevModeChecks- perform developement checks on template- Returns:
- TypeTemplateEntry the matching templates
-
getCacheType
-
setCacheType
-
getCacheSensibility
-
setCacheSensibility
-
getInvalidClass
-
setInvalidClass
-
getInvalidTime
public abstract long getInvalidTime() -
setInvalidTime
public abstract void setInvalidTime(long v) -
getResolvedInvalidClass
-
hasNoCacheSensibility
public boolean hasNoCacheSensibility() -
hasPortalCategoryCacheSensibility
public boolean hasPortalCategoryCacheSensibility() -
hasCurrentCategoryCacheSensibility
public boolean hasCurrentCategoryCacheSensibility() -
getCacheTypeInt
public int getCacheTypeInt() -
hasNoCache
public boolean hasNoCache() -
hasCacheSession
public boolean hasCacheSession() -
hasCacheServer
public boolean hasCacheServer() -
hasCacheGroups
public boolean hasCacheGroups() -
hasCacheMembers
public boolean hasCacheMembers() -
hasCacheSessionAndVisitors
public boolean hasCacheSessionAndVisitors() -
hasCacheVisitorsOnly
public boolean hasCacheVisitorsOnly() -
getBehaviorCopy
-
setBehaviorCopy
-
isCopy
public boolean isCopy() -
isReference
public boolean isReference() -
isWorkspaceReference
public boolean isWorkspaceReference() -
duplicate
Duplicate a PortalElement using one of its default constructor, and create it in the store. If an exception append then return null.- Parameters:
author- the Member to be used for store operation (create).- Returns:
- a newly created PortalElement instance, duplicate of this
- Since:
- jcms-4.0
-
duplicate
Duplicates a PortalElement and add a Prefix to the title.- Parameters:
prefix- the title prefixauthor- the Member to be used for store operation (create).- Returns:
- a newly created PortalElement instance, duplicate of this
- Since:
- jcms-4.0
-
duplicate
Performs a deep duplicate.- Parameters:
prefix- the title prefixauthor- the Member to be used for store operation (create).deep- boolean indicating if it is a deep copy- Returns:
- a newly created PortalElement instance, duplicate of this
- Since:
- jcms-4.0
-
duplicate
@Deprecated public PortalElement duplicate(String prefix, Member author, boolean deep, Workspace wkspc, Map catMap, Map groupMap) Deprecated.Used insteadduplicate(WizardContext, boolean)Performs a deep duplicate.- Parameters:
prefix- the title prefixauthor- the author who perform the actiondeep- boolean indicate if it is a deep copywkspc- the workspace to setcatMap- the binding map of old/new categoriesgroupMap- the binding map of old/new groups- Returns:
- a newly created PortalElement instance, duplicate of this
- Since:
- jcms-4.1
-
duplicate
Performs a deep duplicate.- Parameters:
context- WizardContext describe the dupliate contextdeep- boolean indicating if it is a deep copy- Returns:
- a newly created PortalElement instance, duplicate of this
- Since:
- jcms-5.7.3
-
duplicateDeep
@Deprecated protected void duplicateDeep(PortalElement parent, String prefix, Member author, Workspace wkspc, Map catMap, Map groupMap) Deprecated.Used insteadduplicateDeep(WizardContext, PortalElement)Performs a deep duplicate of the PortalElement in a WizardContext. Update prefix, workspace, category, groups, ...- Parameters:
parent- the duplicated parent (Not already created in JCMS)prefix- the title prefixauthor- the author who perform the actionwkspc- the workspace to setcatMap- the binding map of old/new categoriesgroupMap- the binding map of old/new groups- Since:
- jcms-4.1
-
duplicateDeep
Performs a deep duplicate of the PortalElement in a WizardContext. Update prefix, workspace, category, groups, ...- Parameters:
context- WizardContext describe the dupliate contextparent- PortalElement parent of portlets to deeply duplicate- Since:
- jcms-5.7.3
-
getAbilities
-
getAbilities
-
getAbilities
-
setAbilities
-
hasAbility
Returns true if the portlet have the given ability Or if the ability is empty and the portlet have no ability- Parameters:
ability- Strign representing the ability- Returns:
- boolean true if the portlet has the ability
-
addAbility
Add the given ability to this portal abilities- Parameters:
ability- the ability to be added.- Since:
- jcms-7.0
-
hasAbility
public boolean hasAbility()Returns true if the portlet has an ability- Returns:
- boolean true if the portlet has an ability
-
getAllAbilityMap
Deprecated.Returns a Map (key1/key2) of all available abilities declared.This method uses a cached Map of abilities.
Return a map like this one :
{ "portlet.ability.virtualdesktop" : { "service" : "PortletSkinable" }, "portlet.ability.internal" : { "analytics" : "AbstractPortletAnalytics AbstractPortletAnalytics" }, "portlet.ability.jcmsplugin" : { "foobar" : "Portlet" "collaborativespace.application" : "Portlet" "collaborativespace.dashboard" : "Portlet" } }- Returns:
- Map of abilities
-
getAllAbilityMapUI
Deprecated.Retrieve all abilities in map easy to use for User Interface listing of abilities.Help fix bug JCMS-2653 - Bad optgroup label in ability list.
The map computed by
getAllAbilityMap()matches a complex structure not suitable for presentation purpose.In order to properly and easily list abilities without losing backward compatibility, this method converts the map returned by
getAllAbilityMap()into a simpler representation like this one :{ "portlet.ability.virtualdesktop" : [ "service" ], "portlet.ability.internal" : [ "stat" ], "portlet.ability.jcmsplugin" : [ "foobar" ], "portlet.ability.jcmsplugin.collaborativespace" : [ "application", "dashboard" ] }The key match a "parent ability" suitable for use in a optgroup label.
The values match the suffix to add to the key in order to get a full and valid ability.- Returns:
- a Map
- Since:
- jcms-7.0.3 jcms-7.1
-
getAllAbilities
Deprecated.Returns an Array of all available abilities declared for the given class. This methode use cached abilities.- Returns:
- String[] an array of abilities
-
getAllAbilities
Deprecated.Returns an Array of all available abilities declared for the given class- Parameters:
clazz- the class used to filter abilities- Returns:
- String[] an array of abilities
-
getAbilityLabel
Deprecated.Returns the label of a given ability- Parameters:
userLang- the user languageability- the ability- Returns:
- String the I18N ability
-
getDataIcon
Description copied from class:DataReturns 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:
getDataIconin classPublication- Returns:
- a relative path (eg
images/jalios/icon/abstract.gif) or sprite classes name (egss_sprite ss_date). - See Also:
- Either by specifying a relative image path :
-
getIcon
-
getTreeChildren
Description copied from interface:TreeNodeReturns a Collection of TreeNode children of the current node- Specified by:
getTreeChildrenin interfaceTreeNode- Overrides:
getTreeChildrenin classPublication- Returns:
- Collection of TreeNode
- See Also:
-
isTreeLeaf
public boolean isTreeLeaf()Description copied from interface:TreeNodeReturns boolean true if the TreeNode is a leaf- Specified by:
isTreeLeafin interfaceTreeNode- Overrides:
isTreeLeafin classPublication- Returns:
- boolean indicating if node is leaf or node
- See Also:
-
isTreeNode
public boolean isTreeNode()Description copied from interface:TreeNodeReturns boolean true if the TreeNode is a node- Specified by:
isTreeNodein interfaceTreeNode- Overrides:
isTreeNodein classPublication- Returns:
- boolean indicating if node is leaf or node
- See Also:
-
getTreeParent
Description copied from interface:TreeNodeReturns parent of the current node- Specified by:
getTreeParentin interfaceTreeNode- Overrides:
getTreeParentin classPublication- Returns:
- TreeNode parent Node
- See Also:
-
getTreeParent
-
isChildTreeNode
-
getAllTreeChildren
Retrieve a new collection containing all PortalElement children of this PortalElement- Returns:
- a new Collection of PortalElement.
-
containsTreeDescendant
Same as getAllTreeChildren() but stop when there is a match. This method can be use to detect cycles- Parameters:
tn- the treenode- Returns:
- true if there is a match
-
getAbilitySelector
Retrieves a new instance ofPortalElement.AbilitySelectorusing the specified abilityString.- Parameters:
ability- an ability choosen from values returned bygetAllAbilities(), or"noabilities"for portlet without any ability, or"hasabilities"for portlet with any ability.- Returns:
- a new instance of
PortalElement.AbilitySelectorusing the given abilityString. - Since:
- jcms-5.7.1
-
isVotable
public boolean isVotable()- Overrides:
isVotablein classPublication- Returns:
- true if this Publication is votable
-
duplicate(WizardContext, boolean)