public interface PresentationArticle extends PresentationObject, CacheObject, Serializable
PresentationArticle
provides a high performance, read-only
interface to Escenic content items - the basic components of an Escenic publication.
Modifier and Type | Field and Description |
---|---|
static String |
COM_ESCENIC_PRESENTATION_INTERNAL |
Modifier and Type | Method and Description |
---|---|
String |
getActivatedDate()
Returns the date this content item was activated.
|
String |
getActivatedDate(Locale pLocale)
Returns a formatted String of the activation date.
|
String |
getActivatedDate(String pFormat)
Returns a formatted String of the activation date.
|
String |
getActivatedDate(String pFormat,
Locale pLocale)
Returns a formatted String of the activation date.
|
Date |
getActivatedDateAsDate()
Returns the date this content item was activated.
|
AgreementInfo |
getAgreementInfo()
Returns this content item's agreement information or
null if the content item has no agreement. |
int |
getArticleId()
Returns the database id of this content item.
|
List |
getArticles()
Deprecated.
use
getRelatedElements() instead. |
List |
getArticles(Set pArticleTypes)
Deprecated.
use
getRelatedElements() instead. |
int |
getArticlesCount()
Deprecated.
use
getRelatedElements() instead. |
int |
getArticlesCount(Set pArticleTypes)
Deprecated.
use
getRelatedElements() instead. |
String |
getArticleTypeName()
Returns the type of this content item (as defined in the
content-type resource). |
Person |
getAuthor()
Returns the author of this content item.
|
List |
getAuthors()
Returns all the authors of this content item.
|
int |
getAuthorsCount()
Returns the number of authors responsible for this content item.
|
String |
getCreatedDate()
Returns the date this content item was created.
|
String |
getCreatedDate(Locale pLocale)
Returns a formatted String of the activation date.
|
String |
getCreatedDate(String pFormat)
Returns a formatted String of the creation date.
|
String |
getCreatedDate(String pFormat,
Locale pLocale)
Returns a formatted String of the creation date.
|
Date |
getCreatedDateAsDate()
Returns the date this content item was created.
|
String |
getExpireDate()
Returns the date on which this content item expired/will expire.
|
String |
getExpireDate(Locale pLocale)
Returns a formatted date of when this content item is due to expire.
|
String |
getExpireDate(String pFormat)
Returns a formatted date of when this content item is due to expire
The date will be formatted using the specified format using the server's locale.
|
String |
getExpireDate(String pFormat,
Locale pLocale)
Returns a formatted date of when this content item is due to expire.
|
Date |
getExpireDateAsDate()
Returns the date on which this content item expired/will expire.
|
String |
getFieldElement(String pKey)
Deprecated.
use
getFields() instead |
String |
getFieldElementDefaultValue(String pKey)
Deprecated.
no replacement
|
List<String> |
getFieldNames()
Returns the names of all this content item's fields.
|
Map<String,PresentationProperty<?>> |
getFields()
Returns all the fields in this content item.
|
String |
getFirstPublishedDate()
Returns the date on which this content item was first published.
|
String |
getFirstPublishedDate(Locale pLocale)
Returns a formatted date of when this content item was first published
The date will be formatted using
DateFormat.SHORT and the supplied locale. |
String |
getFirstPublishedDate(String pFormat)
Returns a formatted date of when this content item was first published
The date will be formatted using the specified format using the server's locale.
|
String |
getFirstPublishedDate(String pFormat,
Locale pLocale)
Returns a formatted date of when this content item was first published
The date will be formatted using the supplied format and locale.
|
Date |
getFirstPublishedDateAsDate()
Returns the date on which this content item was first published.
|
Section |
getHomeSection()
Returns the home section of this content item.
|
Map<String,PresentationElement> |
getInlineElements()
Returns a
Map of all inline elements for this content item. |
String |
getLastModifiedDate()
Returns the date on which this content item was last modified.
|
String |
getLastModifiedDate(Locale pLocale)
Returns a formatted date of when this content item was last modified
The date will be formatted using
DateFormat.SHORT and the supplied locale. |
String |
getLastModifiedDate(String pFormat)
Returns a formatted date of when this content item was last modified.
|
String |
getLastModifiedDate(String pFormat,
Locale pLocale)
Returns a formatted date of when this content item was last modified.
|
Date |
getLastModifiedDateAsDate()
Returns the date on which this content item was last modified.
|
Section |
getOwnerHomeSection()
Returns the owner home section of this content item.
|
String |
getOwnerUrl()
Returns the absolute URL of this content item in its owning home section.
|
Collection |
getPersons()
Deprecated.
use
getRelatedElements() instead. |
int |
getPersonsCount()
Deprecated.
use
getRelatedElements() instead. |
String |
getPreviewToken()
Returns the preview token
|
int |
getPriority()
Deprecated.
No replacement. Should not be used by clients.
|
List<PresentationPerson> |
getProfilePersons()
Returns a list of all the persons related to this content item where the relation type is profile.
|
Publication |
getPublication()
Returns the publication this content item belongs to.
|
int |
getPublicationId()
Returns the database id of the publication this content item belongs to.
|
String |
getPublishedDate()
Returns the date on which this content item was last published.
|
String |
getPublishedDate(Locale pLocale)
Returns a formatted date of when this content item was last published
The date will be formatted using
DateFormat.SHORT and the supplied locale. |
String |
getPublishedDate(String pFormat)
Returns a formatted date of when this content item was last published
The date will be formatted using the specified format using the server's locale.
|
String |
getPublishedDate(String pFormat,
Locale pLocale)
Returns a formatted date of when this content item was last published
The date will be formatted using the supplied format and locale.
|
Date |
getPublishedDateAsDate()
Returns the date on which this content item was last published.
|
Map<String,PresentationElement> |
getRelatedElements()
Returns a Map from relation type to a
PresentationElement that holds the relations to this object. |
Set<PresentationElement> |
getRelatedElements(Set<String> pContentTypes)
Returns a Set of related PresentationElements of the given content types.
|
URI |
getRelativeURI()
Returns the URL of this content item relative to its section.
|
String |
getRelativeUrl()
Deprecated.
use the
getRelativeURI() instead. |
Section[] |
getSections()
Deprecated.
Replaced by getSectionsList(). Should not be used.
|
List |
getSectionsList()
Returns the sections this content item belongs to.
|
String |
getSource()
Returns the name of the external source of an imported content item.
|
String |
getSourceId()
Returns the id of the external source of an imported content item.
|
String |
getStateChangedDate()
Returns the date on which the state of this content item last changed.
|
String |
getStateChangedDate(Locale pLocale)
Returns a formatted date of when this content item's state was updated
The date will be formatted using
DateFormat.SHORT and the supplied locale. |
String |
getStateChangedDate(String pFormat)
Returns a formatted date of when this content item's state was updated
The date will be formatted using the specified format using the server's locale.
|
String |
getStateChangedDate(String pFormat,
Locale pLocale)
Returns a formatted date of when this content item's state was updated
The date will be formatted using the supplied format and locale.
|
Date |
getStateChangedDateAsDate()
Returns the date on which the state of this content item last changed.
|
String |
getStateName()
Returns the state of this content item.
|
List<PresentationTag> |
getTags()
Returns a List of presentation tags.
|
String |
getTitle()
Returns the title of this content item.
|
String |
getUrl()
Returns the absolute URL of this content item.
|
boolean |
inSection(int pSectionId)
Check to see if the content item is in the given section.
|
boolean |
inSection(Section pSection)
Check to see if the content item is in the given section.
|
boolean |
isAgreementRequired()
Returns
true if an agreement is required to view this content item,
otherwise false . |
boolean |
isLive()
Returns
true if this content item is published and active and its home section is published,
otherwise false . |
boolean |
isOwner()
Returns
true if this content item is in its owning publication, false if
it is a cross-published content item that is being accessed from a foreign publication. |
boolean |
isPreview()
Checks whether the presentation article is a preview or not
returns true if the presentation article is a preview
|
getHashKey, getId
getId
static final String COM_ESCENIC_PRESENTATION_INTERNAL
Date getActivatedDateAsDate()
String getActivatedDate()
DateFormat.SHORT
).String getActivatedDate(String pFormat)
getActivatedDate()
instead.pFormat
- how the date will be formated. The parameter is defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.String getActivatedDate(Locale pLocale)
DateFormat.SHORT
and the supplied locale.
This property is not accessible from JSTL. Use the getActivatedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.String getActivatedDate(String pFormat, Locale pLocale)
getActivatedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.pFormat
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.Date getCreatedDateAsDate()
String getCreatedDate()
DateFormat.SHORT
).String getCreatedDate(String pFormat)
getCreatedDate()
instead.pFormat
- how the date will be formatted. The parameter is defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.String getCreatedDate(Locale pLocale)
DateFormat.SHORT
and the supplied locale.
This property is not accessible from JSTL. Use the getCreatedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.String getCreatedDate(String pFormat, Locale pLocale)
getCreatedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.pFormat
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.Date getExpireDateAsDate()
String getExpireDate()
DateFormat.SHORT
).String getExpireDate(String pFormat)
getExpireDate()
instead.pFormat
- how the date will be formatted. The parameter is defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.String getExpireDate(Locale pLocale)
DateFormat.SHORT
and the supplied locale.
This property is not accessible from JSTL. Use the getExpireDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.String getExpireDate(String pFormat, Locale pLocale)
getCreatedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.pFormat
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.Date getFirstPublishedDateAsDate()
String getFirstPublishedDate()
DateFormat.SHORT
).String getFirstPublishedDate(String pFormat)
getFirstPublishedDate()
instead.pFormat
- how the date will be formatted. The parameter is defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.String getFirstPublishedDate(Locale pLocale)
DateFormat.SHORT
and the supplied locale.
This property is not accessible from JSTL. Use the getFirstPublishedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.String getFirstPublishedDate(String pFormat, Locale pLocale)
getFirstPublishedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.pFormat
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.Date getLastModifiedDateAsDate()
String getLastModifiedDate()
DateFormat.SHORT
).String getLastModifiedDate(String pFormat)
getLastModifiedDate()
instead.pFormat
- how the date will be formatted. The parameter is defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.String getLastModifiedDate(Locale pLocale)
DateFormat.SHORT
and the supplied locale.
This property is not accessible from JSTL. Use the getLastModifiedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.String getLastModifiedDate(String pFormat, Locale pLocale)
getLastModifiedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.pFormat
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.Date getPublishedDateAsDate()
getPublishedDate()
String getPublishedDate()
DateFormat.SHORT
).
The first time a content item is published, this property is set automatically. Subsequently, the property is never automatically updated - its value only changes if it is explicitly modified.
String getPublishedDate(String pFormat)
getPublishedDate()
instead.pFormat
- how the date will be formatted. The parameter is defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.String getPublishedDate(Locale pLocale)
DateFormat.SHORT
and the supplied locale.
This property is not accessible from JSTL. Use the getPublishedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.String getPublishedDate(String pFormat, Locale pLocale)
getPublishedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.pFormat
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.Date getStateChangedDateAsDate()
String getStateChangedDate()
DateFormat.SHORT
).String getStateChangedDate(String pFormat)
getStateChangedDate()
instead.pFormat
- how the date will be formatted. The parameter is defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.String getStateChangedDate(Locale pLocale)
DateFormat.SHORT
and the supplied locale.
This property is not accessible from JSTL. Use the getStateChangedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.String getStateChangedDate(String pFormat, Locale pLocale)
getStateChangedDate()
instead.pLocale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.pFormat
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.int getArticleId()
String getArticleTypeName()
content-type
resource).Person getAuthor()
List<PresentationPerson> getProfilePersons()
List getAuthors()
List
of neo.xredsys.api.Person
.int getAuthorsCount()
Section getHomeSection()
Section
sectionSection getOwnerHomeSection()
@Deprecated int getPriority()
Publication getPublication()
int getPublicationId()
String getRelativeUrl()
getRelativeURI()
instead.article123.ece
.URI getRelativeURI()
article123.ece
.@Deprecated Section[] getSections()
Section
this content item belongs to.List getSectionsList()
String getSource()
source
together with
getSourceId()
uniquely identifies the original source of the content item.String getSourceId()
sourceId
together with
getSource()
uniquely identifies the original source of the content item.String getTitle()
String getUrl()
String getOwnerUrl()
getUrl()
, which returns the content item's URL in its current section.
For a cross-published content item both the section and publication components of the URL will
differ.boolean isAgreementRequired()
true
if an agreement is required to view this content item,
otherwise false
.true
if this content item need an agreement, false
if not.boolean isLive()
true
if this content item is published and active and its home section is published,
otherwise false
.AgreementInfo getAgreementInfo()
null
if the content item has no agreement.boolean inSection(int pSectionId)
pSectionId
- The sectionId to the section we will check.true
if the content item is in the section, false
otherwise.boolean inSection(Section pSection)
pSection
- The section to check.true
if the content item is in the section, false
otherwise.@Deprecated String getFieldElement(String pKey)
getFields()
insteadpKey
- The text field to get.List<String> getFieldNames()
content-types.xml
, and
in upper case letters.Map<String,PresentationProperty<?>> getFields()
Object
s representing the fields depends upon field type as follows:
Field type | Java Object |
---|---|
BASIC | String |
NUMBER | a subclass of Number |
COMPLEX | Map |
BOOLEAN | Boolean |
ENUMERATION | a String or List of Strings |
URI | URI |
LINK | Link |
DATE | Date |
SCHEDULE | PresentationSchedule |
String getFieldElementDefaultValue(String pKey)
pKey
- The text field to get default value from.@Deprecated Collection getPersons()
getRelatedElements()
instead.persons
related to this content item@Deprecated int getPersonsCount()
getRelatedElements()
instead.@Deprecated List getArticles()
getRelatedElements()
instead.neo.xredsys.presentation.PresentationRelationArticle
@Deprecated List getArticles(Set pArticleTypes)
getRelatedElements()
instead.pArticleTypes
- this is a Set
of the named content item types.neo.xredsys.presentation.PresentationRelationArticle
@Deprecated int getArticlesCount()
getRelatedElements()
instead.@Deprecated int getArticlesCount(Set pArticleTypes)
getRelatedElements()
instead.pArticleTypes
- this is a Set of named content item types to get the count from.Map<String,PresentationElement> getRelatedElements()
PresentationElement
that holds the relations to this object.PresentationElement
that holds the relations to this object.Set<PresentationElement> getRelatedElements(Set<String> pContentTypes)
pContentTypes
- the content types to search forMap<String,PresentationElement> getInlineElements()
Map
of all inline elements for this content item. The key of this map represents the ID of the inline
element.Map
of all inline elements for this content item.String getStateName()
List<PresentationTag> getTags()
boolean isOwner()
true
if this content item is in its owning publication, false
if
it is a cross-published content item that is being accessed from a foreign publication.true
if the current content item is the owner, false
if not.String getPreviewToken()
boolean isPreview()
true
if the current content item is preview, false
if not.© 1998- 2018 Stibo DX