Interface PageRef
- All Superinterfaces:
Comparable<StoreElement>
,ContentProducer
,HistoryProvider
,IDProvider
,PackagePoolItem
,Previewable
,Referenceable
,StartNode
,StoreElement
,Workflowable
public interface PageRef
extends StartNode, Referenceable, Previewable, ContentProducer, PackagePoolItem
This interface provides methods to handle the pagereferences in the SiteStore
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider
HistoryProvider.RevisionProvider
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IDProvider.UidType
Uid type as returned bygetUidType()
.Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider
CHANGED, NEVER_RELEASED, RELEASED
Fields inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem
BLOCKED, MODIFIED, UNMODIFIED
Fields inherited from interface de.espirit.firstspirit.access.store.Previewable
PARAM_REVISION, PREVIEWMODE_DEFAULT, PREVIEWMODE_DEFAULT_REFRESH, PREVIEWMODE_FORCE_REFRESH, PREVIEWMODE_FULL_QUALIFIED, PREVIEWMODE_NONE, PREVIEWMODE_SSO, PREVIEWMODE_WEBEDIT, PREVIEWMODE_WEBEDIT_FULL_QUALIFIED, PREVIEWMODE_WITHOUT_CONTEXTNAME
-
Method Summary
Modifier and TypeMethodDescription@Nullable Content2Params
@NotNull String
Returns a filename suggestions which may be used for creating urls.@NotNull String
getName()
Deprecated.@Nullable Page
getPage()
Get the page from Page-Store of the current pagereference as object@Nullable PageGroup
Get the page-group of the current pagereference as objectint
Get the position-number of the current pagereference in the pagegrouplong
Returns the id of the referencedPage
.getPageLangSpec
(Language language) Get the pagereference specification for the given languageReturns the page refs parent folder.@NotNull String
getUid()
Get the unique referenec name of the pagereference.@NotNull IDProvider.UidType
ReturnUID_TYPE
.void
save()
Saves the node and all childs, shortcut forsave(null, true)
.void
setFilename
(String filename) Set a filename suggestions which may be used for creating urls.void
Set the page of the pagereferencevoid
setPageGroup
(PageGroup group) Set the page-group of the pagereferenceMethods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface de.espirit.firstspirit.access.store.ContentProducer
createContent, getExtension, getMultiPageParams, getStoredUrl, getUrl
Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider
asRevisionProvider, getHistory, getHistory
Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseRevision, getReleaseStatus, getReleaseStatus, getRevision, hasMeta, hasUid, isInReleaseStore, isInReleaseStore, isReleased, isReleased, isReleaseSupported, moveChild, moveChild, release, release, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid
Methods inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
Methods inherited from interface de.espirit.firstspirit.access.store.Previewable
getPreviewUrl, getPreviewUrlObject
Methods inherited from interface de.espirit.firstspirit.access.store.Referenceable
getReferenceName
Methods inherited from interface de.espirit.firstspirit.access.store.sitestore.StartNode
isStartNode
Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferences, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml
Methods inherited from interface de.espirit.firstspirit.access.Workflowable
getColor, getTask, hasTask, removeTask, setColor, setTask
-
Field Details
-
UID_TYPE
Uid type as returned bygetUidType()
.- Since:
- 4.0.24
-
-
Method Details
-
getName
Deprecated.since 4.1.10 - usegetUid()
- Specified by:
getName
in interfaceStoreElement
- Since:
- 3.0
-
getPageId
long getPageId()Returns the id of the referencedPage
. -
getPage
Get the page from Page-Store of the current pagereference as object- Returns:
- page of the reference
- Since:
- 3.0
-
setPage
Set the page of the pagereference- Parameters:
page
- new page of the pagereference- Since:
- 3.0
-
getPageGroupPosition
int getPageGroupPosition()Get the position-number of the current pagereference in the pagegroup- Returns:
- position-number of the pagereference in the pagegroup
- Since:
- 3.0
-
getPageGroup
Get the page-group of the current pagereference as object- Returns:
- page-group of the pagereference
- Since:
- 3.0
-
setPageGroup
Set the page-group of the pagereference- Parameters:
group
- new page-group of the pagereference- Since:
- 3.0
-
getPageLangSpec
Get the pagereference specification for the given language- Returns:
- specification of the pagereference as object
- Since:
- 3.0
-
getContent2Params
- Returns:
- The content parameters.
- Since:
- 3.1.158
-
getUidType
ReturnUID_TYPE
.- Specified by:
getUidType
in interfaceIDProvider
- Returns:
- the unique identifier
- Since:
- 4.0.24
- See Also:
-
getUid
Get the unique referenec name of the pagereference.To use in a CMS_REF statement, the identifier must be prefixed with "pageref:".
- Specified by:
getUid
in interfaceIDProvider
- Returns:
- uniquedescription the reference name
- Since:
- 4.0
- See Also:
-
getFilename
@ApiDoc(comment="A filename suggestions which may be used for creating urls", since="3.0") @NotNull @NotNull String getFilename()Returns a filename suggestions which may be used for creating urls.- Specified by:
getFilename
in interfaceContentProducer
- Returns:
- a filename suggestion
- Since:
- 3.0
- See Also:
-
setFilename
Set a filename suggestions which may be used for creating urls.- Since:
- 3.0
- See Also:
-
getParentFolder
SiteStoreFolder getParentFolder()Returns the page refs parent folder.- Returns:
- The page refs parent folder.
- Since:
- 3.0
-
save
void save()Saves the node and all childs, shortcut forsave(null, true)
.Use
StoreElement.isLockSupported()
to check if save operation is supported.- Specified by:
save
in interfaceStoreElement
- Throws:
DuplicateReferenceNameException
- if a page ref with thisgetUid()
already exists on the server- Since:
- 3.0
- See Also:
-
getUid()