com.jalios.jcms.portlet

Class Portal

java.lang.Object

com.jalios.jstore.BasicStorable

com.jalios.jcms.Data

com.jalios.jcms.Publication

com.jalios.jcms.portlet.PortalElement

com.jalios.jcms.portlet.Portal

All Implemented Interfaces:

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

public abstract class Portal
extends PortalElement
implements Parent, PortalInterface

An abstract Portal representation with fields to implements - String -> CSSFile - String -> Header - String -> Footer - Publication -> Child

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.portlet.PortalElement

PortalElement.AbilitySelector

Nested 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.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.WorkspaceSelector

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
static java.lang.String	ICON_PORTAL
static java.lang.String	ICON_PORTAL_GENERIC
static java.lang.String	REVISION

Fields inherited from class com.jalios.jcms.portlet.PortalElement

abilities, allAbilities, allAbilityMap, allAbilityMapUI, cachedAbilities, ICON_PORTLET, ICON_STATS, tteDefault

Fields inherited from class com.jalios.jcms.Publication

adate, allCatIdSet, authGrpIdSet, authGrpIdSetDirty, authGrpIdSetInit, authMbrIdSet, authMbrIdSetDirty, authMbrIdSetInit, authorizedGroupSet, authorizedMemberSet, categories, categorySet, catIdSet, catIdSetDirty, catIdSetInit, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_WORKFLOW, edate, friendlyURLSet, hasNoReadRightsDBData, indexMgr, isTracked, mainInstance, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, PUBLICATION_WFNOTE, readerCount, roleMap, sdate, templates, title, titleML, udate, updateGroupSet, updateMemberSet, voteCount, voteScore, wfExpressAlarmEntry, wfReminderAlarmEntry, workflowId, 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, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, 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, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, 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, 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_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_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
Portal()
Portal(Portal other)

Method Summary

Methods

Modifier and Type	Method and Description
ControllerStatus	checkDelete(Member mbr, java.util.Map context) Checks if the deletion can be performed
protected void	duplicateDeep(WizardContext context, PortalElement parent) Performs a deep duplicate of the PortalElement in a WizardContext.
abstract java.lang.String	getCssFile()
abstract boolean	getExactCategory()
java.lang.String	getIcon()
abstract java.lang.String	getPageTitle(java.lang.String lang)
abstract java.lang.String	getPageTitle(java.lang.String lang, boolean b)
abstract java.util.HashMap	getPageTitleML()
java.util.Collection	getTreeChildren() Returns a Collection of TreeNode children of the current node
boolean	isDefaultPortal() Check if this portal is the default portal
abstract void	setCssFile(java.lang.String s)
abstract void	setExactCategory(boolean exactCategory)
abstract void	setPageTitle(java.lang.String s)
abstract void	setPageTitleML(java.util.HashMap s)

Methods inherited from class com.jalios.jcms.portlet.PortalElement

addAbility, containsTreeDescendant, duplicate, duplicate, duplicate, duplicate, duplicate, duplicateDeep, getAbilities, getAbilities, getAbilities, getAbilityLabel, getAbilitySelector, getAbstract, getAbstract, getAllAbilities, getAllAbilities, getAllAbilityMap, getAllAbilityMapUI, getAllTreeChildren, getBehaviorCopy, getCacheSensibility, getCacheType, getCacheTypeInt, getContentTitle, getCssClasses, getCssId, getDataIcon, getDefaultTemplateUsage, getDescription, getDescription, getDescriptionML, getInvalidClass, getInvalidTime, getPortletImage, getPortletImage, getPortletImageML, getPreview, getResolvedInvalidClass, getSkinPath, getSkinPath, getSkinTemplateEntry, getTreeParent, getTreeParent, hasAbility, hasAbility, hasCacheGroups, hasCacheMembers, hasCacheServer, hasCacheSession, hasCacheSessionAndVisitors, hasCacheVisitorsOnly, hasCurrentCategoryCacheSensibility, hasNoCache, hasNoCacheSensibility, hasPortalCategoryCacheSensibility, isChildTreeNode, isCopy, isReference, isTreeLeaf, isTreeNode, isWorkspaceReference, performUpdate, setAbilities, setBehaviorCopy, setCacheSensibility, setCacheType, setCssClasses, setCssId, setDescription, setDescriptionML, setInvalidClass, setInvalidTime, setPortletImage, setPortletImageML

Methods inherited from class com.jalios.jcms.Publication

