Escenic Content Engine 5.3.10.154952 API documentation

neo.xredsys.api
Interface Article

All Superinterfaces:
IOAtom, IOObject
All Known Subinterfaces:
ArticleTransaction
All Known Implementing Classes:
ArticleImpl, ArticleTransactionImpl

public interface Article
extends IOObject

The Article interface represents read-only Article objects in the Escenic system. Articles are the most common objects that is handled by the Escenic clients. Most of the content that is presented in the WEB Publication, is in fact articles. The versatility of the system is based on how articles are handled and the flexibility built into them. Therefore an article is a complex object that contain many details:

It is possible to define several different article types to represent different types of content. For example, a movie-review type, a news-report type, a product-data type, an image-gallery type and so on. For each type you can define the data fields that the article of that type should contain. For example the movie-review type could contain a field for move title, director, producer, review and so on. These properties are defined in articleTypes.xml.

See Also:
ArticleTransaction, Type

Nested Class Summary
 
Nested classes/interfaces inherited from interface neo.xredsys.api.IOAtom
IOAtom.ObjectType
 
Field Summary
static String DEFAULT_RELATION_TYPE
          Default relation type.
static int HIDDEN_ARTICLE_PRIORITY
          Priority for hidden articles.
static String INLINE_RELATION_TYPE
          Relation type for inline relations.
static int MAIN_IN_TOPIC_PRIORITY
          Priority for articles that are main articles in one or more topics.
 
Fields inherited from interface neo.xredsys.api.IOAtom
ID_INVALID, OBJECTTYPE_AGREEMENTINFO, OBJECTTYPE_ARTICLE, OBJECTTYPE_CATALOG, OBJECTTYPE_CATEGORY, OBJECTTYPE_ENTITY, OBJECTTYPE_FORUM, OBJECTTYPE_LAYOUT, OBJECTTYPE_MAX, OBJECTTYPE_MIN, OBJECTTYPE_PERSON, OBJECTTYPE_POOL, OBJECTTYPE_POSTING, OBJECTTYPE_PRESENTATION_FORUM, OBJECTTYPE_PRESENTATION_POSTING, OBJECTTYPE_PRESENTATION_THREAD, OBJECTTYPE_PROFILE, OBJECTTYPE_PUBLICATION, OBJECTTYPE_SECTION, OBJECTTYPE_THREAD, OBJECTTYPE_TOPIC, OBJECTTYPE_UNKNOWN, OBJECTTYPE_USERGROUP
 
