com.jalios.jcms.portlet
Class Portal

java.lang.Object
  extended by com.jalios.jstore.BasicStorable
      extended by com.jalios.jcms.Data
          extended by com.jalios.jcms.Publication
              extended by com.jalios.jcms.portlet.PortalElement
                  extended by com.jalios.jcms.portlet.Portal
All Implemented Interfaces:
EditableData, JcmsConstants, ImportConstants, MashupConstants, Parent, PortalInterface, Searchable, Storable, JaliosConstants, TreeNode, Cloneable, 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.PstatusComparator<T extends Publication>, Publication.PstatusSelector, Publication.RatingComparator<T extends Publication>, Publication.ReaderComparator<T extends Publication>, Publication.ReadRightSelector, Publication.ReviewCountComparator<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.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>
 
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
static String ICON_PORTAL
           
static String ICON_PORTAL_GENERIC
           
static String REVISION
           
 
Fields inherited from class com.jalios.jcms.portlet.PortalElement
abilities, allAbilities, allAbilityMap, cachedAbilities, ICON_PORTLET, ICON_STATS, tteDefault
 
Fields inherited from class com.jalios.jcms.Publication
adate, authorizedGroupSet, authorizedMemberSet, categories, categorySet, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_WORKFLOW, edate, friendlyURLSet, indexMgr, isTracked, mainInstance, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, roleMap, sdate, templates, title, titleML, udate, updateGroupSet, updateMemberSet, wfExpressAlarmEntry, wfReminderAlarmEntry, workspace
 
Fields inherited from class com.jalios.jcms.Data
author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, lockDate, lockMember, 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, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, 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, 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_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, 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, 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
Portal()
           
Portal(Portal other)
           
 
Method Summary
 ControllerStatus checkDelete(Member mbr, 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  String getCssFile()
           
abstract  boolean getExactCategory()
           
 String getIcon()
           
abstract  String getPageTitle(String lang)
           
abstract  String getPageTitle(String lang, boolean b)
           
abstract  HashMap getPageTitleML()
           
 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(String s)
           
abstract  void setExactCategory(boolean exactCategory)
           
abstract  void setPageTitle(String s)
           
abstract  void setPageTitleML(HashMap s)
           
 
Methods inherited from class com.jalios.jcms.portlet.PortalElement
containsTreeDescendant, duplicate, duplicate, duplicate, duplicate, duplicate, duplicateDeep, getAbilities, getAbilities, getAbilities, getAbilityLabel, getAbilitySelector, getAbstract, getAbstract, getAllAbilities, getAllAbilities, getAllAbilityMap, getAllTreeChildren, getBehaviorCopy, getCacheSensibility, getCacheType, getCacheTypeInt, getContentTitle, getCssClasses, getCssId, 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, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, canBeArchived, canBeArchived, canBeEditedFieldByField, canBeReadBy, canBeReadBy, canBeReadBy, canCreateCopy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, checkCreate, checkIntegrity, checkLang, checkMember, checkMerge, checkStateChange, checkTemplateEntry, checkUpdate, checkWrite, clearTransientIndex, computeSignature, containsCategory, createCopy, createWFNote, createWorkCopy, exportXmlField, getAbstract, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllFilePath, getAllWikiText, getAllWysiwygText, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getComparator, getComparator, getComparator, getCSVHeader, getDataName, getDate, getDate, getDateSelector, getDdateComparator, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEstimatedReminderCount, getExternalLinkSet, getFieldInMainLanguage, getFieldValue, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFriendlyURLSet, getGlobalRating, getImportConflictCopy, getImportVersion, getIndexingDate, getLinkDataSet, getMainInstance, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getRatingComparator, getReaderComparator, getReaderCount, getReaderTrackerList, getReadRightSelector, getReadRightsString, getReview, getReviewCount, getReviewCountComparator, getReviewList, getReviewList, getRightComparator, getRoleMap, 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, getWeakReferrerSet, getWFNoteList, getWFState, getWFStateLabel, getWorkCopySet, getWorkflow, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasReview, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, importXml, init, initCopy, isAudienced, isDefaultTemplate, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isUserContent, isUserContentType, isWorkCopy, majorUpdate, performCreate, performDelete, performMerge, performMerge, prepareMergeCopy, putPstatusAlarmEntry, removeAllDescendants, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAdate, setAuthorizedGroupSet, setAuthorizedMemberSet, setCategories, setCategorySet, setCdate, setEdate, setFriendlyURLSet, setImportConflictCopy, setImportVersion, setMainInstance, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setPdate, setPstatus, setRoleMap, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTracked, setUdate, setUpdateGroupSet, setUpdateMemberSet, setWorkspace, setWorkspaceId, toCSV, toFullString, toString, trackReader, unassignMember, unassignRole, updatePstatus, updateTemplate
 
Methods inherited from class com.jalios.jcms.Data
checkCreate, checkDelete, checkIntegrity, checkLock, checkUpdate, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCdateSelector, getDataImage, getDataImage, getDataImage, getDataNameComparator, getDeletableSelector, getDisplayUrl, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockMember, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, hashCode, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, lock, markNewImport, mergeHybridLink, performAfterWrite, performBeforeWrite, performCreate, performDelete, performUpdate, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraInfo, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, 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, 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 String REVISION
See Also:
Constant Field Values

ICON_PORTAL

public static final String ICON_PORTAL
See Also:
Constant Field Values

ICON_PORTAL_GENERIC

public static final String ICON_PORTAL_GENERIC
See Also:
Constant Field Values
Constructor Detail

Portal

public Portal()

Portal

public Portal(Portal other)
Method Detail

getPageTitleML

public abstract HashMap getPageTitleML()

getPageTitle

public abstract String getPageTitle(String lang)

getPageTitle

public abstract String getPageTitle(String lang,
                                    boolean b)

setPageTitle

public abstract void setPageTitle(String s)

setPageTitleML

public abstract void setPageTitleML(HashMap s)

getExactCategory

public abstract boolean getExactCategory()
Specified by:
getExactCategory in interface PortalInterface

setExactCategory

public abstract void setExactCategory(boolean exactCategory)

getCssFile

public abstract String getCssFile()

setCssFile

public abstract void setCssFile(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 String getIcon()
Specified by:
getIcon in interface PortalInterface
Overrides:
getIcon in class PortalElement

getTreeChildren

public 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,
                                    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


Copyright © 2001-2007 Jalios SA. All Rights Reserved.