addAuthorizedGroup, addAuthorizedMember, addCategory, addFollower, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, canBeArchived, canBeArchived, canBeEditedFieldByField, canBeFollowedBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeVotedBy, canCreateCopy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, canRequestUnlock, checkCreate, checkIntegrity, checkLang, checkMember, checkMerge, checkStateChange, checkStateChange, checkTemplateEntry, checkUpdate, checkWrite, clearTransientIndex, cloneDBDataCollections, computeSignature, computeSignature, containsCategory, createCopy, createWFNote, createWFNote, createWorkCopy, discardCopy, exportXmlField, getAbstract, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllCatIdSet, getAllFilePath, getAllWikiText, getAllWysiwygText, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthGrpIdSet, getAuthMbrIdSet, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getCatIdSet, getComparator, getComparator, getComparator, getCSVHeader, getDataIconTitle, getDataName, getDate, getDate, getDateSelector, getDBDataRevision, getDdateComparator, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEstimatedReminderCount, getExternalLinkSet, getFieldInMainLanguage, getFieldValue, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFollowerList, getFriendlyURLSet, getHasNoReadRights, getImportConflictCopy, getImportVersion, getIndexingDate, getInternalWorkflow, getLinkDataSet, getMainInstance, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPopularity, getPopularityComparator, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getReaderComparator, getReaderCount, getReaderTrackerList, getReadRightSelector, getReadRightsString, getRightComparator, getRoleMap, getRoleMapStr, getSdate, getSdateComparator, getSdateSelector, getSearchStrings, getTemplate, getTemplateEntry, getTemplateEntry, getTemplateEntrySet, getTemplatePath, getTemplatePath, getTemplates, getTitle, getTitle, getTitle, getTitleComparator, getTitleComparator, getTitleML, getTrackedSelector, getTreeRoot, getTypeComparator, getTypeLabel, getUdate, getUdateComparator, getUdateSelector, getUpdateGroupSet, getUpdateMemberSet, getVersionString, getVisibleStateSelector, getVoteCount, getVoteScore, getVoteScoreComparator, getVoteValue, getWeakReferrerSet, getWFNoteList, getWFState, getWFStateLabel, getWFStateLabelHtml, getWorkCopySet, getWorkflow, getWorkflowId, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, importXml, init, initCopy, initializeDBDataCollections, internalCanBeReadBy, isAudienced, isDefaultTemplate, isFollowedBy, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isUserContent, isUserContentType, isVersioned, isVotable, isWorkCopy, majorUpdate, notifyFollowers, performAfterWrite, performBeforeWrite, performCreate, performDelete, performMerge, performMerge, prepareMergeCopy, putPstatusAlarmEntry, recomputeScore, removeAllDescendants, removeAllFollowers, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeFollower, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAbstract, setAbstract, setAdate, setAllCatIdSet, setAuthGrpIdSet, setAuthMbrIdSet, setAuthorizedGroupSet, setAuthorizedMemberSet, setCategories, setCategorySet, setCatIdSet, setCdate, setEdate, setFieldValue, setFriendlyURLSet, setHasNoReadRights, setImportConflictCopy, setImportVersion, setMainInstance, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setMinorVersion, setPdate, setPstatus, setReaderCount, setRoleMap, setRoleMapStr, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTracked, setUdate, setUpdateGroupSet, setUpdateMemberSet, setVoteCount, setVoteScore, setWorkflow, setWorkflowId, setWorkspace, setWorkspaceId, toCSV, toFullString, toString, trackReader, trackReader, unassignMember, unassignRole, updatePstatus, updateTemplate

Methods inherited from class com.jalios.jcms.Data

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, getDataIconHtml, getDataIconHtml, getDataImage, 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, 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, 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, setId, setStore, toXml

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jalios.jcms.portlet.Parent

getChild, setChild

Methods inherited from interface com.jalios.jcms.portlet.PortalInterface

getAllTreeChildren, getCategorySet, getDescription, getId, getTitle, getTreeParent, getTreeParent, getWorkspace

Methods inherited from interface com.jalios.util.TreeNode

getTreeRoot

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

ICON_PORTAL

public static final java.lang.String ICON_PORTAL

See Also:

Constant Field Values

ICON_PORTAL_GENERIC

public static final java.lang.String ICON_PORTAL_GENERIC

See Also:

Constant Field Values

Constructor Detail

Portal

public Portal()

Portal

public Portal(Portal other)

Method Detail

getPageTitleML

public abstract java.util.HashMap getPageTitleML()

getPageTitle

public abstract java.lang.String getPageTitle(java.lang.String lang)

getPageTitle

public abstract java.lang.String getPageTitle(java.lang.String lang,
                            boolean b)

setPageTitle

public abstract void setPageTitle(java.lang.String s)

setPageTitleML

public abstract void setPageTitleML(java.util.HashMap s)

getExactCategory

public abstract boolean getExactCategory()

Specified by:

getExactCategory in interface PortalInterface

setExactCategory

public abstract void setExactCategory(boolean exactCategory)

getCssFile

public abstract java.lang.String getCssFile()

setCssFile

public abstract void setCssFile(java.lang.String s)

duplicateDeep

protected void duplicateDeep(WizardContext context,
                 PortalElement parent)

Description copied from class: PortalElement

Performs a deep duplicate of the PortalElement in a WizardContext. Update prefix, workspace, category, groups, ...

Overrides:

duplicateDeep in class PortalElement

Parameters:

context - WizardContext describe the dupliate context

parent - PortalElement parent of portlets to deeply duplicate

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in interface PortalInterface

Overrides:

getIcon in class PortalElement

getTreeChildren

public java.util.Collection getTreeChildren()

Description copied from interface: TreeNode

Returns a Collection of TreeNode children of the current node

Specified by:

getTreeChildren in interface PortalInterface

Specified by:

getTreeChildren in interface TreeNode

Overrides:

getTreeChildren in class PortalElement

Returns:

Collection of TreeNode

See Also:

TreeNode.getTreeChildren()

isDefaultPortal

public boolean isDefaultPortal()

Check if this portal is the default portal

Since:

jcms-5.0.0

checkDelete

public ControllerStatus checkDelete(Member mbr,
                           java.util.Map context)

Checks if the deletion can be performed

Overrides:

checkDelete in class Publication

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

Returns:

a ControllerStatus

Since:

jcms-5.0.0