Method Summary
 Timestamp getActivateDate()
          Retrieves time when this article will be activated on the web.
 AgreementInfo getAgreementInfo()
          Retrieves the agreement that belongs to this article.
 neo.xredsys.content.type.ArticleType getArticleType()
          Retrieves the type of article.
 Person getAuthor()
          Retrieves the author of this article.
 Person[] getAuthors()
          Retrieves the authors of this article.
 Map getCategories()
          Deprecated. 
 Set getCategories(String fieldName)
          Deprecated. 
 int getContentId()
          Deprecated. not in use
 int getContentId(Type pContentType)
          Deprecated. not in use
 Map<String,List<ContentSummary>> getContentSummaries()
          Deprecated. use the getContentSummaries(String) instead. You must retrive the list of RelationTypes from the ArticleType class to find which name to use. If there are no relation types defined, the default relation type is used. This is called "relation".
 List<ContentSummary> getContentSummaries(String pRelationType)
          Returns a list of content summaries associated with the article.
 Timestamp getCreationDate()
          Retrieves the date when this article was created.
 Type getDefaultContentType()
          Retrieves the default content type for this article.
 Map<String,String> getElements()
          Deprecated. 
 String getElementText(String key)
          Deprecated. use getFieldValue(String) instead
 Timestamp getExpireDate()
          Retrieves the time when this article will expire from the web.
 FieldValue getField(String pKey)
          Returns the field value object that belongs to this key. will never be null
 Object getFieldValue(String pKey)
          Retrieve the object that belongs to this key.
 Timestamp getFirstPublished()
          Retrieves the date when this article was first published.
 Section getHomeSection()
          Retrieves the section to which this article belongs.
 int getHomeSectionId()
          Retrieves the id of the section to which this article belongs.
 Type getLanguage()
          Deprecated. not implemented
 Type getLanguage(Type pContentType)
          Deprecated. not implemented
 Person getLastEditedBy()
          Retrieves the most recent log entriy for the specified article.
 Timestamp getLastModified()
          Retrieves the date when this article was last modified.
 Layout getLayout()
          Retrieves the layout of this article.
 int getLayoutId()
          Retrieves the layout id of this article.
 Section getLocalHomeSection(int pPublicationId)
          Retrieves the article's homesection.
 Set<Section> getLocalHomeSections()
          Retrieves all the local home sections to which this article belongs.
 String getLocalUrl(int pPublicationId)
          Retrieves the local url to this article based on the given publication id.
 Collection<ArticleLog> getLogEntries()
          Retrieves all log entries belonging to the specified article.
 Type getOriginalState()
          Retrieves this article's original state.
 Person[] getPersonRoleKeepers(Type paType)
          Retrieves persons that have the given role on this article.
 Pool[] getPools()
          Retrieves all pools that this article is present in.
 String getPreviewToken()
          Generate a token to be used when preview an article.
 String getPreviewUrl()
          Retrieves the preview url of this article.
 boolean getPrinted()
          Deprecated. not in use
 int getPriority()
          Retrieves the priority of this article.
 int[] getPublicationIds()
          Retrieves the ids of all publications this article is added to.
 Timestamp getPublishDate()
          Retrieves the time when this article was last published.
 ReferenceEntity[] getReferenceEntities()
          Retrieves all ReferenceEntity objects that are related to this article.
 IORelation[] getReferredEntities()
          Deprecated. use getContentSummaries(String) instead.
 IORelation[] getReferredEntities(Type pEntityType)
          Deprecated. use getContentSummaries(String) instead.
 IORelation[] getReferredPersons()
          Retrieves all persons that are related to this article.
 Article[] getRelatedAPIArticles()
          Retrieves all related articles.
 IORelation[] getRelatedArticles()
          Deprecated. use getContentSummaries(String) instead.
 URI getRelativeURI()
          Retrieves the relative part of the url.
 String getRelativeUrl()
          Deprecated. use the {@link #getRelativeURI() instead.
 IORelation[] getRoleKeepers()
          Retrieves the role keepers of the article.
 IORelation[] getRoleKeepers(Type roleType)
          Retrieves all persons that have the given role on this article.
 Section[] getSections()
          Retrieves all sections where this article is present.
 Section[] getSections(boolean includeVirtualSections)
          Retrieves all sections where this article is present.
 String getSource()
          Retrieves this article's source.
 String getSourceId()
          Retrieves this article's source id.
 Type getState()
          Retrieves this article's state.
 Timestamp getStateChange()
          Retrieves the date when this article was last changed.
 String getStrippedElementText(String key)
          Deprecated. 
 String getTitle()
          Retrieves the default title of this articles xml content.
 Topic[] getTopics()
          Deprecated. 
 Type getType()
          Retrieves this article's type.
 String getUrl()
          Retrieves the url to this article.
 boolean inPool(Pool pool)
          Checks whether or not this article is in the given pool.
 boolean inSection(int sectionId)
          Checks whether or not this article is in the given section.
 boolean isAgreementRequired()
          Checks whether or not you need an agreement to publish this article.
 boolean isLive()
          Checks if this article is activated on the web or not.
 boolean isLive(Date pDate)
          Checks if this article is activated on the web or not.
 boolean isLogging()
          Checks whether or not a log entry will be created when this article is modified.
 ContentHandler parseField(String pKey, ContentHandler pHandler)
          Deprecated. 
 ContentSummary toContentSummary()
          Converts this content to a ContentSummary that can be used to relate other content to this content.
 
Methods inherited from interface neo.xredsys.api.IOObject
breakAndLock, copy, createTransaction, getChecksum, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomain, getTransactionObject, getValid, isLocked, isPreview, isValid, lock, lock, refresh
 

Field Detail

DEFAULT_RELATION_TYPE

static final String DEFAULT_RELATION_TYPE
Default relation type.

See Also:
Constant Field Values

INLINE_RELATION_TYPE

static final String INLINE_RELATION_TYPE
Relation type for inline relations.

See Also:
Constant Field Values

HIDDEN_ARTICLE_PRIORITY

static final int HIDDEN_ARTICLE_PRIORITY
Priority for hidden articles.

See Also:
Constant Field Values

MAIN_IN_TOPIC_PRIORITY

static final int MAIN_IN_TOPIC_PRIORITY
Priority for articles that are main articles in one or more topics.

See Also:
Constant Field Values
Method Detail

getDefaultContentType

Type getDefaultContentType()
Retrieves the default content type for this article. Typically this type will be xml.

Returns:
a Type representation of this article's default content type

getPublicationIds

int[] getPublicationIds()
                        throws PersistentStoreException
Retrieves the ids of all publications this article is added to. An article is at least added to one publication.

Returns:
array of publication ids.
Throws:
PersistentStoreException - if an error occurs in the persistence layer

getLocalHomeSection

Section getLocalHomeSection(int pPublicationId)
                            throws PersistentStoreException,
                                   NoSuchObjectException
Retrieves the article's homesection. The article may be originally published in another publication or it may be in a virtual section in the publication. Home section is found from the following algorithm: First test if the article's homesection is in publication. If not test if the article is in any section in publication (it has homesection in another publication and is "cross" published. Last test if article is in any virtual section in publication. Otherwise return null. The first section found that contains this article will be used as local home section.

Parameters:
pPublicationId - find home section in this publication
Returns:
the home section. Returns null if no home section can be found
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getHomeSection

Section getHomeSection()
                       throws PersistentStoreException,
                              NoSuchObjectException
Retrieves the section to which this article belongs. An article can be placed in several sections, but can only have one home section.

Returns:
the home section to which this article belongs
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getLocalHomeSections

Set<Section> getLocalHomeSections()
                                  throws PersistentStoreException,
                                         NoSuchObjectException
Retrieves all the local home sections to which this article belongs.

Returns:
A set of all the local home sections
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getHomeSectionId

int getHomeSectionId()
                     throws PersistentStoreException,
                            NoSuchObjectException
Retrieves the id of the section to which this article belongs. An article can be placed in several sections, but can only have one home section.

Returns:
the id of the home section to which this article belongs
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getSections

Section[] getSections()
                      throws PersistentStoreException,
                             NoSuchObjectException
Retrieves all sections where this article is present. An article can be placed in several sections, in different publications. This method should always return at least one section since it is manditory for articles to have a home section.

Returns:
an array of Sections where this article is present.
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getSections

Section[] getSections(boolean includeVirtualSections)
                      throws PersistentStoreException,
                             NoSuchObjectException
Retrieves all sections where this article is present. All virtual sections this article is added to will also be included if the param includeVirtualSections is set to true.

Parameters:
includeVirtualSections - if it set to true the virtual sections will be included; else they are skipped
Returns:
an array of Sections where this article is present.
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
VirtualSection

getTopics

@Deprecated
Topic[] getTopics()
                  throws PersistentStoreException,
                         NoSuchObjectException
Deprecated. 

Retrieves all topics that this article is added to.

Returns:
an Array of all topics that this article is added to; an empty array if it is not placed in any topics
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
Topic

getPools

Pool[] getPools()
                throws PersistentStoreException,
                       NoSuchObjectException
Retrieves all pools that this article is present in. These pools can belong to different publications.

Returns:
an array of Pool objects
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
Pool

inPool

boolean inPool(Pool pool)
               throws PersistentStoreException
Checks whether or not this article is in the given pool.

Parameters:
pool - the pool in which to search for this article
Returns:
true if operation is successful; otherwise false
Throws:
PersistentStoreException - if an error occurs in the persistence layer

getReferredEntities

@Deprecated
IORelation[] getReferredEntities()
                                 throws PersistentStoreException,
                                        NoSuchObjectException
Deprecated. use getContentSummaries(String) instead.

Retrieves all entities that are related to this article. Entities that can be related to an article is described in more detail in ReferenceEntity.

Returns:
an array of IORelation objects
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
ReferenceEntity, IORelation

getReferenceEntities

ReferenceEntity[] getReferenceEntities()
                                       throws PersistentStoreException,
                                              NoSuchObjectException
Retrieves all ReferenceEntity objects that are related to this article.

Returns:
an array of ReferenceEntity objects
Throws:
PersistentStoreException - if some database error occurs
NoSuchObjectException - if referring to an IOObject that does not exist
See Also:
ReferenceEntity

getReferredPersons

IORelation[] getReferredPersons()
                                throws PersistentStoreException,
                                       NoSuchObjectException
Retrieves all persons that are related to this article.

Returns:
an array person objects that are related to this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
Person, ReferenceEntity, IORelation

getReferredEntities

@Deprecated
IORelation[] getReferredEntities(Type pEntityType)
                                 throws PersistentStoreException,
                                        NoSuchObjectException
Deprecated. use getContentSummaries(String) instead.

Retrieves all referred entities of the specified type. Possible types can be found by calling TypeManager.getTypes(neo.xredsys.api.Type.Category).

Parameters:
pEntityType - the type of related objects to retrieve
Returns:
an array of IORelations of the given type
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getRelatedArticles

@Deprecated
IORelation[] getRelatedArticles()
                                throws PersistentStoreException,
                                       NoSuchObjectException
Deprecated. use getContentSummaries(String) instead.

Retrieves all related articles.

Returns:
all related articles as an IORelation array
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
IORelation

getRelatedAPIArticles

Article[] getRelatedAPIArticles()
                                throws PersistentStoreException,
                                       NoSuchObjectException
Retrieves all related articles.

Returns:
all related articles as an Article array
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getContentSummaries

List<ContentSummary> getContentSummaries(String pRelationType)
Returns a list of content summaries associated with the article.

Parameters:
pRelationType - the name of the types of summaries that should be returned. May not be null.
Returns:
a List of content summaries. This will never return null

getContentSummaries

@Deprecated
Map<String,List<ContentSummary>> getContentSummaries()
Deprecated. use the getContentSummaries(String) instead. You must retrive the list of RelationTypes from the ArticleType class to find which name to use. If there are no relation types defined, the default relation type is used. This is called "relation".

Returns all content summaries associated with the article.

Returns:
a Map of relation types to lists of content summaries. This will never return null

getRoleKeepers

IORelation[] getRoleKeepers()
                            throws PersistentStoreException,
                                   NoSuchObjectException
Retrieves the role keepers of the article. Possible types can be found by calling TypeManager.getTypes(neo.xredsys.api.Type.Category). Typical role keepers are:

Returns:
the authors of this article as an IORelation array
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
TypeManager

getRoleKeepers

IORelation[] getRoleKeepers(Type roleType)
                            throws PersistentStoreException,
                                   NoSuchObjectException
Retrieves all persons that have the given role on this article. See getRoleKeepers() for details on role keepers.

Parameters:
roleType - the type of role the persons to retrieve should have on this article
Returns:
all persons that have the given role on this article as an array of IORelation objects
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
TypeManager

getPersonRoleKeepers

Person[] getPersonRoleKeepers(Type paType)
                              throws PersistentStoreException,
                                     NoSuchObjectException
Retrieves persons that have the given role on this article. See getRoleKeepers() for details on role keepers.

Parameters:
paType - the role persons must have on this article
Returns:
an array of Person objects
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
TypeManager

getLayout

Layout getLayout()
                 throws PersistentStoreException,
                        NoSuchObjectException
Retrieves the layout of this article.

Returns:
the layout of the article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
Layout

getLayoutId

int getLayoutId()
                throws PersistentStoreException,
                       NoSuchObjectException
Retrieves the layout id of this article.

Returns:
the layout id of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
Layout

getType

Type getType()
             throws PersistentStoreException,
                    NoSuchObjectException
Retrieves this article's type. See Article documentation for details on article types.

Returns:
a Type representation of this article's type
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getStateChange

Timestamp getStateChange()
                         throws PersistentStoreException,
                                NoSuchObjectException
Retrieves the date when this article was last changed.

Returns:
a Timestamp representation of the time when this article last had it's state changed
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getPriority

int getPriority()
                throws PersistentStoreException,
                       NoSuchObjectException
Retrieves the priority of this article. Article priorities are typically used to distinguish special articles. Possible values can be found in this Article interface. For example:

Returns:
the priority of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getPrinted

@Deprecated
boolean getPrinted()
                   throws PersistentStoreException,
                          NoSuchObjectException
Deprecated. not in use

Checks whether or not this article is printed.

Returns:
true if this article is printed;otherwise false
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getActivateDate

Timestamp getActivateDate()
                          throws PersistentStoreException,
                                 NoSuchObjectException
Retrieves time when this article will be activated on the web.

Returns:
a Timestamp representation of the time when this article will be activated on the web
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getExpireDate

Timestamp getExpireDate()
                        throws PersistentStoreException,
                               NoSuchObjectException
Retrieves the time when this article will expire from the web.

Returns:
a Timestamp representation of the time when this article will expire from the web
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getPublishDate

Timestamp getPublishDate()
                         throws PersistentStoreException,
                                NoSuchObjectException
Retrieves the time when this article was last published.

Returns:
a Timestamp representation of the time when this article was last published
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getState

Type getState()
              throws PersistentStoreException,
                     NoSuchObjectException
Retrieves this article's state. Possible states can be found by calling the TypeManager.getTypes(neo.xredsys.api.Type.Category) method. Typical states are:

Returns:
the state of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist
See Also:
Type, TypeManager

getOriginalState

Type getOriginalState()
                      throws PersistentStoreException,
                             NoSuchObjectException
Retrieves this article's original state. Typically used internally in the Escenic system when setting state changed.

Returns:
the original state of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getSource

String getSource()
                 throws PersistentStoreException,
                        NoSuchObjectException
Retrieves this article's source. Source id together with source uniquely identifies a reference entity. Source is typically set on objects that are imported into the Escenic system.

Returns:
the source of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getSourceId

String getSourceId()
                   throws PersistentStoreException,
                          NoSuchObjectException
Retrieves this article's source id. Source id together with source uniquely identifies a reference entity. Source id is typically set on objects that are imported into the Escenic system.

Returns:
the source id of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getContentId

@Deprecated
int getContentId()
                 throws PersistentStoreException,
                        NoSuchObjectException
Deprecated. not in use

Retrieves the id of the default content (xml) of this article.

Returns:
the id of the default content of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getContentId

@Deprecated
int getContentId(Type pContentType)
                 throws PersistentStoreException,
                        NoSuchObjectException
Deprecated. not in use

Retrieves the id of the specified content.

Parameters:
pContentType - the type of content
Returns:
the id of the specified content
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getLanguage

@Deprecated
Type getLanguage()
                 throws PersistentStoreException,
                        NoSuchObjectException
Deprecated. not implemented

Retrieves the language of the default (xml) content.

Returns:
a Type representation of the language of the default (xml) content
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getLanguage

@Deprecated
Type getLanguage(Type pContentType)
                 throws PersistentStoreException,
                        NoSuchObjectException
Deprecated. not implemented

Retrieves the language of the specified content.

Parameters:
pContentType - the content type
Returns:
a Type representation of the language of the specified (xml) content
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getTitle

String getTitle()
                throws PersistentStoreException,
                       NoSuchObjectException
Retrieves the default title of this articles xml content.

Returns:
the default title of this articles xml content
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getLocalUrl

String getLocalUrl(int pPublicationId)
                   throws PersistentStoreException,
                          NoSuchObjectException
Retrieves the local url to this article based on the given publication id. Normally a part of the url is retrieved from this article's home section. However, if this article is cross-published it will sometimes be necessary to use the url of another section that belongs to the given publication and contains this article.

Parameters:
pPublicationId - the id of the publication to retrieve the section part of this url from
Returns:
the local url of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getUrl

String getUrl()
              throws PersistentStoreException,
                     NoSuchObjectException
Retrieves the url to this article.

Returns:
the url of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getRelativeUrl

String getRelativeUrl()
Deprecated. use the {@link #getRelativeURI() instead.

Retrieves the relative URL to this article. This url does not contain the absolute address(http://), but only the relative part : "article<articleID>.ece"

Returns:
A String containing the relative URL.

getRelativeURI

URI getRelativeURI()
Retrieves the relative part of the url. This is relative to the Home section of the Article.

The presentation layer will use this value to find the Article object in the filter chain.

Returns:
the relative URI.

getPreviewUrl

String getPreviewUrl()
                     throws PersistentStoreException,
                            NoSuchObjectException
Retrieves the preview url of this article. The difference between this method and getUrl() is the publication part of the returned url. In this case the publication part of the url will be retrieved from the "publication.previewURL" property in features.properties.

Returns:
the preview url of this article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getPreviewToken

String getPreviewToken()
Generate a token to be used when preview an article. The token will be unique for this article. The Escenic taglibraries will not display a preview article if there is no valid token.

Returns:
a token

getElements

@Deprecated
Map<String,String> getElements()
                               throws PersistentStoreException,
                                      NoSuchObjectException
Deprecated. 

Retrieves all elements belonging to this article. Elements are typically article fields like:


getElementText

@Deprecated
String getElementText(String key)
Deprecated. use getFieldValue(String) instead

Retrieves the element text belonging to the specified element key. See getElements() for details on elements.

Parameters:
key - the element key to retrieve the text by
Returns:
the element text belonging to the specified element key
See Also:
getElements()

getFieldValue

Object getFieldValue(String pKey)
Retrieve the object that belongs to this key.

Parameters:
pKey - the key to find
Returns:
the object that is mapped to this key

getField

FieldValue getField(String pKey)
Returns the field value object that belongs to this key. will never be null

Parameters:
pKey - the key to find.
Returns:

parseField

@Deprecated
ContentHandler parseField(String pKey,
                                     ContentHandler pHandler)
                          throws IOException,
                                 SAXException
Deprecated. 

This method will run a field through a sax parser with the provided ContentHandler.

Parameters:
pKey - The name of the field
pHandler - The content handler to use with the sax parser
Returns:
The same ContentHandler as provided in the argument
Throws:
IOException - if an i/o related exception occurs during parsing
SAXException - if the article field contains invalid xml

inSection

boolean inSection(int sectionId)
                  throws PersistentStoreException,
                         NoSuchObjectException
Checks whether or not this article is in the given section.

Parameters:
sectionId - the id of the section in which to search for this article
Returns:
true if this article is in the section in question; otherwise false
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getLastModified

Timestamp getLastModified()
                          throws PersistentStoreException,
                                 NoSuchObjectException
Retrieves the date when this article was last modified.

Returns:
a Timestamp representation of the date when this article was last modified.
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getCreationDate

Timestamp getCreationDate()
                          throws PersistentStoreException,
                                 NoSuchObjectException
Retrieves the date when this article was created.

Returns:
a Timestamp representation of the date when this article was created
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getFirstPublished

Timestamp getFirstPublished()
                            throws PersistentStoreException,
                                   NoSuchObjectException
Retrieves the date when this article was first published.

Returns:
the date when this article was first published
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

getAuthor

Person getAuthor()
Retrieves the author of this article.

Returns:
the author of this article. If there are several authors the first author will be returned.

getAuthors

Person[] getAuthors()
Retrieves the authors of this article.

Returns:
the authors of this article as a Person array

getArticleType

neo.xredsys.content.type.ArticleType getArticleType()
                                                    throws PersistentStoreException,
                                                           NoSuchObjectException
Retrieves the type of article. See Article for details on article types.

Returns:
the type of article
Throws:
PersistentStoreException - if an error occurs in the persistence layer
NoSuchObjectException - if trying to retrieve an object that does not exist

isLive

boolean isLive()
Checks if this article is activated on the web or not.

Returns:
true if article is activated; otherwise false

isLive

boolean isLive(Date pDate)
Checks if this article is activated on the web or not.

Parameters:
pDate - is the article live at given date?
Returns:
true if article is activated; otherwise false

isAgreementRequired

boolean isAgreementRequired()
Checks whether or not you need an agreement to publish this article.

Returns:
true if you need an agreement to publish this article;otherwise false

getAgreementInfo

AgreementInfo getAgreementInfo()
Retrieves the agreement that belongs to this article.

Returns:
the agreement that belongs to this article.
See Also:
AgreementInfo

getLogEntries

Collection<ArticleLog> getLogEntries()
                                     throws PersistentStoreException,
                                            NoSuchObjectException
Retrieves all log entries belonging to the specified article. Log entries contain information on the modifications made on this article.

Returns:
a Collection of ArticleLog objects
Throws:
PersistentStoreException - if some database error occurs
NoSuchObjectException - if referring to an object that does not exist
See Also:
ArticleLog

getLastEditedBy

Person getLastEditedBy()
                       throws PersistentStoreException,
                              NoSuchObjectException
Retrieves the most recent log entriy for the specified article. Log entries contain information on the modifications made on this article.

Returns:
a Collection of ArticleLog objects
Throws:
PersistentStoreException - if some database error occurs
NoSuchObjectException - if referring to an object that does not exist
See Also:
ArticleLog

getCategories

@Deprecated
Map getCategories()
Deprecated. 

Retrieves all categories that are related to this article.

Returns:
a map containing fieldnames that map to a List of category ids represented as Integers; returns an empty map if no categories are registered

getCategories

@Deprecated
Set getCategories(String fieldName)
Deprecated. 

Retrieves all categories that are related to this article and the given field.

Parameters:
fieldName - the field to retrieve categories from
Returns:
a Set of category ids represented as Integers

getStrippedElementText

@Deprecated
String getStrippedElementText(String key)
Deprecated. 

Retrieves the element text belonging to the specified element key. See getElements() for details on elements.The text will be stripped for all tags before returned.

Parameters:
key - the element key to retrieve the text by
Returns:
the stripped element text belonging to the specified element key
See Also:
getElements()

isLogging

boolean isLogging()
Checks whether or not a log entry will be created when this article is modified. Default value is true.

Returns:
true if a log entry will be created; otherwise false

toContentSummary

ContentSummary toContentSummary()
Converts this content to a ContentSummary that can be used to relate other content to this content.

Returns:
an empty content summary for this content.
Throws:
IllegalStateException - if this content doesn't have a valid id or getArticleType() returns null.
See Also:
getContentSummaries(String), ArticleTransaction.setContentSummaries(String, List), ArticleTransaction.addContentSummary(String, ContentSummary)

Escenic Content Engine 5.3.10.154952 API documentation

© 1998- 2014 Escenic
Contact Escenic Support for bug submission or feature requests. For further API reference and developer documentation, see Technet. The Technet documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Escenic A/S, Sommerrogt. 13-15 Solli, 0255 Oslo, Norway.