public interface Pool extends IOObject
Pool
objects in the
Escenic system. A PoolTransaction
must be retrieved when you need to modify this
object.
A pool is a
Example:
NOTE: For various historical reasons, the Pool
is also referred to as
IOAtom.ObjectType
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
Modifier and Type | Method and Description |
---|---|
Timestamp |
getActivateDate()
Retrieves the activate date for this pool.
|
Article |
getAPIArticle(int position)
Retrieves article at position.
|
Article[] |
getAPIArticles()
Retrieves all articles in pool.
|
IORelation |
getArticleRelation(Article article)
Retrieves the relation between this pool and the specified article.
|
List |
getArticleRelations(Article article)
Retrieves the relations between this pool and the specified article.
|
IORelation[] |
getArticles()
Retrieves all relations between articles and this pool.
|
IORelation[] |
getArticles(boolean onlyLive)
Retrieves all relations between articles and this pool based on whether or not articles must be live on the web.
|
IORelation[] |
getArticles(boolean onlyLive,
Date now)
Retrieves all relations between articles and this pool based on whether or not articles must be live on the web.
|
Timestamp |
getCreationDate()
Retrieves the creation date of this pool.
|
Timestamp |
getExpireDate()
Retrieves the expire date for this pool.
|
Timestamp |
getLastModifiedDate()
Retrieves the last modified date of this pool.
|
String |
getName()
Retrieves the name of this pool.
|
neo.xredsys.PoolEntry |
getPoolEntry(int articleId)
Deprecated.
use getArticleRelation instead
|
String |
getPreviewUrl()
Creates and then returns the preview url for this pool.
|
String |
getPreviewUrl(Date when)
Creates and then returns the preview url to this section for a given pool.
|
Type |
getRuleType()
Deprecated.
not in use anymore
|
Section |
getSection()
Retrieves the section this pool belongs to.
|
int |
getSectionId()
Retrieves the id of the section this pool belongs to.
|
Type |
getType()
Retrieves the type of this pool.
|
int |
getVariantId()
Get the id of the variant of this pool if any.
|
boolean |
hasVariant()
This will return true if the Pool has a published or staged variant.
|
boolean |
isActivePool()
This will return true if the Pool is the current active pool.
|
boolean |
isPreviewPool()
Checks whether or not this is a preview pool.
|
breakAndLock, createTransaction, getChecksum, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomain, getProtectionDomains, isLocked, isPreview, isValid, lock, lock, lock, lock, refresh
boolean isActivePool()
int getVariantId()
boolean hasVariant()
Section getSection() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getSectionId() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIORelation[] getArticles() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIORelation
IORelation[] getArticles(boolean onlyLive) throws PersistentStoreException, NoSuchObjectException
true
. All relations are retrieved if this parameter has value false
.onlyLive
- true if only live relations should be retrieved; false otherwisePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIORelation
IORelation[] getArticles(boolean onlyLive, Date now) throws PersistentStoreException, NoSuchObjectException
true
. All relations are retrieved if this parameter has value false
.onlyLive
- true if only live relations should be retrieved; false otherwisenow
- if not null, current time will be set to given time when retrieving live articlesPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIORelation
Article[] getAPIArticles() throws PersistentStoreException, NoSuchObjectException
getArticles()
.PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existArticle
Article getAPIArticle(int position) throws PersistentStoreException, NoSuchObjectException
getArticles()
.position
- the position to retrieve the article byPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType getType() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType
Type getRuleType() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp getCreationDate() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp
Timestamp getLastModifiedDate() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp
Timestamp getActivateDate() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp getExpireDate() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp
neo.xredsys.PoolEntry getPoolEntry(int articleId) throws PersistentStoreException, NoSuchObjectException
IORelation getArticleRelation(Article article) throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existList getArticleRelations(Article article) throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existboolean isPreviewPool()
String getName()
String getPreviewUrl() throws PersistentStoreException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getPreviewUrl(Date when) throws PersistentStoreException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not exist© 1998- 2021 Escenic AS