Interface IPagePoolElement
- All Known Subinterfaces:
IPagePool
public interface IPagePoolElement
Page Pool Entry interface
- Author:
- I-D Media AG
-
Method Summary
Modifier and TypeMethodDescription@Nullable DateGet the date this element is dueGet the date this element was inserted into the database@Nullable DateGet the date of the last updateGet the target language@NotNull StringGet element's display name (if avialable)Get the element id which represents this element in the CMSGet the target element id which represents this element in the CMSintGet Job Count Value of respective entity@NotNull EElementTypeGet the element typeGet the element uid which represents this element in the CMSGet the target element uid which represents this element in the CMSlonggetId()Get the id identifying this element in the databaselonggetJobId()Get the id of the job this element is inlongGet the owner idGet the owner uid (e.g.longGet the CMS Project id@NotNull StringGet Project and or Stack@NotNull StringGet Request UidGet the source languageGet the store type of this element (pagestore, global content store)Get the TMS project guid associated with this ElementGet transaction idGet the transfer stategetUser()Get id of user who initiated the translation of this element@NotNull StringOptional parameter.intWord count@org.jetbrains.annotations.NotNull longGet Id of Workflow to be executed on importbooleanis this a fragment projectbooleanKeep non-translatable elements in the XML instead of removing thembooleanOnly translate untranslated text if possible
-
Method Details
-
getTmsProject
String getTmsProject()Get the TMS project guid associated with this Element- Returns:
- guid
-
getId
long getId()Get the id identifying this element in the database- Returns:
- id or -1
-
getElementId
String getElementId()Get the element id which represents this element in the CMS- Returns:
- id
-
getElementUid
String getElementUid()Get the element uid which represents this element in the CMS- Returns:
- uid
-
getElementUidTarget
String getElementUidTarget()Get the target element uid which represents this element in the CMS- Returns:
- uid
-
getElementIdTarget
String getElementIdTarget()Get the target element id which represents this element in the CMS- Returns:
- uid
-
getStoreType
EStoreType getStoreType()Get the store type of this element (pagestore, global content store)- Returns:
-
getProjectId
long getProjectId()Get the CMS Project id- Returns:
- id
-
getProjectStackId
Get Project and or Stack- Returns:
-
getOwnerUid
String getOwnerUid()Get the owner uid (e.g. page uid for a given section)- Returns:
- uid
-
getUser
String getUser()Get id of user who initiated the translation of this element- Returns:
- user id
-
getDateInsert
Date getDateInsert()Get the date this element was inserted into the database- Returns:
- date
-
getJobId
long getJobId()Get the id of the job this element is in- Returns:
- id or 0 if not in any job yet.
-
getSrcLang
String getSrcLang()Get the source language- Returns:
- language abbreviation
-
getDestLang
String getDestLang()Get the target language- Returns:
- language abbreviation
-
getTransferState
ETransferState getTransferState()Get the transfer state- Returns:
- state
-
getOwnerId
long getOwnerId()Get the owner id- Returns:
- id or 0 on error
-
getElementType
Get the element type- Returns:
- element type
-
getDateOfLastUpdate
Get the date of the last update- Returns:
-
getDateDue
Get the date this element is due- Returns:
- Date
-
getTransactionId
String getTransactionId()Get transaction id- Returns:
- id
-
getWorkflowId
@NotNull @org.jetbrains.annotations.NotNull long getWorkflowId()Get Id of Workflow to be executed on import- Returns:
- id or 0/-1 if not set
-
getWordCount
int getWordCount()Word count- Returns:
-
getElementJobCount
int getElementJobCount()Get Job Count Value of respective entity- Returns:
-
keepNontranslatable
boolean keepNontranslatable()Keep non-translatable elements in the XML instead of removing them- Returns:
-
isFragmentProject
boolean isFragmentProject()is this a fragment project- Returns:
-
getRequestUid
Get Request Uid- Returns:
-
getDisplayName
Get element's display name (if avialable)- Returns:
-
getVersion
Optional parameter. The version number describing the given element in the cms.- Returns:
-
translateDeltaOnly
boolean translateDeltaOnly()Only translate untranslated text if possible- Returns:
-